CKTIS / Python
Een asyncio-taak annuleren en de naam opvragen
Vraag annulering aan, wacht tot de taak klaar is en meld de naam en of de taak daadwerkelijk is geannuleerd.
Versie: Python 3.12
Syntax
task.cancel(msg=None) -> bool
task.cancelled() -> bool
task.get_name() -> strIn Python 3.12 vraagt asyncio.Task.cancel om annulering van een taak. task.cancel() geeft True terug als het verzoek wordt gedaan en False als de taak al klaar is. True bevestigt de annulering niet: anders dan asyncio.Future.cancel() bij een nog niet afgerond Future-object zet deze aanroep het object niet meteen in de geannuleerde toestand. De optionele parameter msg is toegevoegd in Python 3.9; sinds 3.11 wordt het bericht doorgegeven aan de code die op de geannuleerde taak wacht.
Zodra dat kan, werpt de eventloop asyncio.CancelledError op in de coroutine. Doe het opruimwerk in finally. Vang je de uitzondering binnen de taak af, werp die dan normaal gesproken na het opruimen opnieuw op. De uitzondering erft van BaseException, dus except Exception vangt haar niet af. Als je haar onderdrukt, kan de taak doorlopen en de werking van asyncio.TaskGroup of asyncio.timeout() verstoren.
Wacht na het annuleringsverzoek met await task tot de taak klaar is. Als de taak door annulering is geëindigd, werpt await asyncio.CancelledError op en geeft task.cancelled() True terug. Alleen het verzoek is niet genoeg om task.cancelled() True te laten teruggeven.
Vraag voor de rapportage met task.get_name() de taaknaam als str op. Je kunt de naam instellen met asyncio.create_task(..., name=...); zonder expliciete naam genereert de standaardimplementatie van Task een standaardnaam. get_name() is beschikbaar sinds Python 3.8.
Voorbeelden
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())
Resultaat
requested=True, cancelled=False cleanup worker: cancelled=True
Het event `started` zorgt ervoor dat de taak haar `try`-blok heeft bereikt vóór het annuleringsverzoek. De rapportage toont de naam `worker` pas nadat `finally` is uitgevoerd.
Gerelateerde lessen
- Python · Les 30 · Gevorderd · Versie: 5