mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-10-01 21:02:15 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

[3.11] gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251) (#104258)

Browse source 
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 4ee2068c34)

Co-authored-by: Itamar Ostricher <itamarost@gmail.com>
This commit is contained in:
Miss Islington (bot) 2023-05-06 21:22:23 -07:00 • committed by GitHub
parent 8f23cadc4c
commit efcd4bcb87
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

12
Doc/library/asyncio-task.rst
View file

@ -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*.