WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

Einen asyncio-Task abbrechen und seinen Namen abrufen

Fordere den Abbruch eines Tasks an, warte auf sein Ende und melde seinen Namen sowie den tatsächlichen Abbruchstatus.

Version: Python 3.12

Syntax

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

In Python 3.12 fordert asyncio.Task.cancel den Abbruch eines Tasks an. task.cancel() gibt True zurück, wenn die Anforderung gestellt wurde, und False, wenn der Task bereits beendet ist. True bestätigt den Abbruch nicht: Anders als asyncio.Future.cancel() bei einem noch nicht abgeschlossenen Future versetzt dieser Aufruf das Objekt nicht sofort in den Zustand „abgebrochen“. Der optionale Parameter msg kam in Python 3.9 hinzu; seit 3.11 wird die Nachricht an den Code weitergegeben, der auf den abgebrochenen Task wartet.

Bei der nächsten Gelegenheit löst die Ereignisschleife in der Koroutine asyncio.CancelledError aus. Führe Aufräumarbeiten in finally aus. Wenn du die Ausnahme im Task abfängst, löse sie nach dem Aufräumen normalerweise erneut aus. Sie erbt von BaseException, weshalb except Exception sie nicht abfängt. Wird sie unterdrückt, kann der Task weiterlaufen und die Funktion von asyncio.TaskGroup oder asyncio.timeout() beeinträchtigen.

Warte nach der Abbruchanforderung mit await task auf das Ende des Tasks. Wurde der Task durch den Abbruch beendet, löst await die Ausnahme asyncio.CancelledError aus und task.cancelled() gibt True zurück. Die Anforderung allein reicht für dieses True nicht aus.

Rufe für die Meldung mit task.get_name() den Namen des Tasks als str ab. Du kannst ihn mit asyncio.create_task(..., name=...) vergeben; ohne expliziten Namen erzeugt die Standardimplementierung von Task einen Standardnamen. get_name() gibt es seit Python 3.8.

Beispiele

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

Ergebnis

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

Das Ereignis `started` stellt sicher, dass der Task seinen `try`-Block vor der Abbruchanforderung erreicht hat. Die Meldung gibt den Namen `worker` erst aus, nachdem `finally` ausgeführt wurde.

Zugehörige Lektionen

  • Python · Lektion 30 · Fortgeschritten · Version: 5

Quellen