Repository navigation
Add missing await to open_file() in file I/O concurrency example - #1182
Merged
agronholm merged 2 commits intoJun 20, 2026
Merged
Conversation
The "Limiting concurrency" example used "async with open_file(...)", but open_file() is a coroutine function, so the example raised a TypeError when run. Added the missing await so it matches the other two open_file() examples in the same file.
Trivial changes don't need changelog entries.
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.
Changes
The "Limiting concurrency" example in
docs/fileio.rstusesasync with open_file('/foo/bar', limiter=limiter) as fp:. Sinceopen_file()is a coroutine function, this raisesTypeError: 'coroutine' object does not support the asynchronous context manager protocolwhen run as written.Added the missing
awaitso the example actually runs. It now matches the other twoopen_file()examples in the same file, which already useasync with await open_file(...).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.