Python Asyncio Task Cancellation

Question

I was reading asyncio documentation for task cancel and I came across this -

To cancel a running Task use the cancel() method. Calling it will cause the Task to throw a CancelledError exception into the wrapped coroutine. If a coroutine is awaiting on a Future object during cancellation, the Future object will be cancelled.

cancelled() can be used to check if the Task was cancelled. The method returns True if the wrapped coroutine did not suppress the CancelledError exception and was actually cancelled.

I have a few questions here -

Is wrapped coroutine the coroutine in which cancel is called? Let's take an example here -
```
async def wrapped_coroutine():
    for task in asyncio.Task.all_tasks():
        task.cancel()
```
So wrapped_coroutine() is the wrapped coroutine where task will throw an exception?
When will this exception be thrown? And where?

What does suppress the exception mean here? Does it mean this -

async def wrapped_coroutine():
    for task in asyncio.Task.all_tasks():
        task.cancel()
        try:
            await task
        except asyncio.CancelledError:
            print("Task cancelled")

If not, please provide an example on how to suppress this exception.

And an unrelated(it's related to cancelling tasks), how do I retrieve exceptions out of these tasks when I'm cancelling these so I don't see this -

Task exception was never retrieved future:

Is it before task.cancel() or in try before await task (in the above example) ?

Isn't the example in the documentation very clear on this? docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancel — Grismar
– Grismar, Commented May 9, 2019 at 5:37
Ok, I hope the explanation I provide below is more clear, but please ask further questions if that doesn't clear it up. — Grismar
– Grismar, Commented May 9, 2019 at 6:26
"Wrapped" refers to the fact that each Task takes ownership of a coroutine, and in a sense "wraps" it. (When you pass a coroutine to a task, you're no longer allowed to await it directly.) So, wrapped coroutine is the coroutine executed by the task that got cancelled - i.e. not the caller of task.cancel(), but its receiver. In that coroutine the await it is suspended on will resume with a CancelledError. — user4815162342
– user4815162342, Commented May 9, 2019 at 9:10

Grismar · Accepted Answer · 2019-05-09 06:24:25Z

29

Looking at the code in the example given in the documentation https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancel:

async def cancel_me():
    print('cancel_me(): before sleep')

    try:
        # Wait for 1 hour
        await asyncio.sleep(3600)
    except asyncio.CancelledError:
        print('cancel_me(): cancel sleep')
        raise
    finally:
        print('cancel_me(): after sleep')

async def main():
    # Create a "cancel_me" Task
    task = asyncio.create_task(cancel_me())

    # Wait for 1 second
    await asyncio.sleep(1)

    task.cancel()
    try:
        await task
    except asyncio.CancelledError:
        print("main(): cancel_me is cancelled now")

asyncio.run(main())

Answering your questions:

"Is the wrapped coroutine the coroutine in which cancel is called?"
No, the wrapped coroutine here is cancel_me(); .cancel() is called in main().
"When will this exception be thrown? And where?"
This exception is thrown after task.cancel() is called. It is thrown inside the coroutine, where it is caught in the example, and it is then re-raised to be thrown and caught in the awaiting routine.
"What does suppress the exception mean here?"
If cancel_me() would not have re-raised the exception after catching it. As the documentation of cancelled() states: "The Task is cancelled when the cancellation was requested with cancel() and the wrapped coroutine propagated the CancelledError exception thrown into it." https://docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancelled

answered May 9, 2019 at 6:24

Grismar

32.4k6 gold badges42 silver badges68 bronze badges

Sign up to request clarification or add additional context in comments.

9 Comments

Sushant Over a year ago

What if there's a lot of logic in cancel_me()? Putting too broad of try except is always a bad idea right?

Grismar Over a year ago

Note that asyncio does not solve the exact same problem as multiprocessing which allows you to launch tasks running in parallel. asyncio allows you to run tasks asynchronously, but they still share computing resources. So, the exact moment in "a lot of logic" would have to coincide with some point in the code where control would be returned to the routine.

CMCDragonkai Over a year ago

Why do we need to await on the task after we call cancel() on it? What's the point?

Grismar Over a year ago

See here, @CMCDragonkai docs.python.org/3/library/asyncio-task.html#asyncio.Task.cancel - calling .cancel() still allows the task to wrap up nicely, and that's what's being awaited.

Danny Over a year ago

@lanzz task.cancelled() is True if task was cancelled, but False in the unlikely (for this snippet) event that the try...catch has caught cancellation of the main() task

|

Collectives™ on Stack Overflow

Python Asyncio Task Cancellation

1 Answer 1

9 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

9 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related