Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / Python

Annuler une tâche asyncio et récupérer son nom

Demandez l’annulation, attendez la fin de la tâche, puis indiquez son nom et si elle a effectivement été annulée.

Version : Python 3.12

Syntaxe

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

En Python 3.12, asyncio.Task.cancel demande l’annulation d’une tâche. task.cancel() renvoie True si la demande est faite et False si la tâche est déjà terminée. True ne confirme pas l’annulation : contrairement à asyncio.Future.cancel() sur un objet Future encore en attente, cet appel ne fait pas passer immédiatement l’objet à l’état annulé. Le paramètre facultatif msg a été ajouté en Python 3.9 ; depuis la version 3.11, le message est transmis au code qui attend la tâche annulée.

Dès que possible, la boucle d’événements lève asyncio.CancelledError dans la coroutine. Effectuez le nettoyage dans finally. Si vous interceptez l’exception dans la tâche, relancez-la en principe après le nettoyage. Elle hérite de BaseException, donc except Exception ne l’intercepte pas. La supprimer peut laisser la tâche continuer et perturber asyncio.TaskGroup ou asyncio.timeout().

Après la demande d’annulation, utilisez await task pour attendre la fin de la tâche. Si elle s’est terminée par annulation, await lève asyncio.CancelledError et task.cancelled() renvoie True. La demande seule ne suffit pas pour que task.cancelled() renvoie True.

Pour le compte rendu, récupérez le nom de la tâche sous forme de str avec task.get_name(). Vous pouvez le définir avec asyncio.create_task(..., name=...) ; sans nom explicite, l’implémentation standard de Task génère un nom par défaut. get_name() est disponible depuis Python 3.8.

Exemples

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

Résultat

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

L’événement `started` garantit que la tâche est entrée dans son bloc `try` avant la demande d’annulation. Le compte rendu affiche le nom `worker` seulement après l’exécution de `finally`.

Leçons associées

  • Python · Leçon 30 · Avancé · Version : 5

Sources