mirror of
https://github.com/python/cpython.git
synced 2025-09-26 18:29:57 +00:00
bpo-34793: Drop old-style context managers in asyncio.locks (GH-17533)
This commit is contained in:
parent
abb9a448de
commit
90d9ba6ef1
6 changed files with 50 additions and 223 deletions
|
@ -347,8 +347,8 @@ BoundedSemaphore
|
||||||
---------
|
---------
|
||||||
|
|
||||||
|
|
||||||
.. deprecated:: 3.7
|
.. versionchanged:: 3.9
|
||||||
|
|
||||||
Acquiring a lock using ``await lock`` or ``yield from lock`` and/or
|
Acquiring a lock using ``await lock`` or ``yield from lock`` and/or
|
||||||
:keyword:`with` statement (``with await lock``, ``with (yield from
|
:keyword:`with` statement (``with await lock``, ``with (yield from
|
||||||
lock)``) is deprecated. Use ``async with lock`` instead.
|
lock)``) was removed. Use ``async with lock`` instead.
|
||||||
|
|
|
@ -470,6 +470,11 @@ Removed
|
||||||
:exc:`DeprecationWarning` since Python 3.8.
|
:exc:`DeprecationWarning` since Python 3.8.
|
||||||
(Contributed by Inada Naoki in :issue:`39377`)
|
(Contributed by Inada Naoki in :issue:`39377`)
|
||||||
|
|
||||||
|
* ``with (await asyncio.lock):`` and ``with (yield from asyncio.lock):`` statements are
|
||||||
|
not longer supported, use ``async with lock`` instead. The same is correct for
|
||||||
|
``asyncio.Condition`` and ``asyncio.Semaphore``.
|
||||||
|
(Contributed by Andrew Svetlov in :issue:`34793`.)
|
||||||
|
|
||||||
|
|
||||||
Porting to Python 3.9
|
Porting to Python 3.9
|
||||||
=====================
|
=====================
|
||||||
|
|
|
@ -3,96 +3,13 @@
|
||||||
__all__ = ('Lock', 'Event', 'Condition', 'Semaphore', 'BoundedSemaphore')
|
__all__ = ('Lock', 'Event', 'Condition', 'Semaphore', 'BoundedSemaphore')
|
||||||
|
|
||||||
import collections
|
import collections
|
||||||
import types
|
|
||||||
import warnings
|
import warnings
|
||||||
|
|
||||||
from . import events
|
from . import events
|
||||||
from . import futures
|
|
||||||
from . import exceptions
|
from . import exceptions
|
||||||
from .import coroutines
|
|
||||||
|
|
||||||
|
|
||||||
class _ContextManager:
|
|
||||||
"""Context manager.
|
|
||||||
|
|
||||||
This enables the following idiom for acquiring and releasing a
|
|
||||||
lock around a block:
|
|
||||||
|
|
||||||
with (yield from lock):
|
|
||||||
<block>
|
|
||||||
|
|
||||||
while failing loudly when accidentally using:
|
|
||||||
|
|
||||||
with lock:
|
|
||||||
<block>
|
|
||||||
|
|
||||||
Deprecated, use 'async with' statement:
|
|
||||||
async with lock:
|
|
||||||
<block>
|
|
||||||
"""
|
|
||||||
|
|
||||||
def __init__(self, lock):
|
|
||||||
self._lock = lock
|
|
||||||
|
|
||||||
def __enter__(self):
|
|
||||||
# We have no use for the "as ..." clause in the with
|
|
||||||
# statement for locks.
|
|
||||||
return None
|
|
||||||
|
|
||||||
def __exit__(self, *args):
|
|
||||||
try:
|
|
||||||
self._lock.release()
|
|
||||||
finally:
|
|
||||||
self._lock = None # Crudely prevent reuse.
|
|
||||||
|
|
||||||
|
|
||||||
class _ContextManagerMixin:
|
class _ContextManagerMixin:
|
||||||
def __enter__(self):
|
|
||||||
raise RuntimeError(
|
|
||||||
'"yield from" should be used as context manager expression')
|
|
||||||
|
|
||||||
def __exit__(self, *args):
|
|
||||||
# This must exist because __enter__ exists, even though that
|
|
||||||
# always raises; that's how the with-statement works.
|
|
||||||
pass
|
|
||||||
|
|
||||||
@types.coroutine
|
|
||||||
def __iter__(self):
|
|
||||||
# This is not a coroutine. It is meant to enable the idiom:
|
|
||||||
#
|
|
||||||
# with (yield from lock):
|
|
||||||
# <block>
|
|
||||||
#
|
|
||||||
# as an alternative to:
|
|
||||||
#
|
|
||||||
# yield from lock.acquire()
|
|
||||||
# try:
|
|
||||||
# <block>
|
|
||||||
# finally:
|
|
||||||
# lock.release()
|
|
||||||
# Deprecated, use 'async with' statement:
|
|
||||||
# async with lock:
|
|
||||||
# <block>
|
|
||||||
warnings.warn("'with (yield from lock)' is deprecated "
|
|
||||||
"use 'async with lock' instead",
|
|
||||||
DeprecationWarning, stacklevel=2)
|
|
||||||
yield from self.acquire()
|
|
||||||
return _ContextManager(self)
|
|
||||||
|
|
||||||
# The flag is needed for legacy asyncio.iscoroutine()
|
|
||||||
__iter__._is_coroutine = coroutines._is_coroutine
|
|
||||||
|
|
||||||
async def __acquire_ctx(self):
|
|
||||||
await self.acquire()
|
|
||||||
return _ContextManager(self)
|
|
||||||
|
|
||||||
def __await__(self):
|
|
||||||
warnings.warn("'with await lock' is deprecated "
|
|
||||||
"use 'async with lock' instead",
|
|
||||||
DeprecationWarning, stacklevel=2)
|
|
||||||
# To make "with await lock" work.
|
|
||||||
return self.__acquire_ctx().__await__()
|
|
||||||
|
|
||||||
async def __aenter__(self):
|
async def __aenter__(self):
|
||||||
await self.acquire()
|
await self.acquire()
|
||||||
# We have no use for the "as ..." clause in the with
|
# We have no use for the "as ..." clause in the with
|
||||||
|
|
|
@ -47,13 +47,7 @@ class LockTests(test_utils.TestCase):
|
||||||
self.assertTrue(repr(lock).endswith('[unlocked]>'))
|
self.assertTrue(repr(lock).endswith('[unlocked]>'))
|
||||||
self.assertTrue(RGX_REPR.match(repr(lock)))
|
self.assertTrue(RGX_REPR.match(repr(lock)))
|
||||||
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
self.loop.run_until_complete(lock.acquire())
|
||||||
@asyncio.coroutine
|
|
||||||
def acquire_lock():
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
yield from lock
|
|
||||||
|
|
||||||
self.loop.run_until_complete(acquire_lock())
|
|
||||||
self.assertTrue(repr(lock).endswith('[locked]>'))
|
self.assertTrue(repr(lock).endswith('[locked]>'))
|
||||||
self.assertTrue(RGX_REPR.match(repr(lock)))
|
self.assertTrue(RGX_REPR.match(repr(lock)))
|
||||||
|
|
||||||
|
@ -61,18 +55,16 @@ class LockTests(test_utils.TestCase):
|
||||||
with self.assertWarns(DeprecationWarning):
|
with self.assertWarns(DeprecationWarning):
|
||||||
lock = asyncio.Lock(loop=self.loop)
|
lock = asyncio.Lock(loop=self.loop)
|
||||||
|
|
||||||
|
|
||||||
@asyncio.coroutine
|
@asyncio.coroutine
|
||||||
def acquire_lock():
|
def acquire_lock():
|
||||||
with self.assertWarns(DeprecationWarning):
|
return (yield from lock)
|
||||||
return (yield from lock)
|
|
||||||
|
|
||||||
res = self.loop.run_until_complete(acquire_lock())
|
with self.assertRaisesRegex(
|
||||||
|
TypeError,
|
||||||
|
"object is not iterable"
|
||||||
|
):
|
||||||
|
self.loop.run_until_complete(acquire_lock())
|
||||||
|
|
||||||
self.assertTrue(res)
|
|
||||||
self.assertTrue(lock.locked())
|
|
||||||
|
|
||||||
lock.release()
|
|
||||||
self.assertFalse(lock.locked())
|
self.assertFalse(lock.locked())
|
||||||
|
|
||||||
def test_lock_by_with_statement(self):
|
def test_lock_by_with_statement(self):
|
||||||
|
@ -90,13 +82,13 @@ class LockTests(test_utils.TestCase):
|
||||||
def test(lock):
|
def test(lock):
|
||||||
yield from asyncio.sleep(0.01)
|
yield from asyncio.sleep(0.01)
|
||||||
self.assertFalse(lock.locked())
|
self.assertFalse(lock.locked())
|
||||||
with self.assertWarns(DeprecationWarning):
|
with self.assertRaisesRegex(
|
||||||
with (yield from lock) as _lock:
|
TypeError,
|
||||||
self.assertIs(_lock, None)
|
"object is not iterable"
|
||||||
self.assertTrue(lock.locked())
|
):
|
||||||
yield from asyncio.sleep(0.01)
|
with (yield from lock):
|
||||||
self.assertTrue(lock.locked())
|
pass
|
||||||
self.assertFalse(lock.locked())
|
self.assertFalse(lock.locked())
|
||||||
|
|
||||||
for primitive in primitives:
|
for primitive in primitives:
|
||||||
loop.run_until_complete(test(primitive))
|
loop.run_until_complete(test(primitive))
|
||||||
|
@ -302,52 +294,16 @@ class LockTests(test_utils.TestCase):
|
||||||
self.assertFalse(lock.locked())
|
self.assertFalse(lock.locked())
|
||||||
|
|
||||||
def test_context_manager(self):
|
def test_context_manager(self):
|
||||||
with self.assertWarns(DeprecationWarning):
|
async def f():
|
||||||
lock = asyncio.Lock(loop=self.loop)
|
lock = asyncio.Lock()
|
||||||
|
self.assertFalse(lock.locked())
|
||||||
|
|
||||||
@asyncio.coroutine
|
async with lock:
|
||||||
def acquire_lock():
|
self.assertTrue(lock.locked())
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
return (yield from lock)
|
|
||||||
|
|
||||||
with self.loop.run_until_complete(acquire_lock()):
|
self.assertFalse(lock.locked())
|
||||||
self.assertTrue(lock.locked())
|
|
||||||
|
|
||||||
self.assertFalse(lock.locked())
|
self.loop.run_until_complete(f())
|
||||||
|
|
||||||
def test_context_manager_cant_reuse(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
lock = asyncio.Lock(loop=self.loop)
|
|
||||||
|
|
||||||
@asyncio.coroutine
|
|
||||||
def acquire_lock():
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
return (yield from lock)
|
|
||||||
|
|
||||||
# This spells "yield from lock" outside a generator.
|
|
||||||
cm = self.loop.run_until_complete(acquire_lock())
|
|
||||||
with cm:
|
|
||||||
self.assertTrue(lock.locked())
|
|
||||||
|
|
||||||
self.assertFalse(lock.locked())
|
|
||||||
|
|
||||||
with self.assertRaises(AttributeError):
|
|
||||||
with cm:
|
|
||||||
pass
|
|
||||||
|
|
||||||
def test_context_manager_no_yield(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
lock = asyncio.Lock(loop=self.loop)
|
|
||||||
|
|
||||||
try:
|
|
||||||
with lock:
|
|
||||||
self.fail('RuntimeError is not raised in with expression')
|
|
||||||
except RuntimeError as err:
|
|
||||||
self.assertEqual(
|
|
||||||
str(err),
|
|
||||||
'"yield from" should be used as context manager expression')
|
|
||||||
|
|
||||||
self.assertFalse(lock.locked())
|
|
||||||
|
|
||||||
|
|
||||||
class EventTests(test_utils.TestCase):
|
class EventTests(test_utils.TestCase):
|
||||||
|
@ -809,33 +765,14 @@ class ConditionTests(test_utils.TestCase):
|
||||||
self.assertTrue(RGX_REPR.match(repr(cond)))
|
self.assertTrue(RGX_REPR.match(repr(cond)))
|
||||||
|
|
||||||
def test_context_manager(self):
|
def test_context_manager(self):
|
||||||
with self.assertWarns(DeprecationWarning):
|
async def f():
|
||||||
cond = asyncio.Condition(loop=self.loop)
|
cond = asyncio.Condition()
|
||||||
|
self.assertFalse(cond.locked())
|
||||||
|
async with cond:
|
||||||
|
self.assertTrue(cond.locked())
|
||||||
|
self.assertFalse(cond.locked())
|
||||||
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
self.loop.run_until_complete(f())
|
||||||
@asyncio.coroutine
|
|
||||||
def acquire_cond():
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
return (yield from cond)
|
|
||||||
|
|
||||||
with self.loop.run_until_complete(acquire_cond()):
|
|
||||||
self.assertTrue(cond.locked())
|
|
||||||
|
|
||||||
self.assertFalse(cond.locked())
|
|
||||||
|
|
||||||
def test_context_manager_no_yield(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
cond = asyncio.Condition(loop=self.loop)
|
|
||||||
|
|
||||||
try:
|
|
||||||
with cond:
|
|
||||||
self.fail('RuntimeError is not raised in with expression')
|
|
||||||
except RuntimeError as err:
|
|
||||||
self.assertEqual(
|
|
||||||
str(err),
|
|
||||||
'"yield from" should be used as context manager expression')
|
|
||||||
|
|
||||||
self.assertFalse(cond.locked())
|
|
||||||
|
|
||||||
def test_explicit_lock(self):
|
def test_explicit_lock(self):
|
||||||
with self.assertWarns(DeprecationWarning):
|
with self.assertWarns(DeprecationWarning):
|
||||||
|
@ -920,16 +857,14 @@ class SemaphoreTests(test_utils.TestCase):
|
||||||
with self.assertWarns(DeprecationWarning):
|
with self.assertWarns(DeprecationWarning):
|
||||||
@asyncio.coroutine
|
@asyncio.coroutine
|
||||||
def acquire_lock():
|
def acquire_lock():
|
||||||
with self.assertWarns(DeprecationWarning):
|
return (yield from sem)
|
||||||
return (yield from sem)
|
|
||||||
|
|
||||||
res = self.loop.run_until_complete(acquire_lock())
|
with self.assertRaisesRegex(
|
||||||
|
TypeError,
|
||||||
|
"'Semaphore' object is not iterable",
|
||||||
|
):
|
||||||
|
self.loop.run_until_complete(acquire_lock())
|
||||||
|
|
||||||
self.assertTrue(res)
|
|
||||||
self.assertTrue(sem.locked())
|
|
||||||
self.assertEqual(0, sem._value)
|
|
||||||
|
|
||||||
sem.release()
|
|
||||||
self.assertFalse(sem.locked())
|
self.assertFalse(sem.locked())
|
||||||
self.assertEqual(1, sem._value)
|
self.assertEqual(1, sem._value)
|
||||||
|
|
||||||
|
@ -1064,38 +999,6 @@ class SemaphoreTests(test_utils.TestCase):
|
||||||
sem.release()
|
sem.release()
|
||||||
self.assertFalse(sem.locked())
|
self.assertFalse(sem.locked())
|
||||||
|
|
||||||
def test_context_manager(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
sem = asyncio.Semaphore(2, loop=self.loop)
|
|
||||||
|
|
||||||
@asyncio.coroutine
|
|
||||||
def acquire_lock():
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
return (yield from sem)
|
|
||||||
|
|
||||||
with self.loop.run_until_complete(acquire_lock()):
|
|
||||||
self.assertFalse(sem.locked())
|
|
||||||
self.assertEqual(1, sem._value)
|
|
||||||
|
|
||||||
with self.loop.run_until_complete(acquire_lock()):
|
|
||||||
self.assertTrue(sem.locked())
|
|
||||||
|
|
||||||
self.assertEqual(2, sem._value)
|
|
||||||
|
|
||||||
def test_context_manager_no_yield(self):
|
|
||||||
with self.assertWarns(DeprecationWarning):
|
|
||||||
sem = asyncio.Semaphore(2, loop=self.loop)
|
|
||||||
|
|
||||||
try:
|
|
||||||
with sem:
|
|
||||||
self.fail('RuntimeError is not raised in with expression')
|
|
||||||
except RuntimeError as err:
|
|
||||||
self.assertEqual(
|
|
||||||
str(err),
|
|
||||||
'"yield from" should be used as context manager expression')
|
|
||||||
|
|
||||||
self.assertEqual(2, sem._value)
|
|
||||||
|
|
||||||
|
|
||||||
if __name__ == '__main__':
|
if __name__ == '__main__':
|
||||||
unittest.main()
|
unittest.main()
|
||||||
|
|
|
@ -77,13 +77,12 @@ class LockTests(BaseTest):
|
||||||
async def test(lock):
|
async def test(lock):
|
||||||
await asyncio.sleep(0.01)
|
await asyncio.sleep(0.01)
|
||||||
self.assertFalse(lock.locked())
|
self.assertFalse(lock.locked())
|
||||||
with self.assertWarns(DeprecationWarning):
|
with self.assertRaisesRegex(
|
||||||
with await lock as _lock:
|
TypeError,
|
||||||
self.assertIs(_lock, None)
|
"can't be used in 'await' expression"
|
||||||
self.assertTrue(lock.locked())
|
):
|
||||||
await asyncio.sleep(0.01)
|
with await lock:
|
||||||
self.assertTrue(lock.locked())
|
pass
|
||||||
self.assertFalse(lock.locked())
|
|
||||||
|
|
||||||
for primitive in primitives:
|
for primitive in primitives:
|
||||||
self.loop.run_until_complete(test(primitive))
|
self.loop.run_until_complete(test(primitive))
|
||||||
|
|
|
@ -0,0 +1,3 @@
|
||||||
|
Remove support for ``with (await asyncio.lock):`` and ``with (yield from
|
||||||
|
asyncio.lock):``. The same is correct for ``asyncio.Condition`` and
|
||||||
|
``asyncio.Semaphore``.
|
Loading…
Add table
Add a link
Reference in a new issue