Merge branch 'master' of https://github.com/asyncio-doc/asyncio-doc

Author: pya

README.rst

@@ -1,8 +1,8 @@
 Asyncio documentation
 =====================
 
-* Online doc: http://asyncio.readthedocs.io/
-* GitHub: https://github.com/haypo/asyncio-doc
+* Online doc: https://asyncio.readthedocs.io/
+* GitHub: https://github.com/asyncio-doc/asyncio-doc
 * AsyncIO documentation is written with `Sphinx <http://www.sphinx-doc.org/>`_.
 
 
@@ -50,4 +50,4 @@ See also
 
 * https://github.com/python/asyncio
 * http://krondo.com/an-introduction-to-asynchronous-programming-and-twisted/
-* http://curio.readthedocs.io/en/latest/tutorial.html
+* https://curio.readthedocs.io/en/latest/tutorial.html

conf.py

@@ -104,6 +104,9 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
 
+# The default language to highlight source code in.
+highlight_language = 'python3'
+
 # A list of ignored prefixes for module index sorting.
 # modindex_common_prefix = []
 

examples/producer_consumer_2.py renamed to examples/producer_consumer_join.py

@@ -0,0 +1,23 @@
+import asyncio
+
+
+async def run_command(*args):
+    # Create subprocess
+    process = await asyncio.create_subprocess_exec(
+        *args,
+        # stdout must a pipe to be accessible as process.stdout
+        stdout=asyncio.subprocess.PIPE)
+    # Wait for the subprocess to finish
+    stdout, stderr = await process.communicate()
+    # Return stdout
+    return stdout.decode().strip()
+
+
+loop = asyncio.get_event_loop()
+# Gather uname and date commands
+commands = asyncio.gather(run_command('uname'), run_command('date'))
+# Run the commands
+uname, date = loop.run_until_complete(commands)
+# Print a report
+print('uname: {}, date: {}'.format(uname, date))
+loop.close()

examples/subprocess_command.py

@@ -0,0 +1,27 @@
+import asyncio
+
+
+async def echo(msg):
+    # Run an echo subprocess
+    process = await asyncio.create_subprocess_exec(
+        'cat',
+        # stdin must a pipe to be accessible as process.stdin
+        stdin=asyncio.subprocess.PIPE,
+        # stdout must a pipe to be accessible as process.stdout
+        stdout=asyncio.subprocess.PIPE)
+    # Write message
+    print('Writing {!r} ...'.format(msg))
+    process.stdin.write(msg.encode() + b'\n')
+    # Read reply
+    data = await process.stdout.readline()
+    reply = data.decode().strip()
+    print('Received {!r}'.format(reply))
+    # Stop the subprocess
+    process.terminate()
+    code = await process.wait()
+    print('Terminated with code {}'.format(code))
+
+
+loop = asyncio.get_event_loop()
+loop.run_until_complete(echo('hello!'))
+loop.close()

examples/subprocess_echo.py

@@ -7,4 +7,4 @@ HTTP client example:
 .. literalinclude:: examples/http_client.py
 
 For more information, see `aiohttp documentation
-<http://aiohttp.readthedocs.io/>`_.
+<https://aiohttp.readthedocs.io/>`_.

http_client.rst

@@ -24,6 +24,7 @@ Chapter 2: Advanced topics
 
    tcp_echo.rst
    threads.rst
+   subprocess.rst
    producer_consumer.rst
    debug_mode.rst
 
@@ -66,4 +67,3 @@ Contributing
    :maxdepth: 2
 
    README.rst
-

index.rst

@@ -6,7 +6,7 @@ Simple example
 ==============
 
 A simple producer/consumer example, using an `asyncio.Queue
-<http://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue>`_:
+<https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue>`_:
 
 .. literalinclude:: examples/producer_consumer.py
 
@@ -16,11 +16,11 @@ Using task_done()
 
 
 A simple producer/consumer example, using `Queue.task_done
-<http://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.task_done>`_
+<https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.task_done>`_
 and `Queue.join
-<http://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.join>`_:
+<https://docs.python.org/3/library/asyncio-queue.html#asyncio.Queue.join>`_:
 
-.. literalinclude:: examples/producer_consumer_2.py
+.. literalinclude:: examples/producer_consumer_join.py
 
 For more information, see the `asyncio queue documentation
-<http://docs.python.org/3/library/asyncio-queue.html>`_.
+<https://docs.python.org/3/library/asyncio-queue.html>`_.

producer_consumer.rst

@@ -0,0 +1,28 @@
+++++++++++
+Subprocess
+++++++++++
+
+Run a subprocess and read its output
+====================================
+
+A simple example to run commands in a subprocess using
+`asyncio.create_subprocess_exec
+<https://docs.python.org/3.6/library/asyncio-subprocess.html#asyncio.create_subprocess_exec>`_
+and get the output using `process.communicate
+<https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.asyncio.subprocess.Process.communicate>`_:
+
+.. literalinclude:: examples/subprocess_command.py
+
+
+Communicate with a subprocess using standard streams
+====================================================
+
+A simple example to communicate with an echo subprocess using `process.stdin
+<https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.asyncio.subprocess.Process.stdin>`_
+and `process.stdout
+<https://docs.python.org/3/library/asyncio-subprocess.html#asyncio.asyncio.subprocess.Process.stdout>`_:
+
+.. literalinclude:: examples/subprocess_echo.py
+
+For more information, see the `asyncio subprocess documentation
+<https://docs.python.org/3/library/asyncio-subprocess.html>`_.

subprocess.rst

@@ -362,7 +362,7 @@ Install with::
     $ pip install aiohttp
 
 
-.. _aiohttp: http://aiohttp.readthedocs.io/en/stable/
+.. _aiohttp: https://aiohttp.readthedocs.io/en/stable/
 
 The whole program looks like this: