Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / Python

Anulowanie zadania asyncio i odczyt jego nazwy

Zgłoś anulowanie zadania, poczekaj na jego zakończenie i podaj jego nazwę oraz końcowy stan anulowania.

Wersja: Python 3.12

Składnia

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

W Pythonie 3.12 asyncio.Task.cancel zgłasza żądanie anulowania zadania. task.cancel() zwraca True, jeśli zgłoszono żądanie, lub False, jeśli zadanie już się zakończyło. True nie potwierdza anulowania: w przeciwieństwie do asyncio.Future.cancel() na niezakończonym obiekcie Future to wywołanie nie ustawia od razu stanu anulowania. Opcjonalny parametr msg dodano w Pythonie 3.9; od 3.11 komunikat jest przekazywany do kodu oczekującego na anulowane zadanie.

Przy najbliższej okazji pętla zdarzeń zgłasza asyncio.CancelledError wewnątrz korutyny. Umieść zwalnianie zasobów w finally. Jeśli przechwytujesz wyjątek wewnątrz zadania, po zwolnieniu zasobów zwykle zgłoś go ponownie. Wyjątek dziedziczy po BaseException, więc except Exception go nie przechwytuje. Stłumienie wyjątku może pozwolić zadaniu działać dalej i zakłócić działanie asyncio.TaskGroup lub asyncio.timeout().

Po zgłoszeniu żądania użyj await task, aby poczekać na zakończenie zadania. Jeśli zadanie zakończyło się wskutek anulowania, await zgłosi asyncio.CancelledError, a task.cancelled() zwróci True. Samo zgłoszenie żądania nie wystarcza, by task.cancelled() zwróciło True.

Do raportu użyj task.get_name(): metoda zwraca nazwę zadania jako str. Możesz ją nadać przez asyncio.create_task(..., name=...); bez jawnej nazwy standardowa implementacja Task wygeneruje nazwę domyślną. get_name() jest dostępne od Pythona 3.8.

Przykłady

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())

Wynik

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

Zdarzenie `started` zapewnia, że zadanie weszło do bloku `try` przed zgłoszeniem anulowania. Raport wypisuje nazwę `worker` dopiero po wykonaniu bloku `finally`.

Powiązane lekcje

  • Python · Lekcja 30 · Zaawansowany · Wersja: 5

Źródła