summaryrefslogtreecommitdiffstats
path: root/Doc/library/asyncio-task.rst
diff options
context:
space:
mode:
authorKyle Stanley <aeros167@gmail.com>2020-05-21 05:20:43 (GMT)
committerGitHub <noreply@github.com>2020-05-21 05:20:43 (GMT)
commit0f56263e62ba91d0baae40fb98947a3a98034a73 (patch)
tree54ead06a73b5ff9b9603c3d19bf39732401280c8 /Doc/library/asyncio-task.rst
parent7efb826c3e54edf10315e4baf5e96fe9a3729da4 (diff)
downloadcpython-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 'Doc/library/asyncio-task.rst')
-rw-r--r--Doc/library/asyncio-task.rst6
1 files changed, 5 insertions, 1 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index 7c27040..dd94c14 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -610,7 +610,9 @@ Running in Threads
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 event loop thread to be accessed in the
+ separate thread.
Return an :class:`asyncio.Future` which represents the eventual result of
*func*.
@@ -657,6 +659,8 @@ Running in Threads
that release the GIL or alternative Python implementations that don't
have one, `asyncio.to_thread()` can also be used for CPU-bound functions.
+ .. versionadded:: 3.9
+
Scheduling From Other Threads
=============================