Cancelamento no asyncio: faça a limpeza sem engolir CancelledError

O que é

A documentação do asyncio do Python recomenda usar try/finally para a limpeza e, em geral, propagar CancelledError depois de tratá-lo explicitamente. Ela avisa que TaskGroup e os mecanismos de timeout usam o cancelamento internamente e podem se comportar mal se uma corrotina o engolir. O cancelamento, portanto, faz parte do contrato da tarefa e não é apenas mais um erro a ser convertido em um resultado comum. Python asyncio tasks

Por que importa

Um agente pode adicionar um ramo amplo de recuperação para manter um worker em execução e, sem querer, impedir que o responsável por ele o interrompa. É preciso distinguir uma falha esperada da operação de um pedido para encerrar a tarefa. A revisão proposta acompanha o cancelamento desde a requisição do pai, passando pela limpeza, até o resultado visível para quem chamou.

Como aplicar

• Localize todos os tratadores de exceção em torno de trabalho aguardado com await e identifique qual deles trata o cancelamento. Registre se a corrotina o propaga, o converte ou o suprime de propósito.
• Coloque a liberação de recursos em um bloco finally ou em um gerenciador de contexto assíncrono adequado. Mantenha a limpeza enxuta e defina o que acontece se a própria limpeza falhar ou for cancelada.
• Ao capturar CancelledError explicitamente para executar trabalho extra, normalmente é preciso relançá-lo em seguida. Trate a supressão como uma decisão de projeto deliberada, que exige um protocolo documentado no nível do responsável pela tarefa.
• Proponha fixtures que cancelem antes da aquisição do recurso, durante uma operação aguardada e depois de um progresso parcial. Verifique o estado dos recursos e o resultado final da tarefa, em vez de apenas conferir se uma linha de log apareceu.
• Execute a corrotina dentro do TaskGroup ou do contexto de timeout reais, para que as interações com o escopo pai fiquem visíveis.

Armadilhas

O cancelamento não desfaz efeitos colaterais externos já confirmados. A limpeza também não torna a nova tentativa segura automaticamente. Evite usar proteção contra cancelamento (shielding) ou manipular o estado de cancelamento só para esconder um timeout incômodo; para uma supressão deliberada, consulte o contrato da versão exata do asyncio. Nenhum teste de cancelamento foi executado para este artigo, e o método não promete o encerramento imediato de código bloqueante arbitrário.