WissensdatenbankPrüfungszentrum
DEDeutsch
Sprache wählen13

CKTIS / Python

Den Task-Namen mit `asyncio.Task.get_name()` lesen

`get_name()` liefert den aktuellen Namen eines asyncio-Tasks als Zeichenkette. Verwende ihn als Bezeichnung im Bericht und prüfe getrennt mit `cancelled()`, ob der Task tatsächlich abgebrochen wurde.

Version: Python 3.12

Syntax

task.get_name()  # returns str

task.get_name() ist eine synchrone Instanzmethode von asyncio.Task, die seit Python 3.8 verfügbar ist. Sie akzeptiert keine Argumente und liefert den aktuellen Namen als str. Zum Lesen ist kein await nötig: Der Name ist vor und nach Abschluss des Tasks abrufbar.

Vergib den Namen mit asyncio.create_task(coro, name=...) oder ändere ihn mit task.set_name(value). Letztere Methode wandelt den Wert in eine Zeichenkette um. Ohne expliziten Namen erzeugt die Standardimplementierung von Task beim Erstellen einen Namen. Nutze ihn als Bezeichnung zur Diagnose, nicht als eindeutige Kennung oder Statusangabe.

task.cancel() fordert einen Abbruch an, garantiert ihn aber nicht: Die Koroutine kann asyncio.CancelledError abfangen und unterdrücken. Warte für den Bericht mit await task auf den Abschluss, behandle den erwarteten asyncio.CancelledError und prüfe task.cancelled(). Die Koroutine sollte normalerweise in finally aufräumen und den Abbruch nicht unterdrücken.

Beispiele

import asyncio


async def worker(started):
    started.set()
    await asyncio.Event().wait()


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

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


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

Ergebnis

report-worker: cancelled=True

Über das Ereignis `started` wartet der Aufrufer ohne Zeitverzögerung auf den Start der Koroutine. Das zweite Ereignis wird nie gesetzt, sodass der Task bis zum Abbruch wartet. Der Bericht verbindet den expliziten Namen mit dem nach `await task` bestätigten Status.

Zugehörige Lektionen

  • Python · Lektion 30 · Fortgeschritten · Version: 5

Quellen