diff options
author | Kyle Stanley <aeros167@gmail.com> | 2020-05-21 05:20:43 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-05-21 05:20:43 (GMT) |
commit | 0f56263e62ba91d0baae40fb98947a3a98034a73 (patch) | |
tree | 54ead06a73b5ff9b9603c3d19bf39732401280c8 /Lib | |
parent | 7efb826c3e54edf10315e4baf5e96fe9a3729da4 (diff) | |
download | cpython-0f56263e62ba91d0baae40fb98947a3a98034a73.zip cpython-0f56263e62ba91d0baae40fb98947a3a98034a73.tar.gz cpython-0f56263e62ba91d0baae40fb98947a3a98034a73.tar.bz2 |
bpo-32309: Add support for contextvars in asyncio.to_thread() (GH-20278)
Allows contextvars from the main thread to be accessed in the separate thread used in `asyncio.to_thread()`. See the [discussion](https://github.com/python/cpython/pull/20143#discussion_r427808225) in GH-20143 for context.
Automerge-Triggered-By: @aeros
Diffstat (limited to 'Lib')
-rw-r--r-- | Lib/asyncio/threads.py | 8 | ||||
-rw-r--r-- | Lib/test/test_asyncio/test_threads.py | 14 |
2 files changed, 20 insertions, 2 deletions
diff --git a/Lib/asyncio/threads.py b/Lib/asyncio/threads.py index 2f40467..51e0ba9 100644 --- a/Lib/asyncio/threads.py +++ b/Lib/asyncio/threads.py @@ -1,6 +1,7 @@ """High-level support for working with threads in asyncio""" import functools +import contextvars from . import events @@ -12,10 +13,13 @@ async def to_thread(func, /, *args, **kwargs): """Asynchronously run function *func* in a separate thread. Any *args and **kwargs supplied for this function are directly passed - to *func*. + to *func*. Also, the current :class:`contextvars.Context` is propogated, + allowing context variables from the main thread to be accessed in the + separate thread. Return an asyncio.Future which represents the eventual result of *func*. """ loop = events.get_running_loop() - func_call = functools.partial(func, *args, **kwargs) + ctx = contextvars.copy_context() + func_call = functools.partial(ctx.run, func, *args, **kwargs) return await loop.run_in_executor(None, func_call) diff --git a/Lib/test/test_asyncio/test_threads.py b/Lib/test/test_asyncio/test_threads.py index 99a00f2..2af3224 100644 --- a/Lib/test/test_asyncio/test_threads.py +++ b/Lib/test/test_asyncio/test_threads.py @@ -3,6 +3,7 @@ import asyncio import unittest +from contextvars import ContextVar from unittest import mock from test.test_asyncio import utils as test_utils @@ -74,6 +75,19 @@ class ToThreadTests(test_utils.TestCase): self.loop.run_until_complete(main()) func.assert_called_once_with('test', something=True) + def test_to_thread_contextvars(self): + test_ctx = ContextVar('test_ctx') + + def get_ctx(): + return test_ctx.get() + + async def main(): + test_ctx.set('parrot') + return await asyncio.to_thread(get_ctx) + + result = self.loop.run_until_complete(main()) + self.assertEqual(result, 'parrot') + if __name__ == "__main__": unittest.main() |