Znalostní bázeCentrum zkoušek
CSČeština
Vybrat jazyk13

CKTIS / Python

Zrušení úlohy asyncio a získání jejího názvu

Požádejte o zrušení, počkejte na dokončení úlohy a vypište její název i to, zda byla skutečně zrušena.

Verze: Python 3.12

Syntaxe

task.cancel(msg=None) -> bool
task.cancelled() -> bool
task.get_name() -> str

V Pythonu 3.12 metoda asyncio.Task.cancel požádá o zrušení úlohy. task.cancel() vrátí True, pokud podá požadavek, nebo False, pokud už úloha skončila. True zrušení nepotvrzuje: na rozdíl od asyncio.Future.cancel() u nedokončeného objektu Future toto volání nepřepne objekt okamžitě do zrušeného stavu. Volitelný parametr msg byl přidán v Pythonu 3.9; od verze 3.11 se zpráva předává kódu, který na zrušenou úlohu čeká.

Při nejbližší příležitosti smyčka událostí vyvolá uvnitř korutiny výjimku asyncio.CancelledError. Úklid proveďte v bloku finally. Pokud výjimku zachytíte uvnitř úlohy, po úklidu ji zpravidla znovu vyvolejte. Dědí z BaseException, takže ji except Exception nezachytí. Potlačení výjimky může úloze umožnit pokračovat a narušit fungování asyncio.TaskGroup nebo asyncio.timeout().

Po podání požadavku počkejte pomocí await task, až úloha skončí. Pokud skončila zrušením, await vyvolá asyncio.CancelledError a task.cancelled() vrátí True. Samotný požadavek k tomu, aby task.cancelled() vrátilo True, nestačí.

Pro výpis zjistěte název úlohy pomocí task.get_name(), které ho vrací jako str. Název můžete zadat pomocí asyncio.create_task(..., name=...); bez výslovně zadaného názvu vygeneruje standardní implementace Task výchozí název. get_name() je dostupné od Pythonu 3.8.

Příklady

import asyncio


async def worker(started, release):
    try:
        started.set()
        await release.wait()
    finally:
        print("cleanup")


async def main():
    started = asyncio.Event()
    release = asyncio.Event()
    task = asyncio.create_task(worker(started, release), name="worker")
    await started.wait()

    requested = task.cancel()
    print(f"requested={requested}, cancelled={task.cancelled()}")
    try:
        await task
    except asyncio.CancelledError:
        print(f"{task.get_name()}: cancelled={task.cancelled()}")


if __name__ == "__main__":
    asyncio.run(main())

Výsledek

requested=True, cancelled=False
cleanup
worker: cancelled=True

Událost `started` zajišťuje, že úloha vstoupila do bloku `try` před podáním požadavku na zrušení. Název `worker` se vypíše až po provedení bloku `finally`.

Související lekce

  • Python · Lekce 30 · Pokročilá · Verze: 5

Zdroje