Base di conoscenzaCentro esami
ITItaliano
Scegli la lingua13

CKTIS / Python

Annullare un task asyncio e recuperarne il nome

Richiedi l’annullamento, attendi il completamento del task e indica il suo nome e se è stato effettivamente annullato.

Versione: Python 3.12

Sintassi

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

In Python 3.12, asyncio.Task.cancel richiede l’annullamento di un task. task.cancel() restituisce True se inoltra la richiesta e False se il task è già terminato. True non conferma l’annullamento: a differenza di asyncio.Future.cancel() su un oggetto Future ancora in sospeso, questa chiamata non imposta subito lo stato dell’oggetto su annullato. Il parametro facoltativo msg è stato aggiunto in Python 3.9; dalla versione 3.11 il messaggio viene passato al codice in attesa del task annullato.

Alla prima occasione utile, il ciclo degli eventi solleva asyncio.CancelledError nella coroutine. Esegui le operazioni di pulizia in finally. Se intercetti l’eccezione all’interno del task, di norma rilanciala dopo la pulizia. Deriva da BaseException, quindi except Exception non la intercetta. Sopprimerla può consentire al task di continuare e interferire con asyncio.TaskGroup o asyncio.timeout().

Dopo aver richiesto l’annullamento, usa await task per attendere che il task termini. Se termina per annullamento, await solleva asyncio.CancelledError e task.cancelled() restituisce True. La sola richiesta non basta perché task.cancelled() restituisca True.

Per il resoconto, usa task.get_name() per recuperare il nome del task come str. Puoi assegnarlo con asyncio.create_task(..., name=...); in assenza di un nome esplicito, l’implementazione standard di Task ne genera uno predefinito. get_name() è disponibile da Python 3.8.

Esempi

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

Risultato

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

L’evento `started` garantisce che il task sia entrato nel blocco `try` prima della richiesta di annullamento. Il resoconto stampa il nome `worker` solo dopo l’esecuzione di `finally`.

Lezioni correlate

  • Python · Lezione 30 · Avanzato · Versione: 5

Fonti