Skip to content

gh-93896: allow enabling asyncio.Runner calls to asyncio.set_event_loop independantly to loop_factory #94058

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

Conversation

graingert
Copy link
Contributor

@graingert graingert commented Jun 21, 2022

@graingert graingert changed the title restore the set_event_loop calls to asyncio.run #93896 restore the set_event_loop calls to asyncio.run Jun 21, 2022
if sys.platform == "win32":
from .windows_events import ProactorEventLoop as _new_event_loop
else:
from .unix_events import SelectorEventLoop as _new_event_loop
Copy link
Contributor Author

Choose a reason for hiding this comment

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

this opts asyncio.Runner out of the policy system and asyncio.run opts back in

@graingert graingert changed the title #93896 restore the set_event_loop calls to asyncio.run #gh-93896 restore the set_event_loop calls to asyncio.run Jun 21, 2022
@graingert graingert changed the title #gh-93896 restore the set_event_loop calls to asyncio.run #gh-93896: restore the set_event_loop calls to asyncio.run Jun 21, 2022
@graingert graingert changed the title #gh-93896: restore the set_event_loop calls to asyncio.run gh-93896: restore the set_event_loop calls to asyncio.run Jun 21, 2022
@graingert graingert force-pushed the restore-set-event-loop-policy-to-asyncio-run branch from f21f808 to abbd6b4 Compare June 22, 2022 12:52
@graingert graingert marked this pull request as ready for review June 22, 2022 13:29
@graingert graingert requested review from 1st1 and asvetlov as code owners June 22, 2022 13:29
Comment on lines +38 to +39
If set_policy_loop is True, the event loop in the default policy will be
set.
Copy link
Contributor

Choose a reason for hiding this comment

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

If this is classified as a bug (clearly it is causing issues), then fixing it shouldn't be blocking. By only implementing this behind an argument we are introducing a new feature which means that this will only be added to 3.12 (and not 3.11).

I would vote for not adding this argument.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think it's important to maintain the asyncio.Runner support for a high level policy-free use of asyncio, so that the policy system can be deprecated and removed

Copy link
Contributor

Choose a reason for hiding this comment

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

By adding this option we make it more difficult to deprecate the policy system because then this option will need to be deprecated as well. Users who specify this option will have more to do to migrate.

Copy link
Contributor Author

@graingert graingert Jun 27, 2022

Choose a reason for hiding this comment

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

How about I remove the flag from asyncio.Runner and have callers use a wrapper that mutates the policy loop?

@contextmanager
def _with_policy_loop(loop):
    try:
        asyncio.set_event_loop(loop)
        yield
    finally:
        asyncio.set_event_loop(None)
runner = asyncio.Runner()
cmgr = _with_policy_loop(runner.get_loop())
try:
    cmgr(runner.run)(corofn())
finally:
    cmgr(runner.close)()

Users who specify this option will have more to do to migrate.

I'm proposing this set_policy_loop flag get deprecated at the same time as the policy system. I could add the flag as deprecated in this PR so users won't add it unless they already have more work to do to migrate from the policy system as a concept

Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think I understand the downside with enabling this by default. My arguments boil down to:

  • With this flag disabled, we retain the current behaviour which causes issues. I would guess that most people don't fully understand what it does and will leave it to the default, then potentially run into these issues.

  • As we've so far discussed, this flag is a fix for an issue which might soon no matter much because it is planned to be deprecated. With this option needing to be explicitly enabled, we introduce more things to deprecate. If, instead, this would be enabled by default then most would not need to change anything as it gets removed after the deprecation period.

I am not super confident in the event loop policy system, so I won't continue arguing if you don't agree with me after this comment - i'll defer to whenever a core dev takes a look at this issue.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

With this flag disabled, we retain the current behaviour which causes issues. I would guess that most people don't fully understand what it does and will leave it to the default, then potentially run into these issues.

It should be opt in for asyncio.Runner

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yep: set_policy_loop defaults to False in asyncio.Runner: def __init__(self, *, debug=None, loop_factory=None, set_policy_loop=False):

people using the old asyncio.run get the old behaviour that uses the policy loop factory and sets the policy loop. People using the new asyncio.Runner get the new behaviour which does not use the policy loop factory or set the policy loop by default

Comment on lines +183 to +185
This function always creates a new event loop from the default policy sets
it in the event loop policy and closes it at the end and sets the policy
loop to None.
Copy link
Contributor

Choose a reason for hiding this comment

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

This long sentence is quite wordy and without knowing the change I would probably not understand what it means.

I would probably suggest not making this change (referring to this very sentence). To most, setting the loop in the event loop policy is probably synonymous to actually creating and running a loop.

@encukou encukou requested a review from pablogsal July 4, 2022 17:19
@graingert graingert changed the title gh-93896: restore the set_event_loop calls to asyncio.run gh-93896: allow enabling asyncio.Runner calls to asyncio.set_event_loop independantly to loop_factory Jul 6, 2022
@graingert
Copy link
Contributor Author

I've merged the changes from #94593 so I'm now proposing this as a feature change instead of a bug fix

Comment on lines +144 to +145
if self._set_policy_loop:
events.set_event_loop(None)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kumaraditya303 it looks like your PR is missing some calls to set_event_loop here

Copy link
Contributor

Choose a reason for hiding this comment

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

asyncio.Runner should be used a context manager and its close method removes the set event loop so not required here.

Copy link
Contributor Author

@graingert graingert Jul 6, 2022

Choose a reason for hiding this comment

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

the issue being when Runner.run finishes the loop should be unset

with Runner() as runner1, Runner() as runner2:
    runner1.run(fn())  # calls set_event_loop
    runner2.run(fn())  # also calls set_event_loop
    # I'd expect the event loop to be unset here

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd expect the event loop to be unset here

That happens only if you supply your loop_factory otherwise for existing code, its better to keep it set for existing code not using asyncio.Runner.

Copy link
Contributor

Choose a reason for hiding this comment

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

I would expect the event loop to be set until the context manager exit which is what we have currently.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ah I see what you mean

@graingert
Copy link
Contributor Author

I'll close this PR for now. It might make sense to re-introduce the set_policy_loop kwarg for 3.12 if the policy system is deprecated

@graingert graingert closed this Jul 6, 2022
@graingert graingert deleted the restore-set-event-loop-policy-to-asyncio-run branch July 6, 2022 16:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

IsolatedAsyncioTestCase and asyncio.run no-longer call asyncio.set_event_loop
4 participants