Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / Python

Cancelar una tarea de asyncio y obtener su nombre

Solicita la cancelación, espera a que termine la tarea e informa de su nombre y de si se canceló realmente.

Versión: Python 3.12

Sintaxis

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

En Python 3.12, asyncio.Task.cancel solicita la cancelación de una tarea. task.cancel() devuelve True si realiza la solicitud y False si la tarea ya ha terminado. True no confirma la cancelación: a diferencia de asyncio.Future.cancel() sobre un objeto Future pendiente, esta llamada no cambia de inmediato el estado del objeto a cancelado. El parámetro opcional msg se añadió en Python 3.9; desde 3.11, el mensaje se transmite al código que espera a la tarea cancelada.

En cuanto puede, el bucle de eventos lanza asyncio.CancelledError dentro de la corrutina. Haz la limpieza en finally. Si capturas la excepción dentro de la tarea, normalmente debes volver a lanzarla tras la limpieza. Hereda de BaseException, así que except Exception no la captura. Suprimirla puede permitir que la tarea siga ejecutándose e interferir con asyncio.TaskGroup o asyncio.timeout().

Tras solicitar la cancelación, usa await task para esperar a que termine la tarea. Si terminó por cancelación, await lanza asyncio.CancelledError y task.cancelled() devuelve True. La mera solicitud no basta para que task.cancelled() devuelva True.

Para el informe, usa task.get_name() para obtener el nombre de la tarea como str. Puedes asignarlo con asyncio.create_task(..., name=...); sin un nombre explícito, la implementación estándar de Task genera uno predeterminado. get_name() está disponible desde Python 3.8.

Ejemplos

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

Resultado

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

El evento `started` garantiza que la tarea haya entrado en su bloque `try` antes de solicitar la cancelación. El informe muestra el nombre `worker` solo después de que se ejecute `finally`.

Lecciones relacionadas

  • Python · Lección 30 · Avanzado · Versión: 5

Fuentes