Skip to content

gh-101486: Make IsolatedAsyncioTestCase less picky about what is async [DO-NOT-MERGE] #101487

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.

Sign up for GitHub

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

Closed
wants to merge 5 commits into from
Closed

gh-101486: Make IsolatedAsyncioTestCase less picky about what is async [DO-NOT-MERGE] #101487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
00673f9
Add missing __unittest = True marker to async_case.py
zware Jan 31, 2023
ab3633f
Remove out-of-date implementation comment
zware Jan 31, 2023
f3eb654
Run the entire test in the test context
zware Feb 1, 2023
075971f
DO-NOT-MERGE: Hack around the inability to re-enter a running context
zware Feb 1, 2023
6437de3
Merge branch 'main' into DNM-async_unittest_full_run_context
willingc Apr 26, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion Lib/asyncio/events.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,13 @@ def cancelled(self):

def _run(self):
try:
self._context.run(self._callback, *self._args)
try:
self._context.run(self._callback, *self._args)
except RuntimeError as e:
if 'cannot enter context' not in str(e):
raise
# XXX: HACK!
self._callback(*self._args)
except (SystemExit, KeyboardInterrupt):
raise
except BaseException as exc:
Expand Down
36 changes: 14 additions & 22 deletions Lib/unittest/async_case.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,13 @@
from .case import TestCase


__unittest = True


class IsolatedAsyncioTestCase(TestCase):
# Names intentionally have a long prefix
# to reduce a chance of clashing with user-defined attributes
# from inherited test case
#
# The class doesn't call loop.run_until_complete(self.setUp()) and family
# but uses a different approach:
# 1. create a long-running task that reads self.setUp()
# awaitable from queue along with a future
# 2. await the awaitable object passing in and set the result
# into the future object
# 3. Outer code puts the awaitable and the future object into a queue
# with waiting for the future
# The trick is necessary because every run_until_complete() call
# creates a new task with embedded ContextVar context.
# To share contextvars between setUp(), test and tearDown() we need to execute
# them inside the same task.

# Note: the test case modifies event loop policy if the policy was not instantiated
# yet.
Expand Down Expand Up @@ -83,7 +73,7 @@ def _callSetUp(self):
# so that setUp functions can use get_event_loop() and get the
# correct loop instance.
self._asyncioRunner.get_loop()
self._asyncioTestContext.run(self.setUp)
self.setUp()
self._callAsync(self.asyncSetUp)

def _callTestMethod(self, method):
Expand All @@ -93,28 +83,30 @@ def _callTestMethod(self, method):

def _callTearDown(self):
self._callAsync(self.asyncTearDown)
self._asyncioTestContext.run(self.tearDown)
self.tearDown()

def _callCleanup(self, function, *args, **kwargs):
self._callMaybeAsync(function, *args, **kwargs)

def _callAsync(self, func, /, *args, **kwargs):
assert self._asyncioRunner is not None, 'asyncio runner is not initialized'
assert inspect.iscoroutinefunction(func), f'{func!r} is not an async function'
result = func(*args, **kwargs)
assert inspect.isawaitable(result), f'{func!r} does not return an awaitable'
return self._asyncioRunner.run(
func(*args, **kwargs),
result,
context=self._asyncioTestContext
)

def _callMaybeAsync(self, func, /, *args, **kwargs):
assert self._asyncioRunner is not None, 'asyncio runner is not initialized'
if inspect.iscoroutinefunction(func):
result = func(*args, **kwargs)
if inspect.isawaitable(result):
return self._asyncioRunner.run(
func(*args, **kwargs),
result,
context=self._asyncioTestContext,
)
else:
return self._asyncioTestContext.run(func, *args, **kwargs)
return result

def _setupAsyncioRunner(self):
assert self._asyncioRunner is None, 'asyncio runner is already initialized'
Expand All @@ -128,13 +120,13 @@ def _tearDownAsyncioRunner(self):
def run(self, result=None):
self._setupAsyncioRunner()
try:
return super().run(result)
return self._asyncioTestContext.run(super().run, result)
finally:
self._tearDownAsyncioRunner()

def debug(self):
self._setupAsyncioRunner()
super().debug()
self._asyncioTestContext.run(super().debug)
self._tearDownAsyncioRunner()

def __del__(self):
Expand Down