gh-127174: add some advice for asyncio.get_event_loop replacements #127640
Conversation
This file contains 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
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
Doc/whatsnew/3.14.rst
Outdated
| def start_server(loop): | ||
| ... | ||
|
|
||
| async def amain(): |
There was a problem hiding this comment.
Why switch to amain() instead of main() like before? I think all examples should use a consistent style.
Suggested change
| async def amain(): | |
| async def main(): |
There was a problem hiding this comment.
Yeah I prefer the amain, it's compatible with idiomatic usage of console scripts:
import asyncio
import sys
async def amain():
...
def main():
return asyncio.run(amain())
if __name__ == "__main__":
sys.exit(main())
Doc/whatsnew/3.14.rst
Outdated
| start_server(asyncio.get_running_loop()) | ||
| await asyncio.Event().wait() | ||
|
|
||
| asyncio.run(amain()) |
There was a problem hiding this comment.
Suggested change
| asyncio.run(amain()) | |
| asyncio.run(main()) |
Doc/whatsnew/3.14.rst
Outdated
| asyncio.run(amain()) | ||
|
|
||
| If you need to run something in an event loop, then run some blocking | ||
| code around it, use :class:`asyncio.Runner`, before:: |
There was a problem hiding this comment.
Suggested change
| code around it, use :class:`asyncio.Runner`, before:: | |
| code around it, use :class:`asyncio.Runner`. |
There was a problem hiding this comment.
This needs the :: for the code block to work
|
|
||
| If you need to run something in an event loop, then run some blocking | ||
| code around it, use :class:`asyncio.Runner`, before:: | ||
|
|
There was a problem hiding this comment.
Suggested change
| before:: | |
graingert
commented
Dec 6, 2024
graingert
commented
Dec 6, 2024
graingert
commented
Dec 6, 2024
picnixz
reviewed
Dec 7, 2024
|
|
||
| loop = asyncio.get_event_loop() | ||
| try: | ||
| loop.run_until_complete(amain()) |
There was a problem hiding this comment.
Can you use 4-spaces indents in the Python code please?
|
|
||
| If you're running an async function, simply use :func:`asyncio.run`. | ||
|
|
||
| before:: |
There was a problem hiding this comment.
Suggested change
| before:: | |
| Before:: |
| finally: | ||
| loop.close() | ||
|
|
||
| after:: |
There was a problem hiding this comment.
Suggested change
| after:: | |
| After:: |
| and then run forever, use :func:`asyncio.run` and an | ||
| :class:`asyncio.Event`. | ||
|
|
||
| before:: |
There was a problem hiding this comment.
Suggested change
| before:: | |
| Before:: |
| finally: | ||
| loop.close() | ||
|
|
||
| after:: |
There was a problem hiding this comment.
Suggested change
| after:: | |
| After:: |
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.
📚 Documentation preview 📚: https://cpython-previews--127640.org.readthedocs.build/