Skip to content

docs(python): document that task cancellation is not supported #42312

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Yury Semikhatsky (yury-s) merged 2 commits into from
Aug 19, 2026
Merged

docs(python): document that task cancellation is not supported #42312

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
218b0b7
docs(python): document that task cancellation is not supported
yury-s Aug 19, 2026
4640b4e
docs(python): simplify the task cancellation clause
yury-s Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/src/library-python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,3 +199,7 @@ On Windows Python 3.7, Playwright sets the default event loop to `ProactorEventL
### Threading

Playwright's API is not thread-safe. If you are using Playwright in a multi-threaded environment, you should create a playwright instance per thread. See [threading issue](https://github.com/microsoft/playwright-python/issues/623) for more details.

### Cancelling `asyncio` tasks

Cancelling a task that is running a Playwright call is not supported and results in undefined behavior. If an operation has to outlive its caller, run it in a separate task and protect it with [`asyncio.shield()`](https://docs.python.org/3/library/asyncio-task.html#asyncio.shield).

@dgozman Dmitry Gozman (dgozman) Aug 19, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... This was implemented in microsoft/playwright-python#3144. Do we think it's not working properly?

@sattlerc Christian Sattler (sattlerc) Aug 19, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That would mean playwright cannot be run without further logic in a TaskGroup with other tasks that may fail.

@yury-s Yury Semikhatsky (yury-s) Aug 19, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm... This was implemented in microsoft/playwright-python#3144. Do we think it's not working properly?

That is one of the many places, we walked over the code with Pavel today to see if this has improved significantly since a few years ago and found quite a few spots that are not ready. That's why the decision to document it. Proper fix would be a bigger investment.