CKTIS / Python
Cancelar uma tarefa asyncio e obter o seu nome
Pede o cancelamento, aguarda o fim da tarefa e indica o seu nome e se foi efetivamente cancelada.
Versão: Python 3.12
Sintaxe
task.cancel(msg=None) -> bool
task.cancelled() -> bool
task.get_name() -> strEm Python 3.12, asyncio.Task.cancel pede o cancelamento de uma tarefa. task.cancel() devolve True se fizer o pedido e False se a tarefa já tiver terminado. True não confirma o cancelamento: ao contrário de asyncio.Future.cancel() num objeto Future pendente, esta chamada não passa imediatamente o objeto para o estado cancelado. O parâmetro opcional msg foi introduzido no Python 3.9; desde a versão 3.11, a mensagem é transmitida ao código que aguarda a tarefa cancelada.
Assim que possível, o ciclo de eventos lança asyncio.CancelledError dentro da corrotina. Faz a limpeza em finally. Se intercetares a exceção na tarefa, normalmente deves voltar a lançá-la depois da limpeza. A exceção deriva de BaseException, pelo que except Exception não a interceta. Suprimi-la pode deixar a tarefa continuar e interferir com asyncio.TaskGroup ou asyncio.timeout().
Depois de pedires o cancelamento, usa await task para aguardar o fim da tarefa. Se a tarefa terminar por cancelamento, await lança asyncio.CancelledError e task.cancelled() devolve True. O pedido, por si só, não chega para que task.cancelled() devolva True.
Para o relatório, usa task.get_name() para obter o nome da tarefa como str. Podes atribuí-lo com asyncio.create_task(..., name=...); sem um nome explícito, a implementação padrão de Task gera um nome predefinido. get_name() está disponível desde o Python 3.8.
Exemplos
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
O evento `started` garante que a tarefa entrou no bloco `try` antes do pedido de cancelamento. O relatório apresenta o nome `worker` só depois de `finally` ser executado.
Lições relacionadas
- Python · Lição 30 · Avançado · Versão: 5