]> granicus.if.org Git - python/commit
bpo-32751: Wait for task cancellation in asyncio.wait_for() (GH-7216)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Tue, 29 May 2018 22:37:06 +0000 (15:37 -0700)
committerGitHub <noreply@github.com>
Tue, 29 May 2018 22:37:06 +0000 (15:37 -0700)
commitd8948c5e09c4a2a818f6f6cfaf8064f2c2138fa5
tree4cb03137cd202c0f271537eeff93234039b4bfb4
parent036434273e6f6905403432c973d98ade1ae58197
bpo-32751: Wait for task cancellation in asyncio.wait_for() (GH-7216)

Currently, asyncio.wait_for(fut), upon reaching the timeout deadline,
cancels the future and returns immediately.  This is problematic for
when *fut* is a Task, because it will be left running for an arbitrary
amount of time.  This behavior is iself surprising and may lead to
related bugs such as the one described in bpo-33638:

    condition = asyncio.Condition()
    async with condition:
        await asyncio.wait_for(condition.wait(), timeout=0.5)

Currently, instead of raising a TimeoutError, the above code will fail
with `RuntimeError: cannot wait on un-acquired lock`, because
`__aexit__` is reached _before_ `condition.wait()` finishes its
cancellation and re-acquires the condition lock.

To resolve this, make `wait_for` await for the task cancellation.
The tradeoff here is that the `timeout` promise may be broken if the
task decides to handle its cancellation in a slow way.  This represents
a behavior change and should probably not be back-patched to 3.6 and
earlier.
(cherry picked from commit e2b340ab4196e1beb902327f503574b5d7369185)

Co-authored-by: Elvis Pranskevichus <elvis@magic.io>
Doc/library/asyncio-task.rst
Lib/asyncio/tasks.py
Lib/test/test_asyncio/test_locks.py
Lib/test/test_asyncio/test_tasks.py
Misc/NEWS.d/next/Library/2018-05-29-15-32-18.bpo-32751.oBTqr7.rst [new file with mode: 0644]