[Python-checkins] cpython (3.4): asyncio: async() function is deprecated in favour of ensure_future().
yury.selivanov
python-checkins at python.org
Mon May 11 20:50:48 CEST 2015
https://hg.python.org/cpython/rev/b78127eafad7
changeset: 95956:b78127eafad7
branch: 3.4
parent: 95953:a983d63e3321
user: Yury Selivanov <yselivanov at sprymix.com>
date: Mon May 11 14:48:38 2015 -0400
summary:
asyncio: async() function is deprecated in favour of ensure_future().
files:
Lib/asyncio/base_events.py | 2 +-
Lib/asyncio/tasks.py | 27 ++++-
Lib/asyncio/windows_events.py | 2 +-
Lib/test/test_asyncio/test_base_events.py | 6 +-
Lib/test/test_asyncio/test_tasks.py | 48 +++++----
Lib/test/test_asyncio/test_windows_events.py | 2 +-
Misc/NEWS | 4 +-
7 files changed, 57 insertions(+), 34 deletions(-)
diff --git a/Lib/asyncio/base_events.py b/Lib/asyncio/base_events.py
--- a/Lib/asyncio/base_events.py
+++ b/Lib/asyncio/base_events.py
@@ -315,7 +315,7 @@
self._check_closed()
new_task = not isinstance(future, futures.Future)
- future = tasks.async(future, loop=self)
+ future = tasks.ensure_future(future, loop=self)
if new_task:
# An exception is raised if the future didn't complete, so there
# is no need to log the "destroy pending task" message
diff --git a/Lib/asyncio/tasks.py b/Lib/asyncio/tasks.py
--- a/Lib/asyncio/tasks.py
+++ b/Lib/asyncio/tasks.py
@@ -3,7 +3,7 @@
__all__ = ['Task',
'FIRST_COMPLETED', 'FIRST_EXCEPTION', 'ALL_COMPLETED',
'wait', 'wait_for', 'as_completed', 'sleep', 'async',
- 'gather', 'shield',
+ 'gather', 'shield', 'ensure_future',
]
import concurrent.futures
@@ -12,6 +12,7 @@
import linecache
import sys
import traceback
+import warnings
import weakref
from . import coroutines
@@ -327,7 +328,7 @@
if loop is None:
loop = events.get_event_loop()
- fs = {async(f, loop=loop) for f in set(fs)}
+ fs = {ensure_future(f, loop=loop) for f in set(fs)}
return (yield from _wait(fs, timeout, return_when, loop))
@@ -361,7 +362,7 @@
timeout_handle = loop.call_later(timeout, _release_waiter, waiter)
cb = functools.partial(_release_waiter, waiter)
- fut = async(fut, loop=loop)
+ fut = ensure_future(fut, loop=loop)
fut.add_done_callback(cb)
try:
@@ -449,7 +450,7 @@
if isinstance(fs, futures.Future) or coroutines.iscoroutine(fs):
raise TypeError("expect a list of futures, not %s" % type(fs).__name__)
loop = loop if loop is not None else events.get_event_loop()
- todo = {async(f, loop=loop) for f in set(fs)}
+ todo = {ensure_future(f, loop=loop) for f in set(fs)}
from .queues import Queue # Import here to avoid circular import problem.
done = Queue(loop=loop)
timeout_handle = None
@@ -500,6 +501,20 @@
"""Wrap a coroutine in a future.
If the argument is a Future, it is returned directly.
+
+ This function is deprecated in 3.5. Use asyncio.ensure_future() instead.
+ """
+
+ warnings.warn("asyncio.async() function is deprecated, use ensure_future()",
+ DeprecationWarning)
+
+ return ensure_future(coro_or_future, loop=loop)
+
+
+def ensure_future(coro_or_future, *, loop=None):
+ """Wrap a coroutine in a future.
+
+ If the argument is a Future, it is returned directly.
"""
if isinstance(coro_or_future, futures.Future):
if loop is not None and loop is not coro_or_future._loop:
@@ -564,7 +579,7 @@
arg_to_fut = {}
for arg in set(coros_or_futures):
if not isinstance(arg, futures.Future):
- fut = async(arg, loop=loop)
+ fut = ensure_future(arg, loop=loop)
if loop is None:
loop = fut._loop
# The caller cannot control this future, the "destroy pending task"
@@ -640,7 +655,7 @@
except CancelledError:
res = None
"""
- inner = async(arg, loop=loop)
+ inner = ensure_future(arg, loop=loop)
if inner.done():
# Shortcut.
return inner
diff --git a/Lib/asyncio/windows_events.py b/Lib/asyncio/windows_events.py
--- a/Lib/asyncio/windows_events.py
+++ b/Lib/asyncio/windows_events.py
@@ -488,7 +488,7 @@
future = self._register(ov, listener, finish_accept)
coro = accept_coro(future, conn)
- tasks.async(coro, loop=self._loop)
+ tasks.ensure_future(coro, loop=self._loop)
return future
def connect(self, conn, address):
diff --git a/Lib/test/test_asyncio/test_base_events.py b/Lib/test/test_asyncio/test_base_events.py
--- a/Lib/test/test_asyncio/test_base_events.py
+++ b/Lib/test/test_asyncio/test_base_events.py
@@ -504,7 +504,7 @@
# Test Future.__del__
with mock.patch('asyncio.base_events.logger') as log:
- fut = asyncio.async(zero_error_coro(), loop=self.loop)
+ fut = asyncio.ensure_future(zero_error_coro(), loop=self.loop)
fut.add_done_callback(lambda *args: self.loop.stop())
self.loop.run_forever()
fut = None # Trigger Future.__del__ or futures._TracebackLogger
@@ -703,7 +703,7 @@
self.set_event_loop(loop)
coro = test()
- task = asyncio.async(coro, loop=loop)
+ task = asyncio.ensure_future(coro, loop=loop)
self.assertIsInstance(task, MyTask)
# make warnings quiet
@@ -1265,7 +1265,7 @@
"took .* seconds$")
# slow task
- asyncio.async(stop_loop_coro(self.loop), loop=self.loop)
+ asyncio.ensure_future(stop_loop_coro(self.loop), loop=self.loop)
self.loop.run_forever()
fmt, *args = m_logger.warning.call_args[0]
self.assertRegex(fmt % tuple(args),
diff --git a/Lib/test/test_asyncio/test_tasks.py b/Lib/test/test_asyncio/test_tasks.py
--- a/Lib/test/test_asyncio/test_tasks.py
+++ b/Lib/test/test_asyncio/test_tasks.py
@@ -92,11 +92,11 @@
loop.run_until_complete(t)
loop.close()
- def test_async_coroutine(self):
+ def test_ensure_future_coroutine(self):
@asyncio.coroutine
def notmuch():
return 'ok'
- t = asyncio.async(notmuch(), loop=self.loop)
+ t = asyncio.ensure_future(notmuch(), loop=self.loop)
self.loop.run_until_complete(t)
self.assertTrue(t.done())
self.assertEqual(t.result(), 'ok')
@@ -104,16 +104,16 @@
loop = asyncio.new_event_loop()
self.set_event_loop(loop)
- t = asyncio.async(notmuch(), loop=loop)
+ t = asyncio.ensure_future(notmuch(), loop=loop)
self.assertIs(t._loop, loop)
loop.run_until_complete(t)
loop.close()
- def test_async_future(self):
+ def test_ensure_future_future(self):
f_orig = asyncio.Future(loop=self.loop)
f_orig.set_result('ko')
- f = asyncio.async(f_orig)
+ f = asyncio.ensure_future(f_orig)
self.loop.run_until_complete(f)
self.assertTrue(f.done())
self.assertEqual(f.result(), 'ko')
@@ -123,19 +123,19 @@
self.set_event_loop(loop)
with self.assertRaises(ValueError):
- f = asyncio.async(f_orig, loop=loop)
+ f = asyncio.ensure_future(f_orig, loop=loop)
loop.close()
- f = asyncio.async(f_orig, loop=self.loop)
+ f = asyncio.ensure_future(f_orig, loop=self.loop)
self.assertIs(f, f_orig)
- def test_async_task(self):
+ def test_ensure_future_task(self):
@asyncio.coroutine
def notmuch():
return 'ok'
t_orig = asyncio.Task(notmuch(), loop=self.loop)
- t = asyncio.async(t_orig)
+ t = asyncio.ensure_future(t_orig)
self.loop.run_until_complete(t)
self.assertTrue(t.done())
self.assertEqual(t.result(), 'ok')
@@ -145,16 +145,22 @@
self.set_event_loop(loop)
with self.assertRaises(ValueError):
- t = asyncio.async(t_orig, loop=loop)
+ t = asyncio.ensure_future(t_orig, loop=loop)
loop.close()
- t = asyncio.async(t_orig, loop=self.loop)
+ t = asyncio.ensure_future(t_orig, loop=self.loop)
self.assertIs(t, t_orig)
- def test_async_neither(self):
+ def test_ensure_future_neither(self):
with self.assertRaises(TypeError):
- asyncio.async('ok')
+ asyncio.ensure_future('ok')
+
+ def test_async_warning(self):
+ f = asyncio.Future(loop=self.loop)
+ with self.assertWarnsRegex(DeprecationWarning,
+ 'function is deprecated, use ensure_'):
+ self.assertIs(f, asyncio.async(f))
def test_task_repr(self):
self.loop.set_debug(False)
@@ -1420,7 +1426,7 @@
else:
proof += 10
- f = asyncio.async(outer(), loop=self.loop)
+ f = asyncio.ensure_future(outer(), loop=self.loop)
test_utils.run_briefly(self.loop)
f.cancel()
self.loop.run_until_complete(f)
@@ -1445,7 +1451,7 @@
d, p = yield from asyncio.wait([inner()], loop=self.loop)
proof += 100
- f = asyncio.async(outer(), loop=self.loop)
+ f = asyncio.ensure_future(outer(), loop=self.loop)
test_utils.run_briefly(self.loop)
f.cancel()
self.assertRaises(
@@ -1501,7 +1507,7 @@
yield from asyncio.shield(inner(), loop=self.loop)
proof += 100
- f = asyncio.async(outer(), loop=self.loop)
+ f = asyncio.ensure_future(outer(), loop=self.loop)
test_utils.run_briefly(self.loop)
f.cancel()
with self.assertRaises(asyncio.CancelledError):
@@ -1668,7 +1674,7 @@
# schedule the task
coro = kill_me(self.loop)
- task = asyncio.async(coro, loop=self.loop)
+ task = asyncio.ensure_future(coro, loop=self.loop)
self.assertEqual(asyncio.Task.all_tasks(loop=self.loop), {task})
# execute the task so it waits for future
@@ -1996,8 +2002,8 @@
yield from waiter
proof += 1
- child1 = asyncio.async(inner(), loop=self.one_loop)
- child2 = asyncio.async(inner(), loop=self.one_loop)
+ child1 = asyncio.ensure_future(inner(), loop=self.one_loop)
+ child2 = asyncio.ensure_future(inner(), loop=self.one_loop)
gatherer = None
@asyncio.coroutine
@@ -2007,7 +2013,7 @@
yield from gatherer
proof += 100
- f = asyncio.async(outer(), loop=self.one_loop)
+ f = asyncio.ensure_future(outer(), loop=self.one_loop)
test_utils.run_briefly(self.one_loop)
self.assertTrue(f.cancel())
with self.assertRaises(asyncio.CancelledError):
@@ -2034,7 +2040,7 @@
def outer():
yield from asyncio.gather(inner(a), inner(b), loop=self.one_loop)
- f = asyncio.async(outer(), loop=self.one_loop)
+ f = asyncio.ensure_future(outer(), loop=self.one_loop)
test_utils.run_briefly(self.one_loop)
a.set_result(None)
test_utils.run_briefly(self.one_loop)
diff --git a/Lib/test/test_asyncio/test_windows_events.py b/Lib/test/test_asyncio/test_windows_events.py
--- a/Lib/test/test_asyncio/test_windows_events.py
+++ b/Lib/test/test_asyncio/test_windows_events.py
@@ -37,7 +37,7 @@
def test_close(self):
a, b = self.loop._socketpair()
trans = self.loop._make_socket_transport(a, asyncio.Protocol())
- f = asyncio.async(self.loop.sock_recv(b, 100))
+ f = asyncio.ensure_future(self.loop.sock_recv(b, 100))
trans.close()
self.loop.run_until_complete(f)
self.assertEqual(f.result(), b'')
diff --git a/Misc/NEWS b/Misc/NEWS
--- a/Misc/NEWS
+++ b/Misc/NEWS
@@ -42,7 +42,9 @@
- Issue #21354: PyCFunction_New function is exposed by python DLL again.
-- asyncio: New event loop APIs: set_task_factory() and get_task_factory()
+- asyncio: New event loop APIs: set_task_factory() and get_task_factory().
+
+- asyncio: async() function is deprecated in favour of ensure_future().
Library
-------
--
Repository URL: https://hg.python.org/cpython
More information about the Python-checkins
mailing list