summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-05-06 21:22:23 -0700
committerGitHub <noreply@github.com>2023-05-07 09:52:23 +0530
commitefcd4bcb87a8a461ccf8f6038f75e638d86eeb8c (patch)
tree120f04afbdf9290a7ff22d65d86122e23949fcd9
parent8f23cadc4ca0c56e18c32985ae0c087e79633c0f (diff)
downloadcpython-git-efcd4bcb87a8a461ccf8f6038f75e638d86eeb8c.tar.gz
[3.11] gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251) (#104258)
gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251) (This was added in 3.11. It was already documented for `create_task()`, but not for `Task()`.) (cherry picked from commit 4ee2068c34bd45eddba7f6a8ee83f62d5b6932fc) Co-authored-by: Itamar Ostricher <itamarost@gmail.com>
-rw-r--r--Doc/library/asyncio-task.rst12
1 files changed, 8 insertions, 4 deletions
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
index bfefe8e381..550a84ebae 100644
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -967,7 +967,7 @@ Introspection
Task Object
===========
-.. class:: Task(coro, *, loop=None, name=None)
+.. class:: Task(coro, *, loop=None, name=None, context=None)
A :class:`Future-like <Future>` object that runs a Python
:ref:`coroutine <coroutine>`. Not thread-safe.
@@ -1002,9 +1002,10 @@ Task Object
APIs except :meth:`Future.set_result` and
:meth:`Future.set_exception`.
- Tasks support the :mod:`contextvars` module. When a Task
- is created it copies the current context and later runs its
- coroutine in the copied context.
+ An optional keyword-only *context* argument allows specifying a
+ custom :class:`contextvars.Context` for the *coro* to run in.
+ If no *context* is provided, the Task copies the current context
+ and later runs its coroutine in the copied context.
.. versionchanged:: 3.7
Added support for the :mod:`contextvars` module.
@@ -1016,6 +1017,9 @@ Task Object
Deprecation warning is emitted if *loop* is not specified
and there is no running event loop.
+ .. versionchanged:: 3.11
+ Added the *context* parameter.
+
.. method:: done()
Return ``True`` if the Task is *done*.