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
use asyncio.run(..., loop_factory) to avoid asyncio.set_event_loop_policy #2130
Open
graingert
wants to merge
5
commits into
encode:master
Choose a base branch
from
graingert:avoid-set-event-loop-policy
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
39d958e
use asyncio.run(..., loop_factory) to avoid asyncio.set_event_loop_po…
graingert cfe5526
only shutdown the default executor on 3.9
graingert 94f178a
rename LoopSetupType to LoopFactoryType
graingert f7297d6
remove redundant UvicornWorker.init_process
graingert 6450a87
fix linter
Kludex File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
from __future__ import annotations | ||
|
||
import asyncio | ||
import sys | ||
from collections.abc import Callable, Coroutine | ||
from typing import Any, TypeVar | ||
|
||
_T = TypeVar("_T") | ||
|
||
if sys.version_info >= (3, 12): | ||
asyncio_run = asyncio.run | ||
elif sys.version_info >= (3, 11): | ||
|
||
def asyncio_run( | ||
main: Coroutine[Any, Any, _T], | ||
*, | ||
debug: bool = False, | ||
loop_factory: Callable[[], asyncio.AbstractEventLoop] | None = None, | ||
) -> _T: | ||
# asyncio.run from Python 3.12 | ||
# https://docs.python.org/3/license.html#psf-license | ||
with asyncio.Runner(debug=debug, loop_factory=loop_factory) as runner: | ||
return runner.run(main) | ||
|
||
else: | ||
# modified version of asyncio.run from Python 3.10 to add loop_factory kwarg | ||
# https://docs.python.org/3/license.html#psf-license | ||
def asyncio_run( | ||
main: Coroutine[Any, Any, _T], | ||
*, | ||
debug: bool = False, | ||
loop_factory: Callable[[], asyncio.AbstractEventLoop] | None = None, | ||
) -> _T: | ||
try: | ||
asyncio.get_running_loop() | ||
except RuntimeError: | ||
pass | ||
else: | ||
raise RuntimeError("asyncio.run() cannot be called from a running event loop") | ||
|
||
if not asyncio.iscoroutine(main): | ||
raise ValueError(f"a coroutine was expected, got {main!r}") | ||
|
||
if loop_factory is None: | ||
loop = asyncio.new_event_loop() | ||
else: | ||
loop = loop_factory() | ||
try: | ||
if loop_factory is None: | ||
asyncio.set_event_loop(loop) | ||
if debug is not None: | ||
loop.set_debug(debug) | ||
return loop.run_until_complete(main) | ||
finally: | ||
try: | ||
_cancel_all_tasks(loop) | ||
loop.run_until_complete(loop.shutdown_asyncgens()) | ||
if sys.version_info >= (3, 9): | ||
loop.run_until_complete(loop.shutdown_default_executor()) | ||
finally: | ||
if loop_factory is None: | ||
asyncio.set_event_loop(None) | ||
loop.close() | ||
|
||
def _cancel_all_tasks(loop: asyncio.AbstractEventLoop) -> None: | ||
to_cancel = asyncio.all_tasks(loop) | ||
if not to_cancel: | ||
return | ||
|
||
for task in to_cancel: | ||
task.cancel() | ||
|
||
loop.run_until_complete(asyncio.gather(*to_cancel, return_exceptions=True)) | ||
|
||
for task in to_cancel: | ||
if task.cancelled(): | ||
continue | ||
if task.exception() is not None: | ||
loop.call_exception_handler( | ||
{ | ||
"message": "unhandled exception during asyncio.run() shutdown", | ||
"exception": task.exception(), | ||
"task": task, | ||
} | ||
) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,10 +1,11 @@ | ||
from __future__ import annotations | ||
|
||
import asyncio | ||
import logging | ||
import sys | ||
|
||
logger = logging.getLogger("uvicorn.error") | ||
from collections.abc import Callable | ||
|
||
|
||
def asyncio_setup(use_subprocess: bool = False) -> None: | ||
if sys.platform == "win32" and use_subprocess: | ||
asyncio.set_event_loop_policy(asyncio.WindowsSelectorEventLoopPolicy()) | ||
def asyncio_loop_factory(use_subprocess: bool = False) -> Callable[[], asyncio.AbstractEventLoop]: | ||
if sys.platform == "win32" and not use_subprocess: | ||
return asyncio.ProactorEventLoop | ||
return asyncio.SelectorEventLoop |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,17 @@ | ||
def auto_loop_setup(use_subprocess: bool = False) -> None: | ||
from __future__ import annotations | ||
|
||
import asyncio | ||
from collections.abc import Callable | ||
|
||
|
||
def auto_loop_factory(use_subprocess: bool = False) -> Callable[[], asyncio.AbstractEventLoop]: | ||
try: | ||
import uvloop # noqa | ||
except ImportError: # pragma: no cover | ||
from uvicorn.loops.asyncio import asyncio_setup as loop_setup | ||
from uvicorn.loops.asyncio import asyncio_loop_factory as loop_factory | ||
|
||
loop_setup(use_subprocess=use_subprocess) | ||
return loop_factory(use_subprocess=use_subprocess) | ||
else: # pragma: no cover | ||
from uvicorn.loops.uvloop import uvloop_setup | ||
from uvicorn.loops.uvloop import uvloop_loop_factory | ||
|
||
uvloop_setup(use_subprocess=use_subprocess) | ||
return uvloop_loop_factory(use_subprocess=use_subprocess) |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,10 @@ | ||
from __future__ import annotations | ||
|
||
import asyncio | ||
from collections.abc import Callable | ||
|
||
import uvloop | ||
|
||
|
||
def uvloop_setup(use_subprocess: bool = False) -> None: | ||
asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. uvloop.EventLoopPolicy is deprecated |
||
def uvloop_loop_factory(use_subprocess: bool = False) -> Callable[[], asyncio.AbstractEventLoop]: | ||
return uvloop.new_event_loop |
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
set_event_loop_policy will be deprecated in python 3.13