Abort async tasks using asyncio #1190
Conversation
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
onlyann
force-pushed
the
cancel-async-tasks
branch
from
5932d48
to
229e086
Compare
onlyann
force-pushed
the
cancel-async-tasks
branch
from
229e086
to
6ace0f5
Compare
docs/howto/advanced/cancellation.md
Outdated
| await do_something() | ||
| ``` | ||
|
|
||
| It is possible to prevent the job from aborting by capturing asyncio.CancelledError. |
There was a problem hiding this comment.
| It is possible to prevent the job from aborting by capturing asyncio.CancelledError. | |
| It is possible to prevent the job from aborting by [shielding](https://docs.python.org/3/library/asyncio-task.html#shielding-from-cancellation) (and/or with `except asyncio.CancelledError`. |
There was a problem hiding this comment.
Technically, what prevents the job from being aborted is catching the error, not shielding.
In practice, it is likely the combination of both that the user wants.
How would you prefer to word it?
There was a problem hiding this comment.
If you want to have some custom behavior at cancellation time, use a combination of [shielding](https://docs.python.org/3/library/asyncio-task.html#shielding-from-cancellation) and `except asyncio.CancelledError`.
procrastinate/worker.py
Outdated
| ) | ||
|
|
||
| for task in tasks_to_cancel: | ||
| task.cancel() |
There was a problem hiding this comment.
It's worth logging something (in debug) for each cancelled task. I think I would remove the
and context.task
and asyncio.iscoroutinefunction(context.task.func)
above, and instead make a dedicated function that receives a task & context and logs and cancels it if it's a coroutine.
|
Seems like you know how to make an empty commit to trigger CI. Note; you can combine this with |
|
Congratulations again :) |
Closes #1084
Successful PR Checklist:
PR label(s):
Changes
This modifies the way jobs are being aborted when the task is async, by cancelling the underlying asyncio Task that represents the running job.