FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-104254: Document the optional keyword-only "context" argument to Task constructor by itamaro · Pull Request #104251 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-104254: Document the optional keyword-only "context" argument to Task constructor #104251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
gvanrossum merged 1 commit into from
May 7, 2023
Conversation 3 Commits 1 Checks 0 Files changed
Merged

gh-104254: Document the optional keyword-only "context" argument to Task constructor #104251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension .rst  (1) All 1 file type selected
Viewed files
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Unified
Split
Hide whitespace
Diff view
Unified
Split
Hide whitespace
12 changes: 8 additions & 4 deletions Doc/library/asyncio-task.rst
Show comments
View file
Open in desktop
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Original file line number Diff line number Diff line change
Expand Up @@ -1014,7 +1014,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.
Expand Down Expand Up @@ -1049,9 +1049,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.
Expand All @@ -1063,6 +1064,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*.
Expand Down
Back | FazBrowse Home | New Git URL