[Python-checkins] cpython (merge 3.5 -> default): Merge 3.5 (Issue #24487)

yury.selivanov python-checkins at python.org
Wed Jul 1 04:14:13 CEST 2015


https://hg.python.org/cpython/rev/3dc2a113e8a7
changeset:   96739:3dc2a113e8a7
parent:      96737:1b87b31434d8
parent:      96738:1b3be273e327
user:        Yury Selivanov <yselivanov at sprymix.com>
date:        Tue Jun 30 22:13:56 2015 -0400
summary:
  Merge 3.5 (Issue #24487)

files:
  Doc/library/asyncio-dev.rst       |  12 ++++++------
  Doc/library/asyncio-eventloop.rst |   2 +-
  Doc/library/asyncio-protocol.rst  |   6 +++---
  Doc/library/asyncio-task.rst      |   6 +++---
  4 files changed, 13 insertions(+), 13 deletions(-)


diff --git a/Doc/library/asyncio-dev.rst b/Doc/library/asyncio-dev.rst
--- a/Doc/library/asyncio-dev.rst
+++ b/Doc/library/asyncio-dev.rst
@@ -99,7 +99,7 @@
 :meth:`BaseEventLoop.call_soon_threadsafe` method should be used. Example to
 schedule a coroutine from a different thread::
 
-    loop.call_soon_threadsafe(asyncio.async, coro_func())
+    loop.call_soon_threadsafe(asyncio.ensure_future, coro_func())
 
 Most asyncio objects are not thread safe. You should only worry if you access
 objects outside the event loop. For example, to cancel a future, don't call
@@ -162,10 +162,10 @@
 ----------------------------------------
 
 When a coroutine function is called and its result is not passed to
-:func:`async` or to the :meth:`BaseEventLoop.create_task` method, the execution
-of the coroutine object will never be scheduled which is probably a bug.
-:ref:`Enable the debug mode of asyncio <asyncio-debug-mode>` to :ref:`log a
-warning <asyncio-logger>` to detect it.
+:func:`ensure_future` or to the :meth:`BaseEventLoop.create_task` method,
+the execution of the coroutine object will never be scheduled which is
+probably a bug.  :ref:`Enable the debug mode of asyncio <asyncio-debug-mode>`
+to :ref:`log a warning <asyncio-logger>` to detect it.
 
 Example with the bug::
 
@@ -184,7 +184,7 @@
       File "test.py", line 7, in <module>
         test()
 
-The fix is to call the :func:`async` function or the
+The fix is to call the :func:`ensure_future` function or the
 :meth:`BaseEventLoop.create_task` method with the coroutine object.
 
 .. seealso::
diff --git a/Doc/library/asyncio-eventloop.rst b/Doc/library/asyncio-eventloop.rst
--- a/Doc/library/asyncio-eventloop.rst
+++ b/Doc/library/asyncio-eventloop.rst
@@ -36,7 +36,7 @@
    Run until the :class:`Future` is done.
 
    If the argument is a :ref:`coroutine object <coroutine>`, it is wrapped by
-   :func:`async`.
+   :func:`ensure_future`.
 
    Return the Future's result, or raise its exception.
 
diff --git a/Doc/library/asyncio-protocol.rst b/Doc/library/asyncio-protocol.rst
--- a/Doc/library/asyncio-protocol.rst
+++ b/Doc/library/asyncio-protocol.rst
@@ -448,9 +448,9 @@
 Coroutines and protocols
 ------------------------
 
-Coroutines can be scheduled in a protocol method using :func:`async`, but there
-is no guarantee made about the execution order.  Protocols are not aware of
-coroutines created in protocol methods and so will not wait for them.
+Coroutines can be scheduled in a protocol method using :func:`ensure_future`,
+but there is no guarantee made about the execution order.  Protocols are not
+aware of coroutines created in protocol methods and so will not wait for them.
 
 To have a reliable execution order, use :ref:`stream objects <asyncio-streams>` in a
 coroutine with ``yield from``. For example, the :meth:`StreamWriter.drain`
diff --git a/Doc/library/asyncio-task.rst b/Doc/library/asyncio-task.rst
--- a/Doc/library/asyncio-task.rst
+++ b/Doc/library/asyncio-task.rst
@@ -59,7 +59,7 @@
 schedule its execution.  There are two basic ways to start it running:
 call ``await coroutine`` or ``yield from coroutine`` from another coroutine
 (assuming the other coroutine is already running!), or schedule its execution
-using the :func:`async` function or the :meth:`BaseEventLoop.create_task`
+using the :func:`ensure_future` function or the :meth:`BaseEventLoop.create_task`
 method.
 
 
@@ -85,7 +85,7 @@
     even if they are plain Python functions returning a :class:`Future`.
     This is intentional to have a freedom of tweaking the implementation
     of these functions in the future. If such a function is needed to be
-    used in a callback-style code, wrap its result with :func:`async`.
+    used in a callback-style code, wrap its result with :func:`ensure_future`.
 
 
 .. _asyncio-hello-world-coroutine:
@@ -394,7 +394,7 @@
    <coroutine>` did not complete. It is probably a bug and a warning is
    logged: see :ref:`Pending task destroyed <asyncio-pending-task-destroyed>`.
 
-   Don't directly create :class:`Task` instances: use the :func:`async`
+   Don't directly create :class:`Task` instances: use the :func:`ensure_future`
    function or the :meth:`BaseEventLoop.create_task` method.
 
    This class is :ref:`not thread safe <asyncio-multithreading>`.

-- 
Repository URL: https://hg.python.org/cpython


More information about the Python-checkins mailing list