Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 1 | :mod:`asyncio` --- Asynchronous I/O |
| 2 | =================================== |
Guido van Rossum | 7a46564 | 2013-11-22 11:47:22 -0800 | [diff] [blame] | 3 | |
| 4 | .. module:: asyncio |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 5 | :synopsis: Asynchronous I/O. |
Terry Jan Reedy | fa089b9 | 2016-06-11 15:02:54 -0400 | [diff] [blame] | 6 | |
Guido van Rossum | f8d0ff9 | 2013-11-22 16:53:25 -0800 | [diff] [blame] | 7 | -------------- |
Guido van Rossum | 7a46564 | 2013-11-22 11:47:22 -0800 | [diff] [blame] | 8 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 9 | asyncio is a library to write **concurrent** code using |
| 10 | **async/await** syntax. |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 11 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 12 | asyncio is used as a foundation for multiple Python asynchronous |
| 13 | frameworks that provide high-performance network and web-servers, |
| 14 | database connection libraries, distributed task queues, etc. |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 15 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 16 | asyncio is often a perfect fit for IO-bound and high-level |
| 17 | **structured** network code. |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 18 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 19 | asyncio provides a set of **high-level** APIs to: |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 20 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 21 | * :ref:`run Python coroutines <coroutine>` concurrently and |
| 22 | have full control over their execution; |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 23 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 24 | * perform :ref:`network IO and IPC <asyncio-streams>`; |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 25 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 26 | * control :ref:`subprocesses <asyncio-subprocess>`; |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 27 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 28 | * distribute tasks via :ref:`queues <asyncio-queues>`; |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 29 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 30 | * :ref:`synchronize <asyncio-sync>` concurrent code; |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 31 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 32 | as well as **low-level** APIs for *library and framework developers* to: |
Guido van Rossum | f0f5d38 | 2013-11-22 15:45:02 -0800 | [diff] [blame] | 33 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 34 | * create and manage :ref:`event loops <asyncio-event-loop>`, which |
Yury Selivanov | 805e27e | 2018-09-14 16:57:11 -0700 | [diff] [blame^] | 35 | provide asynchronous APIs for :meth:`networking <loop.create_server>`, |
| 36 | running :meth:`subprocesses <loop.subprocess_exec>`, |
| 37 | handling :meth:`OS signals <loop.add_signal_handler>`, etc; |
Victor Stinner | 532c69a | 2015-02-25 14:23:51 +0100 | [diff] [blame] | 38 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 39 | * implement efficient protocols using |
| 40 | :ref:`transports <asyncio-transports-protocols>`; |
| 41 | |
| 42 | * :ref:`bridge <asyncio-futures>` callback-based libraries and code |
| 43 | with async/await syntax. |
| 44 | |
| 45 | |
Yury Selivanov | 7372c3b | 2018-09-14 15:11:24 -0700 | [diff] [blame] | 46 | Reference |
| 47 | --------- |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 48 | |
| 49 | .. rubric:: High-level APIs |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 50 | |
Victor Stinner | ea3183f | 2013-12-03 01:08:00 +0100 | [diff] [blame] | 51 | .. toctree:: |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 52 | :maxdepth: 1 |
| 53 | |
| 54 | asyncio-task.rst |
| 55 | asyncio-stream.rst |
| 56 | asyncio-sync.rst |
| 57 | asyncio-subprocess.rst |
| 58 | asyncio-queue.rst |
| 59 | asyncio-exceptions.rst |
| 60 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 61 | .. rubric:: Low-level APIs |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 62 | |
| 63 | .. toctree:: |
| 64 | :maxdepth: 1 |
Antoine Pitrou | bba8682 | 2013-11-23 00:34:26 +0100 | [diff] [blame] | 65 | |
Victor Stinner | ea3183f | 2013-12-03 01:08:00 +0100 | [diff] [blame] | 66 | asyncio-eventloop.rst |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 67 | asyncio-future.rst |
| 68 | asyncio-protocol.rst |
Yury Selivanov | 7c7605f | 2018-09-11 09:54:40 -0700 | [diff] [blame] | 69 | asyncio-policy.rst |
| 70 | asyncio-platforms.rst |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 71 | |
Yury Selivanov | 6c73164 | 2018-09-14 14:57:39 -0700 | [diff] [blame] | 72 | .. rubric:: Guides and Tutorials |
Yury Selivanov | 3faaa88 | 2018-09-14 13:32:07 -0700 | [diff] [blame] | 73 | |
| 74 | .. toctree:: |
| 75 | :maxdepth: 1 |
| 76 | |
Yury Selivanov | 7372c3b | 2018-09-14 15:11:24 -0700 | [diff] [blame] | 77 | asyncio-api-index.rst |
Victor Stinner | db39a0d | 2014-01-16 18:58:01 +0100 | [diff] [blame] | 78 | asyncio-dev.rst |