Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / Python

Ler o nome de uma tarefa com `asyncio.Task.get_name()`

`get_name()` devolve o nome atual de uma tarefa asyncio como cadeia de carateres. Usa-o como etiqueta num relatório e verifica separadamente com `cancelled()` se a tarefa foi mesmo cancelada.

Versão: Python 3.12

Sintaxe

task.get_name()  # returns str

task.get_name() é um método de instância síncrono de asyncio.Task, disponível desde o Python 3.8. Não recebe argumentos e devolve o nome atual como str. Não precisas de await: podes ler o nome antes ou depois de a tarefa terminar.

Atribui um nome com asyncio.create_task(coro, name=...) ou altera-o com task.set_name(value), que converte o valor numa cadeia de carateres. Sem um nome explícito, a implementação padrão de Task gera um ao criar a tarefa. Usa-o como etiqueta de diagnóstico, não como identificador único nem como indicador do estado.

task.cancel() pede o cancelamento, mas não o garante: a corrotina pode intercetar e suprimir asyncio.CancelledError. Para relatar o resultado, espera pelo fim da tarefa com await task, trata a exceção asyncio.CancelledError esperada e verifica task.cancelled(). Normalmente, a corrotina deve libertar recursos em finally e deixar o cancelamento propagar-se.

Exemplos

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

Resultado

report-worker: cancelled=True

O evento `started` permite aguardar o arranque da corrotina sem um atraso predefinido. O segundo evento nunca é sinalizado, pelo que a tarefa fica à espera até ao cancelamento. O relatório combina o nome explícito com o estado confirmado depois de `await task`.

Lições relacionadas

  • Python · Lição 30 · Avançado · Versão: 5

Fontes