Docs communicates anyio_backend is function scoped, but it's actually module scoped - #1202
Open
EmmanuelNiyonshuti wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
NOTE Erasing or replacing the contents of this template will result in your pull
request being summarily closed without consideration!
Changes
Related to ##1156
I got a little hesitant here because reverting
anyio_backendback to function scopeddoesn't break anyio's own test suite. I suspected this was because the 3.x backport
#437 (backporting the async-generator-fixture
change from #435) explicitly added
anyio_backendas module scoped directly insidetest_pytest_plugin.test_module_scoped_task_group_fixture:anyio/tests/test_pytest_plugin.py
Lines 273 to 275 in 85b8b6e
What I took this to imply was that anyio_backend had stayed function scoped, except it was already updated to module scoped in #435 , hence redeclaring it as module scoped explicitly in that one test doesn't seem to change anything.
Best I can tell, having anyio_backend module scoped by default reduces the boilerplate for higher-scoped async/async-generator fixtures.
Another tiny confusion was that, there are two fixtures that depend on
anyio_backendfor convenience,https://anyio.readthedocs.io/en/stable/testing.html#:~:text=Because%20the%20anyio_backend,run%20the%20backend
anyio/src/anyio/pytest_plugin.py
Lines 281 to 282 in 85b8b6e
anyio/src/anyio/pytest_plugin.py
Lines 289 to 290 in 85b8b6e
and these were left function scoped. But, I don't think this a problem?. These fixtures aren't auto-injected into async fixtures like anyio_backend is; they're only pulled in when someone deliberately requests them.
And updating the docs seemed to make more sense to me than reverting
anyio_backendback tofunction scoped, unless I'm proven wrong.
Checklist
If this is a user-facing code change, like a bugfix or a new feature, please ensure that
you've fulfilled the following conditions (where applicable):
tests/) which would fail without your patchdocs/), in case of behavior changes or newfeatures
docs/versionhistory.rst).If this is a trivial change, like a typo fix or a code reformatting, then you can ignore
these instructions.
Updating the changelog
If there are no entries after the last release, use
**UNRELEASED**as the version.If, say, your patch fixes issue #123, the entry should look like this:
If there's no issue linked, just link to your pull request instead by updating the
changelog after you've created the PR.