This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Accept explicit contextvars.Context in asyncio create_task() API
Type: enhancement Stage: resolved
Components: asyncio Versions: Python 3.11
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: Nosy List: asvetlov, vstinner, yselivanov
Priority: normal Keywords: patch

Created on 2022-03-12 10:33 by asvetlov, last changed 2022-04-11 14:59 by admin. This issue is now closed.

Pull Requests
URL Status Linked Edit
PR 31837 merged asvetlov, 2022-03-12 10:35
Messages (4)
msg414988 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-03-12 10:33
Now asyncio creates a new context copy on task creation.

It is the perfect behavior *by default* and should stay as is.

However, sometimes passing an explicit context into a task and using back the context modified by task code is desired.

The most obvious use-case is testing: both unittest and pytest have multi-phase test initialization (asyncSetUp() methods and async fixtures correspondingly).  If asyncSetUp() updates context variable -- test code expects to see this change.

Currently, unittest runs the setup-test-cleanup chain in a single task and uses an internal queue to push a new coroutine for execution and get results back. It works but is cumbersome.

Another solution is to create a task per test execution step and wrap the task creation with Context.run(). The problem is in getting the updated context back. A task creates a context copy on starting, thus the modified context is stored in the task internal attribute only. To get it back a trampoline async function should be used, e.g.

async def wrapper(coro):
    try:
        return await coro
    finally:
        context = contextvars.copy_context()
        # store the context copy somewhere

Again, it looks more complicated as it should be.

The proposal is: 
1. Add 'context' keyword-only argument to asyncio.create_task() and loop.create_task().
2. Use this context if explicitly passed, create a copy of the current context otherwise.

The proposal is backward-compatible. Low-level API (call_soon(), call_later() etc.) already accept 'context' argument.

The attached PR demonstrates how the proposed API simplifies unittest.IsolatedAsyncioTestCase internals.
msg415101 - (view) Author: Yury Selivanov (yselivanov) * (Python committer) Date: 2022-03-13 20:51
Yeah, +1 to add a parameter. Fwiw it was on my idea list when i was working on the pep
msg415130 - (view) Author: Andrew Svetlov (asvetlov) * (Python committer) Date: 2022-03-14 11:54
New changeset 9523c0d84f351a610dc651b234461eb015fa3b82 by Andrew Svetlov in branch 'main':
bpo-46994: Accept explicit contextvars.Context in asyncio create_task() API (GH-31837)
https://github.com/python/cpython/commit/9523c0d84f351a610dc651b234461eb015fa3b82
msg415484 - (view) Author: STINNER Victor (vstinner) * (Python committer) Date: 2022-03-18 10:38
Nice enhancement!
History
Date User Action Args
2022-04-11 14:59:57adminsetgithub: 91150
2022-03-23 20:58:50asvetlovlinkissue40320 superseder
2022-03-18 10:38:39vstinnersetnosy: + vstinner
messages: + msg415484
2022-03-14 11:54:33asvetlovsetmessages: + msg415130
2022-03-14 11:54:32asvetlovsetstatus: open -> closed
resolution: fixed
stage: patch review -> resolved
2022-03-13 20:51:52yselivanovsetmessages: + msg415101
2022-03-12 10:35:20asvetlovsetkeywords: + patch
stage: patch review
pull_requests: + pull_request29936
2022-03-12 10:33:08asvetlovcreate