GH-96704: Add task.get_context(), use it in call_exception_handler() by gvanrossum · Pull Request #96756 · python/cpython · GitHub
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
16 changes: 16 additions & 0 deletions Doc/library/asyncio-eventloop.rst
7 changes: 7 additions & 0 deletions Doc/library/asyncio-task.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,13 @@ Task Object

.. versionadded:: 3.8

.. method:: get_context()

Return the :class:`contextvars.Context` object
associated with the task.

.. versionadded:: 3.12

.. method:: get_name()

Return the name of the Task.
Expand Down
17 changes: 16 additions & 1 deletion Lib/asyncio/base_events.py
Original file line number Diff line number Diff line change
Expand Up @@ -1808,7 +1808,22 @@ def call_exception_handler(self, context):
exc_info=True)
else:
try:
self._exception_handler(self, context)
ctx = None
thing = context.get("task")
if thing is None:
# Even though Futures don't have a context,
# Task is a subclass of Future,
# and sometimes the 'future' key holds a Task.
thing = context.get("future")
if thing is None:
# Handles also have a context.
thing = context.get("handle")
if thing is not None and hasattr(thing, "get_context"):
ctx = thing.get_context()
if ctx is not None and hasattr(ctx, "run"):
ctx.run(self._exception_handler, self, context)
else:
self._exception_handler(self, context)
except (SystemExit, KeyboardInterrupt):
raise
except BaseException as exc:
Expand Down
3 changes: 3 additions & 0 deletions Lib/asyncio/events.py
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ def __repr__(self):
info = self._repr_info()
return '<{}>'.format(' '.join(info))

def get_context(self):
return self._context

def cancel(self):
if not self._cancelled:
self._cancelled = True
Expand Down
3 changes: 3 additions & 0 deletions Lib/asyncio/tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,9 @@ def __repr__(self):
def get_coro(self):
return self._coro

def get_context(self):
return self._context

def get_name(self):
return self._name

Expand Down
41 changes: 41 additions & 0 deletions Lib/test/test_asyncio/test_futures2.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# IsolatedAsyncioTestCase based tests
import asyncio
import contextvars
import traceback
import unittest
from asyncio import tasks
Expand Down Expand Up @@ -27,6 +28,46 @@ async def raise_exc():
else:
self.fail('TypeError was not raised')

async def test_task_exc_handler_correct_context(self):
# see https://github.com/python/cpython/issues/96704
name = contextvars.ContextVar('name', default='foo')
exc_handler_called = False

def exc_handler(*args):
self.assertEqual(name.get(), 'bar')
nonlocal exc_handler_called
exc_handler_called = True

async def task():
name.set('bar')
1/0

loop = asyncio.get_running_loop()
loop.set_exception_handler(exc_handler)
self.cls(task())
await asyncio.sleep(0)
self.assertTrue(exc_handler_called)

async def test_handle_exc_handler_correct_context(self):
# see https://github.com/python/cpython/issues/96704
name = contextvars.ContextVar('name', default='foo')
exc_handler_called = False

def exc_handler(*args):
self.assertEqual(name.get(), 'bar')
nonlocal exc_handler_called
exc_handler_called = True

def callback():
name.set('bar')
1/0

loop = asyncio.get_running_loop()
loop.set_exception_handler(exc_handler)
loop.call_soon(callback)
await asyncio.sleep(0)
self.assertTrue(exc_handler_called)

@unittest.skipUnless(hasattr(tasks, '_CTask'),
'requires the C _asyncio module')
class CFutureTests(FutureTests, unittest.IsolatedAsyncioTestCase):
Expand Down
11 changes: 11 additions & 0 deletions Lib/test/test_asyncio/test_tasks.py
Original file line number Diff line number Diff line change
Expand Up @@ -2482,6 +2482,17 @@ def test_get_coro(self):
finally:
loop.close()

def test_get_context(self):
loop = asyncio.new_event_loop()
coro = coroutine_function()
context = contextvars.copy_context()
try:
task = self.new_task(loop, coro, context=context)
loop.run_until_complete(task)
self.assertIs(task.get_context(), context)
finally:
loop.close()


def add_subclass_tests(cls):
BaseTask = cls.Task
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Pass the correct ``contextvars.Context`` when a ``asyncio`` exception handler is called on behalf of a task or callback handle. This adds a new ``Task`` method, ``get_context``, and also a new ``Handle`` method with the same name. If this method is not found on a task object (perhaps because it is a third-party library that does not yet provide this method), the context prevailing at the time the exception handler is called is used.
13 changes: 13 additions & 0 deletions Modules/_asynciomodule.c
19 changes: 18 additions & 1 deletion Modules/clinic/_asynciomodule.c.h

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.