Baza znanjaIzpitno središče
SLSlovenščina
Izberi jezik13

CKTIS / Python

Preklic opravila asyncio in pridobitev njegovega imena

Zahtevaj preklic, počakaj na konec opravila in izpiši njegovo ime ter podatek, ali je bilo res preklicano.

Različica: Python 3.12

Sintaksa

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

V Pythonu 3.12 metoda asyncio.Task.cancel zahteva preklic opravila. task.cancel() vrne True, če odda zahtevo, in False, če se je opravilo že končalo. True ne potrjuje preklica: v nasprotju z asyncio.Future.cancel() pri še nedokončanem objektu Future ta klic objekta ne postavi takoj v stanje preklica. Izbirni parameter msg je bil dodan v Pythonu 3.9; od različice 3.11 se sporočilo posreduje kodi, ki čaka na preklicano opravilo.

Ob prvi priložnosti zanka dogodkov v korutini sproži izjemo asyncio.CancelledError. Čiščenje opravi v bloku finally. Če izjemo ujameš znotraj opravila, jo po čiščenju praviloma znova sproži. Deduje iz BaseException, zato je except Exception ne ujame. Če jo zatreš, se lahko opravilo izvaja naprej in zmoti delovanje asyncio.TaskGroup ali asyncio.timeout().

Po zahtevi za preklic z await task počakaj, da se opravilo konča. Če se konča zaradi preklica, await sproži asyncio.CancelledError, task.cancelled() pa vrne True. Sama zahteva ni dovolj, da bi task.cancelled() vrnil True.

Za poročilo pridobi ime opravila z task.get_name(), ki ga vrne kot str. Nastaviš ga lahko z asyncio.create_task(..., name=...); brez izrecno podanega imena standardna izvedba Task ustvari privzeto ime. get_name() je na voljo od Pythona 3.8.

Primeri

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

Rezultat

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

Dogodek `started` zagotovi, da je opravilo pred zahtevo za preklic že vstopilo v blok `try`. Poročilo izpiše ime `worker` šele po izvedbi bloka `finally`.

Povezane lekcije

  • Python · Lekcija 30 · Napredna · Različica: 5

Viri