Skip to content
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.

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

async100 now ignores trio.open_nursery and anyio.create_task_group #317

Merged
merged 5 commits into from
Nov 17, 2024

Conversation

jakkdl
Copy link
Member

@jakkdl jakkdl commented Nov 15, 2024

I was cleaning up old branches in my fork, and it... seems like I never opened a PR for this? Wrote it several months ago, so decided to just rebase and clean it up

Copy link
Member

@Zac-HD Zac-HD left a comment

Choose a reason for hiding this comment

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

LGTM with some more documentation as below - thanks!

@@ -4,6 +4,10 @@ Changelog

`CalVer, YY.month.patch <https://calver.org/>`_

24.11.1
======
- :ref:`ASYNC100 <async100>` now ignores :func:`trio.open_nursery` and :func:`anyio.create_task_group` as cancellation sources.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- :ref:`ASYNC100 <async100>` now ignores :func:`trio.open_nursery` and :func:`anyio.create_task_group` as cancellation sources.
- :ref:`ASYNC100 <async100>` now ignores :func:`trio.open_nursery` and :func:`anyio.create_task_group` as cancellation sources,
because they are schedule points but not cancellation points.

This is a subtle enough concept that we should not assume users are familiar with it - I'd also call out this distinction in the docs for ASYNC100, and create glossary entries for both which are linked from "checkpoint" and link in turn to Trio docs (eg for cancel_shielded_checkpoint() and checkpoint_if_cancelled())

Copy link
Member Author

Choose a reason for hiding this comment

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

good call, feel free to reword my attempt :)

@jakkdl jakkdl requested a review from Zac-HD November 17, 2024 13:50
Copy link
Member

@Zac-HD Zac-HD left a comment

Choose a reason for hiding this comment

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

Added some tiny tweaks to the docs for cross-references. Thanks again @jakkdl!

@Zac-HD Zac-HD enabled auto-merge (squash) November 17, 2024 22:50
@Zac-HD Zac-HD merged commit 7a45176 into python-trio:main Nov 17, 2024
9 checks passed
@jakkdl jakkdl deleted the async100_nursery_no_cancel_point branch November 18, 2024 11:23
jakkdl added a commit to jakkdl/flake8-async that referenced this pull request Nov 19, 2024
…ursery and anyio.create_task_group (python-trio#317)"

This partially reverts commit 7a45176.
jakkdl added a commit that referenced this pull request Nov 19, 2024
#326)

* Revert the changes to Visitor91x in "async100 now ignores trio.open_nursery and anyio.create_task_group (#317)"

This partially reverts commit 7a45176.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants