blob: 06f673be7902c274423f5371b01cabf3a6be118e [file] [log] [blame]
R David Murray6a143812013-12-20 14:37:39 -05001.. currentmodule:: asyncio
Victor Stinnerea3183f2013-12-03 01:08:00 +01002
Yury Selivanov7c7605f2018-09-11 09:54:40 -07003
4==========
5Event Loop
6==========
7
8
9.. rubric:: Preface
10
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040011The event loop is the core of every asyncio application.
Yury Selivanov7c7605f2018-09-11 09:54:40 -070012Event loops run asynchronous tasks and callbacks, perform network
Carol Willing5b7cbd62018-09-12 17:05:17 -070013IO operations, and run subprocesses.
Yury Selivanov7c7605f2018-09-11 09:54:40 -070014
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040015Application developers should typically use the high-level asyncio functions,
16such as :func:`asyncio.run`, and should rarely need to reference the loop
17object or call its methods. This section is intended mostly for authors
18of lower-level code, libraries, and frameworks, who need finer control over
19the event loop behavior.
Yury Selivanov7c7605f2018-09-11 09:54:40 -070020
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040021.. rubric:: Obtaining the Event Loop
Yury Selivanov7c7605f2018-09-11 09:54:40 -070022
23The following low-level functions can be used to get, set, or create
24an event loop:
25
26.. function:: get_running_loop()
27
28 Return the running event loop in the current OS thread.
29
30 If there is no running event loop a :exc:`RuntimeError` is raised.
31 This function can only be called from a coroutine or a callback.
32
33 .. versionadded:: 3.7
34
35.. function:: get_event_loop()
36
37 Get the current event loop. If there is no current event loop set
38 in the current OS thread and :func:`set_event_loop` has not yet
39 been called, asyncio will create a new event loop and set it as the
40 current one.
41
Carol Willing5b7cbd62018-09-12 17:05:17 -070042 Because this function has rather complex behavior (especially
43 when custom event loop policies are in use), using the
44 :func:`get_running_loop` function is preferred to :func:`get_event_loop`
45 in coroutines and callbacks.
Yury Selivanov7c7605f2018-09-11 09:54:40 -070046
Carol Willing5b7cbd62018-09-12 17:05:17 -070047 Consider also using the :func:`asyncio.run` function instead of using
48 lower level functions to manually create and close an event loop.
Yury Selivanov7c7605f2018-09-11 09:54:40 -070049
50.. function:: set_event_loop(loop)
51
52 Set *loop* as a current event loop for the current OS thread.
53
54.. function:: new_event_loop()
55
56 Create a new event loop object.
57
58Note that the behaviour of :func:`get_event_loop`, :func:`set_event_loop`,
59and :func:`new_event_loop` functions can be altered by
60:ref:`setting a custom event loop policy <asyncio-policies>`.
61
62
63.. rubric:: Contents
64
65This documentation page contains the following sections:
66
Carol Willing5b7cbd62018-09-12 17:05:17 -070067* The `Event Loop Methods`_ section is the reference documentation of
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040068 the event loop APIs;
Yury Selivanov7c7605f2018-09-11 09:54:40 -070069
70* The `Callback Handles`_ section documents the :class:`Handle` and
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040071 :class:`TimerHandle` instances which are returned from scheduling
72 methods such as :meth:`loop.call_soon` and :meth:`loop.call_later`;
Yury Selivanov7c7605f2018-09-11 09:54:40 -070073
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040074* The `Server Objects`_ section documents types returned from
Yury Selivanov7c7605f2018-09-11 09:54:40 -070075 event loop methods like :meth:`loop.create_server`;
76
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -040077* The `Event Loop Implementations`_ section documents the
Yury Selivanov7c7605f2018-09-11 09:54:40 -070078 :class:`SelectorEventLoop` and :class:`ProactorEventLoop` classes;
79
80* The `Examples`_ section showcases how to work with some event
81 loop APIs.
82
83
Victor Stinner9592edb2014-02-02 15:03:02 +010084.. _asyncio-event-loop:
Victor Stinnerea3183f2013-12-03 01:08:00 +010085
Yury Selivanov7c7605f2018-09-11 09:54:40 -070086Event Loop Methods
87==================
Victor Stinnerea3183f2013-12-03 01:08:00 +010088
Carol Willing5b7cbd62018-09-12 17:05:17 -070089Event loops have **low-level** APIs for the following:
lf627d2c82017-07-25 17:03:51 -060090
Yury Selivanov7c7605f2018-09-11 09:54:40 -070091.. contents::
92 :depth: 1
93 :local:
Victor Stinnerea3183f2013-12-03 01:08:00 +010094
Victor Stinnerea3183f2013-12-03 01:08:00 +010095
Yury Selivanov7c7605f2018-09-11 09:54:40 -070096Running and stopping the loop
97^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +010098
Yury Selivanov7c7605f2018-09-11 09:54:40 -070099.. method:: loop.run_until_complete(future)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100100
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400101 Run until the *future* (an instance of :class:`Future`) has
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700102 completed.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100103
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700104 If the argument is a :ref:`coroutine object <coroutine>` it
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400105 is implicitly scheduled to run as a :class:`asyncio.Task`.
Eli Bendersky136fea22014-02-09 06:55:58 -0800106
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700107 Return the Future's result or raise its exception.
Guido van Rossumf68afd82016-08-08 09:41:21 -0700108
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700109.. method:: loop.run_forever()
Guido van Rossumf68afd82016-08-08 09:41:21 -0700110
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700111 Run the event loop until :meth:`stop` is called.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100112
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700113 If :meth:`stop` is called before :meth:`run_forever()` is called,
114 the loop will poll the I/O selector once with a timeout of zero,
115 run all callbacks scheduled in response to I/O events (and
116 those that were already scheduled), and then exit.
Victor Stinner83704962015-02-25 14:24:15 +0100117
Guido van Rossum41f69f42015-11-19 13:28:47 -0800118 If :meth:`stop` is called while :meth:`run_forever` is running,
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700119 the loop will run the current batch of callbacks and then exit.
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400120 Note that new callbacks scheduled by callbacks will not run in this
Carol Willing5b7cbd62018-09-12 17:05:17 -0700121 case; instead, they will run the next time :meth:`run_forever` or
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700122 :meth:`run_until_complete` is called.
Guido van Rossum41f69f42015-11-19 13:28:47 -0800123
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700124.. method:: loop.stop()
Victor Stinnerea3183f2013-12-03 01:08:00 +0100125
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700126 Stop the event loop.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100127
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700128.. method:: loop.is_running()
Victor Stinnerea3183f2013-12-03 01:08:00 +0100129
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700130 Return ``True`` if the event loop is currently running.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100131
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700132.. method:: loop.is_closed()
Victor Stinnerea3183f2013-12-03 01:08:00 +0100133
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700134 Return ``True`` if the event loop was closed.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100135
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700136.. method:: loop.close()
Victor Stinnerea3183f2013-12-03 01:08:00 +0100137
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700138 Close the event loop.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100139
Andriy Maletskyb83d9172018-10-29 23:39:21 +0200140 The loop must not be running when this function is called.
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700141 Any pending callbacks will be discarded.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100142
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700143 This method clears all queues and shuts down the executor, but does
144 not wait for the executor to finish.
Guido van Rossum41f69f42015-11-19 13:28:47 -0800145
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700146 This method is idempotent and irreversible. No other methods
147 should be called after the event loop is closed.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100148
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700149.. coroutinemethod:: loop.shutdown_asyncgens()
Yury Selivanov03660042016-12-15 17:36:05 -0500150
151 Schedule all currently open :term:`asynchronous generator` objects to
152 close with an :meth:`~agen.aclose()` call. After calling this method,
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700153 the event loop will issue a warning if a new asynchronous generator
Carol Willing5b7cbd62018-09-12 17:05:17 -0700154 is iterated. This should be used to reliably finalize all scheduled
Yury Selivanovac94e382018-09-17 23:58:00 -0400155 asynchronous generators.
Carol Willing5b7cbd62018-09-12 17:05:17 -0700156
Yury Selivanovac94e382018-09-17 23:58:00 -0400157 Note that there is no need to call this function when
158 :func:`asyncio.run` is used.
159
160 Example::
Yury Selivanov03660042016-12-15 17:36:05 -0500161
162 try:
163 loop.run_forever()
164 finally:
165 loop.run_until_complete(loop.shutdown_asyncgens())
166 loop.close()
167
168 .. versionadded:: 3.6
169
170
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700171Scheduling callbacks
172^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +0100173
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700174.. method:: loop.call_soon(callback, *args, context=None)
Victor Stinner8464c242014-11-28 13:15:41 +0100175
Carol Willing5b7cbd62018-09-12 17:05:17 -0700176 Schedule a *callback* to be called with *args* arguments at
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700177 the next iteration of the event loop.
Victor Stinner8464c242014-11-28 13:15:41 +0100178
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700179 Callbacks are called in the order in which they are registered.
180 Each callback will be called exactly once.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100181
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700182 An optional keyword-only *context* argument allows specifying a
183 custom :class:`contextvars.Context` for the *callback* to run in.
184 The current context is used when no *context* is provided.
Yury Selivanov28b91782018-05-23 13:35:04 -0400185
Yury Selivanov1096f762015-06-25 13:49:52 -0400186 An instance of :class:`asyncio.Handle` is returned, which can be
Carol Willing5b7cbd62018-09-12 17:05:17 -0700187 used later to cancel the callback.
188
189 This method is not thread-safe.
Yury Selivanov43ee1c12014-02-19 20:58:44 -0500190
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700191.. method:: loop.call_soon_threadsafe(callback, *args, context=None)
Victor Stinner8464c242014-11-28 13:15:41 +0100192
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700193 A thread-safe variant of :meth:`call_soon`. Must be used to
194 schedule callbacks *from another thread*.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100195
Victor Stinner83704962015-02-25 14:24:15 +0100196 See the :ref:`concurrency and multithreading <asyncio-multithreading>`
197 section of the documentation.
198
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700199.. versionchanged:: 3.7
200 The *context* keyword-only parameter was added. See :pep:`567`
201 for more details.
202
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400203.. _asyncio-pass-keywords:
204
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700205.. note::
206
Carol Willing5b7cbd62018-09-12 17:05:17 -0700207 Most :mod:`asyncio` scheduling functions don't allow passing
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400208 keyword arguments. To do that, use :func:`functools.partial`::
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700209
Carol Willing5b7cbd62018-09-12 17:05:17 -0700210 # will schedule "print("Hello", flush=True)"
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700211 loop.call_soon(
212 functools.partial(print, "Hello", flush=True))
213
214 Using partial objects is usually more convenient than using lambdas,
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400215 as asyncio can render partial objects better in debug and error
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700216 messages.
Yury Selivanov28b91782018-05-23 13:35:04 -0400217
Victor Stinnerea3183f2013-12-03 01:08:00 +0100218
Victor Stinner45b27ed2014-02-01 02:36:43 +0100219.. _asyncio-delayed-calls:
220
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700221Scheduling delayed callbacks
222^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +0100223
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700224Event loop provides mechanisms to schedule callback functions
225to be called at some point in the future. Event loop uses monotonic
226clocks to track time.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100227
Victor Stinner45b27ed2014-02-01 02:36:43 +0100228
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700229.. method:: loop.call_later(delay, callback, *args, context=None)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100230
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700231 Schedule *callback* to be called after the given *delay*
232 number of seconds (can be either an int or a float).
Victor Stinnerea3183f2013-12-03 01:08:00 +0100233
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700234 An instance of :class:`asyncio.TimerHandle` is returned which can
235 be used to cancel the callback.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100236
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700237 *callback* will be called exactly once. If two callbacks are
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400238 scheduled for exactly the same time, the order in which they
239 are called is undefined.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100240
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700241 The optional positional *args* will be passed to the callback when
242 it is called. If you want the callback to be called with keyword
243 arguments use :func:`functools.partial`.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100244
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700245 An optional keyword-only *context* argument allows specifying a
246 custom :class:`contextvars.Context` for the *callback* to run in.
247 The current context is used when no *context* is provided.
Victor Stinner8464c242014-11-28 13:15:41 +0100248
Yury Selivanov28b91782018-05-23 13:35:04 -0400249 .. versionchanged:: 3.7
250 The *context* keyword-only parameter was added. See :pep:`567`
251 for more details.
252
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400253 .. versionchanged:: 3.8
254 In Python 3.7 and earlier with the default event loop implementation,
255 the *delay* could not exceed one day.
256 This has been fixed in Python 3.8.
257
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700258.. method:: loop.call_at(when, callback, *args, context=None)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100259
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700260 Schedule *callback* to be called at the given absolute timestamp
261 *when* (an int or a float), using the same time reference as
262 :meth:`loop.time`.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100263
264 This method's behavior is the same as :meth:`call_later`.
265
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700266 An instance of :class:`asyncio.TimerHandle` is returned which can
267 be used to cancel the callback.
Victor Stinner8464c242014-11-28 13:15:41 +0100268
Yury Selivanov28b91782018-05-23 13:35:04 -0400269 .. versionchanged:: 3.7
270 The *context* keyword-only parameter was added. See :pep:`567`
271 for more details.
272
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400273 .. versionchanged:: 3.8
274 In Python 3.7 and earlier with the default event loop implementation,
275 the difference between *when* and the current time could not exceed
276 one day. This has been fixed in Python 3.8.
277
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700278.. method:: loop.time()
Victor Stinnerea3183f2013-12-03 01:08:00 +0100279
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700280 Return the current time, as a :class:`float` value, according to
281 the event loop's internal monotonic clock.
282
283.. note::
Enrico Alarico Carbognani7e954e72019-04-18 14:43:14 +0200284 .. versionchanged:: 3.8
285 In Python 3.7 and earlier timeouts (relative *delay* or absolute *when*)
286 should not exceed one day. This has been fixed in Python 3.8.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100287
Victor Stinner3e09e322013-12-03 01:22:06 +0100288.. seealso::
289
290 The :func:`asyncio.sleep` function.
291
Victor Stinnerea3183f2013-12-03 01:08:00 +0100292
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700293Creating Futures and Tasks
294^^^^^^^^^^^^^^^^^^^^^^^^^^
Yury Selivanov950204d2016-05-16 16:23:00 -0400295
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700296.. method:: loop.create_future()
Yury Selivanov950204d2016-05-16 16:23:00 -0400297
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700298 Create an :class:`asyncio.Future` object attached to the event loop.
Yury Selivanov950204d2016-05-16 16:23:00 -0400299
Carol Willing5b7cbd62018-09-12 17:05:17 -0700300 This is the preferred way to create Futures in asyncio. This lets
301 third-party event loops provide alternative implementations of
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700302 the Future object (with better performance or instrumentation).
Yury Selivanov950204d2016-05-16 16:23:00 -0400303
304 .. versionadded:: 3.5.2
305
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700306.. method:: loop.create_task(coro, \*, name=None)
Yury Selivanov950204d2016-05-16 16:23:00 -0400307
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700308 Schedule the execution of a :ref:`coroutine`.
309 Return a :class:`Task` object.
Victor Stinner530ef2f2014-07-08 12:39:10 +0200310
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700311 Third-party event loops can use their own subclass of :class:`Task`
312 for interoperability. In this case, the result type is a subclass
313 of :class:`Task`.
Victor Stinner530ef2f2014-07-08 12:39:10 +0200314
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700315 If the *name* argument is provided and not ``None``, it is set as
316 the name of the task using :meth:`Task.set_name`.
Victor Stinner530ef2f2014-07-08 12:39:10 +0200317
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300318 .. versionchanged:: 3.8
319 Added the ``name`` parameter.
320
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700321.. method:: loop.set_task_factory(factory)
Yury Selivanov71854612015-05-11 16:28:27 -0400322
323 Set a task factory that will be used by
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700324 :meth:`loop.create_task`.
Yury Selivanov71854612015-05-11 16:28:27 -0400325
326 If *factory* is ``None`` the default task factory will be set.
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400327 Otherwise, *factory* must be a *callable* with the signature matching
328 ``(loop, coro)``, where *loop* is a reference to the active
329 event loop, and *coro* is a coroutine object. The callable
330 must return a :class:`asyncio.Future`-compatible object.
Yury Selivanov71854612015-05-11 16:28:27 -0400331
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700332.. method:: loop.get_task_factory()
Yury Selivanov71854612015-05-11 16:28:27 -0400333
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700334 Return a task factory or ``None`` if the default one is in use.
Yury Selivanov71854612015-05-11 16:28:27 -0400335
Victor Stinner530ef2f2014-07-08 12:39:10 +0200336
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700337Opening network connections
338^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +0100339
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700340.. coroutinemethod:: loop.create_connection(protocol_factory, \
341 host=None, port=None, \*, ssl=None, \
342 family=0, proto=0, flags=0, sock=None, \
343 local_addr=None, server_hostname=None, \
344 ssl_handshake_timeout=None)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100345
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700346 Open a streaming transport connection to a given
347 address specified by *host* and *port*.
348
349 The socket family can be either :py:data:`~socket.AF_INET` or
350 :py:data:`~socket.AF_INET6` depending on *host* (or the *family*
351 argument, if provided).
352
353 The socket type will be :py:data:`~socket.SOCK_STREAM`.
354
355 *protocol_factory* must be a callable returning an
356 :ref:`asyncio protocol <asyncio-protocol>` implementation.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100357
Yury Selivanov19a44f62017-12-14 20:53:26 -0500358 This method will try to establish the connection in the background.
359 When successful, it returns a ``(transport, protocol)`` pair.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100360
361 The chronological synopsis of the underlying operation is as follows:
362
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700363 #. The connection is established and a :ref:`transport <asyncio-transport>`
364 is created for it.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100365
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700366 #. *protocol_factory* is called without arguments and is expected to
367 return a :ref:`protocol <asyncio-protocol>` instance.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100368
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700369 #. The protocol instance is coupled with the transport by calling its
370 :meth:`~BaseProtocol.connection_made` method.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100371
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700372 #. A ``(transport, protocol)`` tuple is returned on success.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100373
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700374 The created transport is an implementation-dependent bidirectional
375 stream.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100376
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700377 Other arguments:
Victor Stinnerea3183f2013-12-03 01:08:00 +0100378
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400379 * *ssl*: if given and not false, a SSL/TLS transport is created
Victor Stinnerea3183f2013-12-03 01:08:00 +0100380 (by default a plain TCP transport is created). If *ssl* is
381 a :class:`ssl.SSLContext` object, this context is used to create
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400382 the transport; if *ssl* is :const:`True`, a default context returned
383 from :func:`ssl.create_default_context` is used.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100384
Berker Peksag9c1dba22014-09-28 00:00:58 +0300385 .. seealso:: :ref:`SSL/TLS security considerations <ssl-security>`
Antoine Pitrouc5e075f2014-03-22 18:19:11 +0100386
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400387 * *server_hostname* sets or overrides the hostname that the target
388 server's certificate will be matched against. Should only be passed
389 if *ssl* is not ``None``. By default the value of the *host* argument
Victor Stinnerea3183f2013-12-03 01:08:00 +0100390 is used. If *host* is empty, there is no default and you must pass a
391 value for *server_hostname*. If *server_hostname* is an empty
392 string, hostname matching is disabled (which is a serious security
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400393 risk, allowing for potential man-in-the-middle attacks).
Victor Stinnerea3183f2013-12-03 01:08:00 +0100394
395 * *family*, *proto*, *flags* are the optional address family, protocol
396 and flags to be passed through to getaddrinfo() for *host* resolution.
397 If given, these should all be integers from the corresponding
398 :mod:`socket` module constants.
399
twisteroid ambassador88f07a82019-05-05 19:14:35 +0800400 * *happy_eyeballs_delay*, if given, enables Happy Eyeballs for this
401 connection. It should
402 be a floating-point number representing the amount of time in seconds
403 to wait for a connection attempt to complete, before starting the next
404 attempt in parallel. This is the "Connection Attempt Delay" as defined
405 in :rfc:`8305`. A sensible default value recommended by the RFC is ``0.25``
406 (250 milliseconds).
407
408 * *interleave* controls address reordering when a host name resolves to
409 multiple IP addresses.
410 If ``0`` or unspecified, no reordering is done, and addresses are
411 tried in the order returned by :meth:`getaddrinfo`. If a positive integer
412 is specified, the addresses are interleaved by address family, and the
413 given integer is interpreted as "First Address Family Count" as defined
414 in :rfc:`8305`. The default is ``0`` if *happy_eyeballs_delay* is not
415 specified, and ``1`` if it is.
416
Victor Stinnerea3183f2013-12-03 01:08:00 +0100417 * *sock*, if given, should be an existing, already connected
418 :class:`socket.socket` object to be used by the transport.
twisteroid ambassador88f07a82019-05-05 19:14:35 +0800419 If *sock* is given, none of *host*, *port*, *family*, *proto*, *flags*,
420 *happy_eyeballs_delay*, *interleave*
Victor Stinnerea3183f2013-12-03 01:08:00 +0100421 and *local_addr* should be specified.
422
423 * *local_addr*, if given, is a ``(local_host, local_port)`` tuple used
424 to bind the socket to locally. The *local_host* and *local_port*
Carol Willing5b7cbd62018-09-12 17:05:17 -0700425 are looked up using ``getaddrinfo()``, similarly to *host* and *port*.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100426
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400427 * *ssl_handshake_timeout* is (for a TLS connection) the time in seconds
428 to wait for the TLS handshake to complete before aborting the connection.
Yury Selivanov96026432018-06-04 11:32:35 -0400429 ``60.0`` seconds if ``None`` (default).
Neil Aspinallf7686c12017-12-19 19:45:42 +0000430
twisteroid ambassador88f07a82019-05-05 19:14:35 +0800431 .. versionadded:: 3.8
432
433 The *happy_eyeballs_delay* and *interleave* parameters.
434
Neil Aspinallf7686c12017-12-19 19:45:42 +0000435 .. versionadded:: 3.7
436
437 The *ssl_handshake_timeout* parameter.
438
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700439 .. versionchanged:: 3.6
440
441 The socket option :py:data:`~socket.TCP_NODELAY` is set by default
442 for all TCP connections.
443
Victor Stinner60208a12015-09-15 22:41:52 +0200444 .. versionchanged:: 3.5
445
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400446 Added support for SSL/TLS in :class:`ProactorEventLoop`.
Victor Stinner41f3c3f2014-08-31 14:47:37 +0200447
Victor Stinnerc8ea8132014-01-23 11:02:09 +0100448 .. seealso::
449
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700450 The :func:`open_connection` function is a high-level alternative
451 API. It returns a pair of (:class:`StreamReader`, :class:`StreamWriter`)
452 that can be used directly in async/await code.
Victor Stinnerc8ea8132014-01-23 11:02:09 +0100453
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700454.. coroutinemethod:: loop.create_datagram_endpoint(protocol_factory, \
455 local_addr=None, remote_addr=None, \*, \
456 family=0, proto=0, flags=0, \
457 reuse_address=None, reuse_port=None, \
458 allow_broadcast=None, sock=None)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100459
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700460 Create a datagram connection.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100461
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700462 The socket family can be either :py:data:`~socket.AF_INET`,
463 :py:data:`~socket.AF_INET6`, or :py:data:`~socket.AF_UNIX`,
464 depending on *host* (or the *family* argument, if provided).
Victor Stinnera6919aa2014-02-19 13:32:34 +0100465
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700466 The socket type will be :py:data:`~socket.SOCK_DGRAM`.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100467
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700468 *protocol_factory* must be a callable returning a
469 :ref:`protocol <asyncio-protocol>` implementation.
470
471 A tuple of ``(transport, protocol)`` is returned on success.
472
473 Other arguments:
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700474
475 * *local_addr*, if given, is a ``(local_host, local_port)`` tuple used
476 to bind the socket to locally. The *local_host* and *local_port*
477 are looked up using :meth:`getaddrinfo`.
478
479 * *remote_addr*, if given, is a ``(remote_host, remote_port)`` tuple used
480 to connect the socket to a remote address. The *remote_host* and
481 *remote_port* are looked up using :meth:`getaddrinfo`.
482
483 * *family*, *proto*, *flags* are the optional address family, protocol
484 and flags to be passed through to :meth:`getaddrinfo` for *host*
485 resolution. If given, these should all be integers from the
486 corresponding :mod:`socket` module constants.
487
488 * *reuse_address* tells the kernel to reuse a local socket in
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700489 ``TIME_WAIT`` state, without waiting for its natural timeout to
Serhiy Storchaka4adf01c2016-10-19 18:30:05 +0300490 expire. If not specified will automatically be set to ``True`` on
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400491 Unix.
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700492
493 * *reuse_port* tells the kernel to allow this endpoint to be bound to the
494 same port as other existing endpoints are bound to, so long as they all
495 set this flag when being created. This option is not supported on Windows
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400496 and some Unixes. If the :py:data:`~socket.SO_REUSEPORT` constant is not
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700497 defined then this capability is unsupported.
498
499 * *allow_broadcast* tells the kernel to allow this endpoint to send
500 messages to the broadcast address.
501
502 * *sock* can optionally be specified in order to use a preexisting,
503 already connected, :class:`socket.socket` object to be used by the
504 transport. If specified, *local_addr* and *remote_addr* should be omitted
505 (must be :const:`None`).
Victor Stinnera6919aa2014-02-19 13:32:34 +0100506
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400507 On Windows, with :class:`ProactorEventLoop`, this method is not supported.
Victor Stinner41f3c3f2014-08-31 14:47:37 +0200508
Victor Stinnerc7edffd2014-10-12 11:24:26 +0200509 See :ref:`UDP echo client protocol <asyncio-udp-echo-client-protocol>` and
510 :ref:`UDP echo server protocol <asyncio-udp-echo-server-protocol>` examples.
511
Romuald Brunet0ded5802018-05-14 18:22:00 +0200512 .. versionchanged:: 3.4.4
513 The *family*, *proto*, *flags*, *reuse_address*, *reuse_port,
514 *allow_broadcast*, and *sock* parameters were added.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100515
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700516.. coroutinemethod:: loop.create_unix_connection(protocol_factory, \
517 path=None, \*, ssl=None, sock=None, \
518 server_hostname=None, ssl_handshake_timeout=None)
Victor Stinnera6919aa2014-02-19 13:32:34 +0100519
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400520 Create a Unix connection.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100521
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700522 The socket family will be :py:data:`~socket.AF_UNIX`; socket
523 type will be :py:data:`~socket.SOCK_STREAM`.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100524
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700525 A tuple of ``(transport, protocol)`` is returned on success.
Guido van Rossum9e80eeb2016-11-03 14:17:25 -0700526
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400527 *path* is the name of a Unix domain socket and is required,
528 unless a *sock* parameter is specified. Abstract Unix sockets,
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700529 :class:`str`, :class:`bytes`, and :class:`~pathlib.Path` paths are
530 supported.
531
532 See the documentation of the :meth:`loop.create_connection` method
533 for information about arguments to this method.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100534
Cheryl Sabella2d6097d2018-10-12 10:55:20 -0400535 .. availability:: Unix.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100536
Neil Aspinallf7686c12017-12-19 19:45:42 +0000537 .. versionadded:: 3.7
538
539 The *ssl_handshake_timeout* parameter.
540
Yury Selivanov423fd362017-11-20 17:26:28 -0500541 .. versionchanged:: 3.7
542
Elvis Pranskevichusc0d062f2018-06-08 11:36:00 -0400543 The *path* parameter can now be a :term:`path-like object`.
Yury Selivanov423fd362017-11-20 17:26:28 -0500544
Victor Stinnera6919aa2014-02-19 13:32:34 +0100545
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700546Creating network servers
547^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +0100548
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700549.. coroutinemethod:: loop.create_server(protocol_factory, \
550 host=None, port=None, \*, \
551 family=socket.AF_UNSPEC, \
552 flags=socket.AI_PASSIVE, \
553 sock=None, backlog=100, ssl=None, \
554 reuse_address=None, reuse_port=None, \
555 ssl_handshake_timeout=None, start_serving=True)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100556
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700557 Create a TCP server (socket type :data:`~socket.SOCK_STREAM`) listening
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400558 on *port* of the *host* address.
Victor Stinner33f6abe2014-10-12 20:36:04 +0200559
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700560 Returns a :class:`Server` object.
Victor Stinner33f6abe2014-10-12 20:36:04 +0200561
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700562 Arguments:
Victor Stinner33f6abe2014-10-12 20:36:04 +0200563
Bumsik Kim5cc583d2018-09-16 19:40:44 -0400564 * *protocol_factory* must be a callable returning a
565 :ref:`protocol <asyncio-protocol>` implementation.
566
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400567 * The *host* parameter can be set to several types which determine where
568 the server would be listening:
569
570 - If *host* is a string, the TCP server is bound to a single network
571 interface specified by *host*.
572
573 - If *host* is a sequence of strings, the TCP server is bound to all
574 network interfaces specified by the sequence.
575
576 - If *host* is an empty string or ``None``, all interfaces are
577 assumed and a list of multiple sockets will be returned (most likely
578 one for IPv4 and another one for IPv6).
Victor Stinner33f6abe2014-10-12 20:36:04 +0200579
580 * *family* can be set to either :data:`socket.AF_INET` or
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700581 :data:`~socket.AF_INET6` to force the socket to use IPv4 or IPv6.
Carol Willing5b7cbd62018-09-12 17:05:17 -0700582 If not set, the *family* will be determined from host name
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700583 (defaults to :data:`~socket.AF_UNSPEC`).
Victor Stinner33f6abe2014-10-12 20:36:04 +0200584
585 * *flags* is a bitmask for :meth:`getaddrinfo`.
586
587 * *sock* can optionally be specified in order to use a preexisting
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400588 socket object. If specified, *host* and *port* must not be specified.
Victor Stinner33f6abe2014-10-12 20:36:04 +0200589
590 * *backlog* is the maximum number of queued connections passed to
591 :meth:`~socket.socket.listen` (defaults to 100).
592
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400593 * *ssl* can be set to an :class:`~ssl.SSLContext` instance to enable
594 TLS over the accepted connections.
Victor Stinner33f6abe2014-10-12 20:36:04 +0200595
596 * *reuse_address* tells the kernel to reuse a local socket in
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700597 ``TIME_WAIT`` state, without waiting for its natural timeout to
Serhiy Storchaka4adf01c2016-10-19 18:30:05 +0300598 expire. If not specified will automatically be set to ``True`` on
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400599 Unix.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100600
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700601 * *reuse_port* tells the kernel to allow this endpoint to be bound to the
602 same port as other existing endpoints are bound to, so long as they all
603 set this flag when being created. This option is not supported on
604 Windows.
605
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400606 * *ssl_handshake_timeout* is (for a TLS server) the time in seconds to wait
607 for the TLS handshake to complete before aborting the connection.
Yury Selivanov96026432018-06-04 11:32:35 -0400608 ``60.0`` seconds if ``None`` (default).
Neil Aspinallf7686c12017-12-19 19:45:42 +0000609
Yury Selivanovc9070d02018-01-25 18:08:09 -0500610 * *start_serving* set to ``True`` (the default) causes the created server
611 to start accepting connections immediately. When set to ``False``,
612 the user should await on :meth:`Server.start_serving` or
613 :meth:`Server.serve_forever` to make the server to start accepting
614 connections.
615
Neil Aspinallf7686c12017-12-19 19:45:42 +0000616 .. versionadded:: 3.7
617
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700618 Added *ssl_handshake_timeout* and *start_serving* parameters.
619
620 .. versionchanged:: 3.6
621
622 The socket option :py:data:`~socket.TCP_NODELAY` is set by default
623 for all TCP connections.
Neil Aspinallf7686c12017-12-19 19:45:42 +0000624
Victor Stinner60208a12015-09-15 22:41:52 +0200625 .. versionchanged:: 3.5
626
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400627 Added support for SSL/TLS in :class:`ProactorEventLoop`.
Victor Stinnerc8ea8132014-01-23 11:02:09 +0100628
Victor Stinner7b58a2b2015-09-21 18:41:05 +0200629 .. versionchanged:: 3.5.1
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200630
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700631 The *host* parameter can be a sequence of strings.
632
633 .. seealso::
634
635 The :func:`start_server` function is a higher-level alternative API
636 that returns a pair of :class:`StreamReader` and :class:`StreamWriter`
637 that can be used in an async/await code.
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200638
Victor Stinnerea3183f2013-12-03 01:08:00 +0100639
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700640.. coroutinemethod:: loop.create_unix_server(protocol_factory, path=None, \
641 \*, sock=None, backlog=100, ssl=None, \
642 ssl_handshake_timeout=None, start_serving=True)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100643
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700644 Similar to :meth:`loop.create_server` but works with the
645 :py:data:`~socket.AF_UNIX` socket family.
Victor Stinnera6919aa2014-02-19 13:32:34 +0100646
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400647 *path* is the name of a Unix domain socket, and is required,
648 unless a *sock* argument is provided. Abstract Unix sockets,
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700649 :class:`str`, :class:`bytes`, and :class:`~pathlib.Path` paths
650 are supported.
Yury Selivanov423fd362017-11-20 17:26:28 -0500651
Bumsik Kim5cc583d2018-09-16 19:40:44 -0400652 See the documentation of the :meth:`loop.create_server` method
653 for information about arguments to this method.
654
Cheryl Sabella2d6097d2018-10-12 10:55:20 -0400655 .. availability:: Unix.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100656
Neil Aspinallf7686c12017-12-19 19:45:42 +0000657 .. versionadded:: 3.7
658
Elvis Pranskevichusc0d062f2018-06-08 11:36:00 -0400659 The *ssl_handshake_timeout* and *start_serving* parameters.
Neil Aspinallf7686c12017-12-19 19:45:42 +0000660
Yury Selivanov423fd362017-11-20 17:26:28 -0500661 .. versionchanged:: 3.7
662
663 The *path* parameter can now be a :class:`~pathlib.Path` object.
664
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700665.. coroutinemethod:: loop.connect_accepted_socket(protocol_factory, \
666 sock, \*, ssl=None, ssl_handshake_timeout=None)
Yury Selivanov3b3a1412016-11-07 15:35:25 -0500667
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700668 Wrap an already accepted connection into a transport/protocol pair.
Yury Selivanov3b3a1412016-11-07 15:35:25 -0500669
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700670 This method can be used by servers that accept connections outside
671 of asyncio but that use asyncio to handle them.
Yury Selivanov3b3a1412016-11-07 15:35:25 -0500672
673 Parameters:
674
Bumsik Kim5cc583d2018-09-16 19:40:44 -0400675 * *protocol_factory* must be a callable returning a
676 :ref:`protocol <asyncio-protocol>` implementation.
677
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700678 * *sock* is a preexisting socket object returned from
679 :meth:`socket.accept <socket.socket.accept>`.
Yury Selivanov3b3a1412016-11-07 15:35:25 -0500680
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700681 * *ssl* can be set to an :class:`~ssl.SSLContext` to enable SSL over
682 the accepted connections.
Yury Selivanov3b3a1412016-11-07 15:35:25 -0500683
Neil Aspinallf7686c12017-12-19 19:45:42 +0000684 * *ssl_handshake_timeout* is (for an SSL connection) the time in seconds to
685 wait for the SSL handshake to complete before aborting the connection.
Yury Selivanov96026432018-06-04 11:32:35 -0400686 ``60.0`` seconds if ``None`` (default).
Neil Aspinallf7686c12017-12-19 19:45:42 +0000687
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700688 Returns a ``(transport, protocol)`` pair.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100689
Neil Aspinallf7686c12017-12-19 19:45:42 +0000690 .. versionadded:: 3.7
691
692 The *ssl_handshake_timeout* parameter.
693
AraHaan431665b2017-11-21 11:06:26 -0500694 .. versionadded:: 3.5.3
695
696
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700697Transferring files
698^^^^^^^^^^^^^^^^^^
Andrew Svetlov7c684072018-01-27 21:22:47 +0200699
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700700.. coroutinemethod:: loop.sendfile(transport, file, \
701 offset=0, count=None, *, fallback=True)
Andrew Svetlov7c684072018-01-27 21:22:47 +0200702
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700703 Send a *file* over a *transport*. Return the total number of bytes
704 sent.
Andrew Svetlov7c684072018-01-27 21:22:47 +0200705
706 The method uses high-performance :meth:`os.sendfile` if available.
707
708 *file* must be a regular file object opened in binary mode.
709
710 *offset* tells from where to start reading the file. If specified,
711 *count* is the total number of bytes to transmit as opposed to
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400712 sending the file until EOF is reached. File position is always updated,
713 even when this method raises an error, and
714 :meth:`file.tell() <io.IOBase.tell>` can be used to obtain the actual
715 number of bytes sent.
Andrew Svetlov7c684072018-01-27 21:22:47 +0200716
717 *fallback* set to ``True`` makes asyncio to manually read and send
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700718 the file when the platform does not support the sendfile system call
Andrew Svetlov7c684072018-01-27 21:22:47 +0200719 (e.g. Windows or SSL socket on Unix).
720
721 Raise :exc:`SendfileNotAvailableError` if the system does not support
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400722 the *sendfile* syscall and *fallback* is ``False``.
Andrew Svetlov7c684072018-01-27 21:22:47 +0200723
724 .. versionadded:: 3.7
725
726
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500727TLS Upgrade
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700728^^^^^^^^^^^
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500729
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700730.. coroutinemethod:: loop.start_tls(transport, protocol, \
731 sslcontext, \*, server_side=False, \
732 server_hostname=None, ssl_handshake_timeout=None)
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500733
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700734 Upgrade an existing transport-based connection to TLS.
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500735
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700736 Return a new transport instance, that the *protocol* must start using
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500737 immediately after the *await*. The *transport* instance passed to
738 the *start_tls* method should never be used again.
739
740 Parameters:
741
742 * *transport* and *protocol* instances that methods like
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700743 :meth:`~loop.create_server` and
744 :meth:`~loop.create_connection` return.
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500745
746 * *sslcontext*: a configured instance of :class:`~ssl.SSLContext`.
747
748 * *server_side* pass ``True`` when a server-side connection is being
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700749 upgraded (like the one created by :meth:`~loop.create_server`).
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500750
751 * *server_hostname*: sets or overrides the host name that the target
752 server's certificate will be matched against.
753
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400754 * *ssl_handshake_timeout* is (for a TLS connection) the time in seconds to
755 wait for the TLS handshake to complete before aborting the connection.
Yury Selivanov96026432018-06-04 11:32:35 -0400756 ``60.0`` seconds if ``None`` (default).
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500757
758 .. versionadded:: 3.7
759
760
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700761Watching file descriptors
762^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerc1567df2014-02-08 23:22:58 +0100763
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700764.. method:: loop.add_reader(fd, callback, \*args)
Victor Stinner41f3c3f2014-08-31 14:47:37 +0200765
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400766 Start monitoring the *fd* file descriptor for read availability and
767 invoke *callback* with the specified arguments once *fd* is available for
768 reading.
Victor Stinner41f3c3f2014-08-31 14:47:37 +0200769
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700770.. method:: loop.remove_reader(fd)
Victor Stinnerc1567df2014-02-08 23:22:58 +0100771
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400772 Stop monitoring the *fd* file descriptor for read availability.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100773
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700774.. method:: loop.add_writer(fd, callback, \*args)
Victor Stinnerc1567df2014-02-08 23:22:58 +0100775
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400776 Start monitoring the *fd* file descriptor for write availability and
777 invoke *callback* with the specified arguments once *fd* is available for
778 writing.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100779
Yury Selivanove247b462018-09-20 12:43:59 -0400780 Use :func:`functools.partial` :ref:`to pass keyword arguments
Naglis17473342018-12-04 09:31:15 +0200781 <asyncio-pass-keywords>` to *callback*.
Victor Stinner8464c242014-11-28 13:15:41 +0100782
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700783.. method:: loop.remove_writer(fd)
Victor Stinnerc1567df2014-02-08 23:22:58 +0100784
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400785 Stop monitoring the *fd* file descriptor for write availability.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100786
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700787See also :ref:`Platform Support <asyncio-platform-support>` section
788for some limitations of these methods.
Victor Stinner04e6df32014-10-11 16:16:27 +0200789
Victor Stinnerc1567df2014-02-08 23:22:58 +0100790
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700791Working with socket objects directly
792^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerc1567df2014-02-08 23:22:58 +0100793
Carol Willing5b7cbd62018-09-12 17:05:17 -0700794In general, protocol implementations that use transport-based APIs
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700795such as :meth:`loop.create_connection` and :meth:`loop.create_server`
796are faster than implementations that work with sockets directly.
Carol Willing5b7cbd62018-09-12 17:05:17 -0700797However, there are some use cases when performance is not critical, and
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700798working with :class:`~socket.socket` objects directly is more
799convenient.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100800
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700801.. coroutinemethod:: loop.sock_recv(sock, nbytes)
Yury Selivanov55c50842016-06-08 12:48:15 -0400802
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400803 Receive up to *nbytes* from *sock*. Asynchronous version of
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700804 :meth:`socket.recv() <socket.socket.recv>`.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100805
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400806 Return the received data as a bytes object.
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700807
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400808 *sock* must be a non-blocking socket.
Victor Stinnerec2ce092014-07-29 23:12:22 +0200809
Yury Selivanov19a44f62017-12-14 20:53:26 -0500810 .. versionchanged:: 3.7
Carol Willing5b7cbd62018-09-12 17:05:17 -0700811 Even though this method was always documented as a coroutine
812 method, releases before Python 3.7 returned a :class:`Future`.
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700813 Since Python 3.7 this is an ``async def`` method.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100814
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700815.. coroutinemethod:: loop.sock_recv_into(sock, buf)
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200816
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400817 Receive data from *sock* into the *buf* buffer. Modeled after the blocking
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700818 :meth:`socket.recv_into() <socket.socket.recv_into>` method.
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200819
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700820 Return the number of bytes written to the buffer.
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200821
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400822 *sock* must be a non-blocking socket.
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200823
Antoine Pitrou525f40d2017-10-19 21:46:40 +0200824 .. versionadded:: 3.7
825
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700826.. coroutinemethod:: loop.sock_sendall(sock, data)
Victor Stinnerc1567df2014-02-08 23:22:58 +0100827
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400828 Send *data* to the *sock* socket. Asynchronous version of
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700829 :meth:`socket.sendall() <socket.socket.sendall>`.
Yury Selivanov55c50842016-06-08 12:48:15 -0400830
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400831 This method continues to send to the socket until either all data
832 in *data* has been sent or an error occurs. ``None`` is returned
Carol Willing5b7cbd62018-09-12 17:05:17 -0700833 on success. On error, an exception is raised. Additionally, there is no way
834 to determine how much data, if any, was successfully processed by the
835 receiving end of the connection.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100836
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400837 *sock* must be a non-blocking socket.
Victor Stinnerec2ce092014-07-29 23:12:22 +0200838
Yury Selivanov19a44f62017-12-14 20:53:26 -0500839 .. versionchanged:: 3.7
840 Even though the method was always documented as a coroutine
841 method, before Python 3.7 it returned an :class:`Future`.
842 Since Python 3.7, this is an ``async def`` method.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100843
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700844.. coroutinemethod:: loop.sock_connect(sock, address)
Victor Stinnerc1567df2014-02-08 23:22:58 +0100845
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400846 Connect *sock* to a remote socket at *address*.
Victor Stinner1b0580b2014-02-13 09:24:37 +0100847
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700848 Asynchronous version of :meth:`socket.connect() <socket.socket.connect>`.
849
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400850 *sock* must be a non-blocking socket.
Victor Stinnerec2ce092014-07-29 23:12:22 +0200851
Yury Selivanov55c50842016-06-08 12:48:15 -0400852 .. versionchanged:: 3.5.2
853 ``address`` no longer needs to be resolved. ``sock_connect``
854 will try to check if the *address* is already resolved by calling
855 :func:`socket.inet_pton`. If not,
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700856 :meth:`loop.getaddrinfo` will be used to resolve the
Yury Selivanov55c50842016-06-08 12:48:15 -0400857 *address*.
858
Victor Stinnerc1567df2014-02-08 23:22:58 +0100859 .. seealso::
860
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700861 :meth:`loop.create_connection`
Yury Selivanov55c50842016-06-08 12:48:15 -0400862 and :func:`asyncio.open_connection() <open_connection>`.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100863
864
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700865.. coroutinemethod:: loop.sock_accept(sock)
Victor Stinnerc1567df2014-02-08 23:22:58 +0100866
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700867 Accept a connection. Modeled after the blocking
868 :meth:`socket.accept() <socket.socket.accept>` method.
Yury Selivanov55c50842016-06-08 12:48:15 -0400869
870 The socket must be bound to an address and listening
Victor Stinnerc1567df2014-02-08 23:22:58 +0100871 for connections. The return value is a pair ``(conn, address)`` where *conn*
872 is a *new* socket object usable to send and receive data on the connection,
873 and *address* is the address bound to the socket on the other end of the
874 connection.
875
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400876 *sock* must be a non-blocking socket.
Victor Stinnerec2ce092014-07-29 23:12:22 +0200877
Yury Selivanov19a44f62017-12-14 20:53:26 -0500878 .. versionchanged:: 3.7
879 Even though the method was always documented as a coroutine
880 method, before Python 3.7 it returned a :class:`Future`.
881 Since Python 3.7, this is an ``async def`` method.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100882
883 .. seealso::
884
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700885 :meth:`loop.create_server` and :func:`start_server`.
Victor Stinnerc1567df2014-02-08 23:22:58 +0100886
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700887.. coroutinemethod:: loop.sock_sendfile(sock, file, offset=0, count=None, \
888 \*, fallback=True)
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200889
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700890 Send a file using high-performance :mod:`os.sendfile` if possible.
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400891 Return the total number of bytes sent.
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200892
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700893 Asynchronous version of :meth:`socket.sendfile() <socket.socket.sendfile>`.
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200894
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400895 *sock* must be a non-blocking :const:`socket.SOCK_STREAM`
896 :class:`~socket.socket`.
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200897
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400898 *file* must be a regular file object open in binary mode.
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200899
900 *offset* tells from where to start reading the file. If specified,
901 *count* is the total number of bytes to transmit as opposed to
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400902 sending the file until EOF is reached. File position is always updated,
903 even when this method raises an error, and
904 :meth:`file.tell() <io.IOBase.tell>` can be used to obtain the actual
905 number of bytes sent.
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200906
Carol Willing5b7cbd62018-09-12 17:05:17 -0700907 *fallback*, when set to ``True``, makes asyncio manually read and send
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200908 the file when the platform does not support the sendfile syscall
909 (e.g. Windows or SSL socket on Unix).
910
Andrew Svetlov7464e872018-01-19 20:04:29 +0200911 Raise :exc:`SendfileNotAvailableError` if the system does not support
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200912 *sendfile* syscall and *fallback* is ``False``.
913
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400914 *sock* must be a non-blocking socket.
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700915
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200916 .. versionadded:: 3.7
917
Victor Stinnerc1567df2014-02-08 23:22:58 +0100918
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700919DNS
920^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +0100921
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700922.. coroutinemethod:: loop.getaddrinfo(host, port, \*, family=0, \
923 type=0, proto=0, flags=0)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100924
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700925 Asynchronous version of :meth:`socket.getaddrinfo`.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100926
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700927.. coroutinemethod:: loop.getnameinfo(sockaddr, flags=0)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100928
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700929 Asynchronous version of :meth:`socket.getnameinfo`.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100930
Yury Selivanovbec23722018-01-28 14:09:40 -0500931.. versionchanged:: 3.7
932 Both *getaddrinfo* and *getnameinfo* methods were always documented
933 to return a coroutine, but prior to Python 3.7 they were, in fact,
934 returning :class:`asyncio.Future` objects. Starting with Python 3.7
935 both methods are coroutines.
936
Victor Stinnerea3183f2013-12-03 01:08:00 +0100937
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700938Working with pipes
939^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +0100940
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700941.. coroutinemethod:: loop.connect_read_pipe(protocol_factory, pipe)
Victor Stinner41f3c3f2014-08-31 14:47:37 +0200942
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400943 Register the read end of *pipe* in the event loop.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100944
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700945 *protocol_factory* must be a callable returning an
946 :ref:`asyncio protocol <asyncio-protocol>` implementation.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100947
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700948 *pipe* is a :term:`file-like object <file object>`.
949
950 Return pair ``(transport, protocol)``, where *transport* supports
Bumsik Kim5cc583d2018-09-16 19:40:44 -0400951 the :class:`ReadTransport` interface and *protocol* is an object
952 instantiated by the *protocol_factory*.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100953
Victor Stinnerd84fd732014-08-26 01:01:59 +0200954 With :class:`SelectorEventLoop` event loop, the *pipe* is set to
955 non-blocking mode.
956
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700957.. coroutinemethod:: loop.connect_write_pipe(protocol_factory, pipe)
Victor Stinnerea3183f2013-12-03 01:08:00 +0100958
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400959 Register the write end of *pipe* in the event loop.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100960
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700961 *protocol_factory* must be a callable returning an
962 :ref:`asyncio protocol <asyncio-protocol>` implementation.
963
964 *pipe* is :term:`file-like object <file object>`.
965
Victor Stinner2cef3002014-10-23 22:38:46 +0200966 Return pair ``(transport, protocol)``, where *transport* supports
Bumsik Kim5cc583d2018-09-16 19:40:44 -0400967 :class:`WriteTransport` interface and *protocol* is an object
968 instantiated by the *protocol_factory*.
Victor Stinnerea3183f2013-12-03 01:08:00 +0100969
Victor Stinnerd84fd732014-08-26 01:01:59 +0200970 With :class:`SelectorEventLoop` event loop, the *pipe* is set to
971 non-blocking mode.
972
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700973.. note::
974
975 :class:`SelectorEventLoop` does not support the above methods on
Carol Willing5b7cbd62018-09-12 17:05:17 -0700976 Windows. Use :class:`ProactorEventLoop` instead for Windows.
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700977
Victor Stinner08444382014-02-02 22:43:39 +0100978.. seealso::
979
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700980 The :meth:`loop.subprocess_exec` and
981 :meth:`loop.subprocess_shell` methods.
Victor Stinner08444382014-02-02 22:43:39 +0100982
Victor Stinnerea3183f2013-12-03 01:08:00 +0100983
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400984Unix signals
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700985^^^^^^^^^^^^
Victor Stinner8b863482014-01-27 10:07:50 +0100986
Yury Selivanov7c7605f2018-09-11 09:54:40 -0700987.. method:: loop.add_signal_handler(signum, callback, \*args)
Victor Stinner8b863482014-01-27 10:07:50 +0100988
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -0400989 Set *callback* as the handler for the *signum* signal.
Victor Stinner8b863482014-01-27 10:07:50 +0100990
Hrvoje Nikšiće3666fc2018-12-18 22:31:29 +0100991 The callback will be invoked by *loop*, along with other queued callbacks
992 and runnable coroutines of that event loop. Unlike signal handlers
993 registered using :func:`signal.signal`, a callback registered with this
994 function is allowed to interact with the event loop.
995
Victor Stinner8b863482014-01-27 10:07:50 +0100996 Raise :exc:`ValueError` if the signal number is invalid or uncatchable.
997 Raise :exc:`RuntimeError` if there is a problem setting up the handler.
998
Yury Selivanove247b462018-09-20 12:43:59 -0400999 Use :func:`functools.partial` :ref:`to pass keyword arguments
Naglis17473342018-12-04 09:31:15 +02001000 <asyncio-pass-keywords>` to *callback*.
Victor Stinner8464c242014-11-28 13:15:41 +01001001
Hrvoje Nikšiće3666fc2018-12-18 22:31:29 +01001002 Like :func:`signal.signal`, this function must be invoked in the main
1003 thread.
1004
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001005.. method:: loop.remove_signal_handler(sig)
Victor Stinner8b863482014-01-27 10:07:50 +01001006
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001007 Remove the handler for the *sig* signal.
Victor Stinner8b863482014-01-27 10:07:50 +01001008
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001009 Return ``True`` if the signal handler was removed, or ``False`` if
1010 no handler was set for the given signal.
Victor Stinner8b863482014-01-27 10:07:50 +01001011
Cheryl Sabella2d6097d2018-10-12 10:55:20 -04001012 .. availability:: Unix.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001013
Victor Stinner8b863482014-01-27 10:07:50 +01001014.. seealso::
1015
1016 The :mod:`signal` module.
1017
1018
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001019Executing code in thread or process pools
1020^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +01001021
Yury Selivanov47150392018-09-18 17:55:44 -04001022.. awaitablemethod:: loop.run_in_executor(executor, func, \*args)
Victor Stinnerea3183f2013-12-03 01:08:00 +01001023
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001024 Arrange for *func* to be called in the specified executor.
Victor Stinnerea3183f2013-12-03 01:08:00 +01001025
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001026 The *executor* argument should be an :class:`concurrent.futures.Executor`
Larry Hastings3732ed22014-03-15 21:13:56 -07001027 instance. The default executor is used if *executor* is ``None``.
Victor Stinnerea3183f2013-12-03 01:08:00 +01001028
Yury Selivanove247b462018-09-20 12:43:59 -04001029 Example::
1030
1031 import asyncio
1032 import concurrent.futures
1033
1034 def blocking_io():
1035 # File operations (such as logging) can block the
1036 # event loop: run them in a thread pool.
1037 with open('/dev/urandom', 'rb') as f:
1038 return f.read(100)
1039
1040 def cpu_bound():
1041 # CPU-bound operations will block the event loop:
1042 # in general it is preferable to run them in a
1043 # process pool.
1044 return sum(i * i for i in range(10 ** 7))
1045
1046 async def main():
1047 loop = asyncio.get_running_loop()
1048
1049 ## Options:
1050
1051 # 1. Run in the default loop's executor:
1052 result = await loop.run_in_executor(
1053 None, blocking_io)
1054 print('default thread pool', result)
1055
1056 # 2. Run in a custom thread pool:
1057 with concurrent.futures.ThreadPoolExecutor() as pool:
1058 result = await loop.run_in_executor(
1059 pool, blocking_io)
1060 print('custom thread pool', result)
1061
1062 # 3. Run in a custom process pool:
1063 with concurrent.futures.ProcessPoolExecutor() as pool:
1064 result = await loop.run_in_executor(
1065 pool, cpu_bound)
1066 print('custom process pool', result)
1067
1068 asyncio.run(main())
Victor Stinner8464c242014-11-28 13:15:41 +01001069
Yury Selivanovbec23722018-01-28 14:09:40 -05001070 This method returns a :class:`asyncio.Future` object.
1071
Yury Selivanove247b462018-09-20 12:43:59 -04001072 Use :func:`functools.partial` :ref:`to pass keyword arguments
1073 <asyncio-pass-keywords>` to *func*.
1074
Yury Selivanove8a60452016-10-21 17:40:42 -04001075 .. versionchanged:: 3.5.3
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001076 :meth:`loop.run_in_executor` no longer configures the
Yury Selivanove8a60452016-10-21 17:40:42 -04001077 ``max_workers`` of the thread pool executor it creates, instead
1078 leaving it up to the thread pool executor
1079 (:class:`~concurrent.futures.ThreadPoolExecutor`) to set the
1080 default.
1081
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001082.. method:: loop.set_default_executor(executor)
Victor Stinnerea3183f2013-12-03 01:08:00 +01001083
Elvis Pranskevichus22d25082018-07-30 11:42:43 +01001084 Set *executor* as the default executor used by :meth:`run_in_executor`.
1085 *executor* should be an instance of
1086 :class:`~concurrent.futures.ThreadPoolExecutor`.
1087
1088 .. deprecated:: 3.8
1089 Using an executor that is not an instance of
1090 :class:`~concurrent.futures.ThreadPoolExecutor` is deprecated and
1091 will trigger an error in Python 3.9.
Victor Stinnerea3183f2013-12-03 01:08:00 +01001092
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001093 *executor* must be an instance of
1094 :class:`concurrent.futures.ThreadPoolExecutor`.
1095
Victor Stinnerea3183f2013-12-03 01:08:00 +01001096
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001097Error Handling API
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001098^^^^^^^^^^^^^^^^^^
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001099
Martin Panterc04fb562016-02-10 05:44:01 +00001100Allows customizing how exceptions are handled in the event loop.
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001101
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001102.. method:: loop.set_exception_handler(handler)
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001103
1104 Set *handler* as the new event loop exception handler.
1105
1106 If *handler* is ``None``, the default exception handler will
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001107 be set. Otherwise, *handler* must be a callable with the signature
1108 matching ``(loop, context)``, where ``loop``
1109 is a reference to the active event loop, and ``context``
1110 is a ``dict`` object containing the details of the exception
1111 (see :meth:`call_exception_handler` documentation for details
1112 about context).
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001113
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001114.. method:: loop.get_exception_handler()
Yury Selivanov950204d2016-05-16 16:23:00 -04001115
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001116 Return the current exception handler, or ``None`` if no custom
1117 exception handler was set.
Yury Selivanov950204d2016-05-16 16:23:00 -04001118
1119 .. versionadded:: 3.5.2
1120
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001121.. method:: loop.default_exception_handler(context)
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001122
1123 Default exception handler.
1124
1125 This is called when an exception occurs and no exception
Carol Willing5b7cbd62018-09-12 17:05:17 -07001126 handler is set. This can be called by a custom exception
1127 handler that wants to defer to the default handler behavior.
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001128
1129 *context* parameter has the same meaning as in
1130 :meth:`call_exception_handler`.
1131
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001132.. method:: loop.call_exception_handler(context)
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001133
1134 Call the current event loop exception handler.
1135
1136 *context* is a ``dict`` object containing the following keys
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001137 (new keys may be introduced in future Python versions):
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001138
1139 * 'message': Error message;
1140 * 'exception' (optional): Exception object;
1141 * 'future' (optional): :class:`asyncio.Future` instance;
1142 * 'handle' (optional): :class:`asyncio.Handle` instance;
1143 * 'protocol' (optional): :ref:`Protocol <asyncio-protocol>` instance;
1144 * 'transport' (optional): :ref:`Transport <asyncio-transport>` instance;
1145 * 'socket' (optional): :class:`socket.socket` instance.
1146
1147 .. note::
1148
Carol Willing5b7cbd62018-09-12 17:05:17 -07001149 This method should not be overloaded in subclassed
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001150 event loops. For custom exception handling, use
1151 the :meth:`set_exception_handler()` method.
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001152
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001153Enabling debug mode
1154^^^^^^^^^^^^^^^^^^^
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001155
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001156.. method:: loop.get_debug()
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001157
Victor Stinner7b7120e2014-06-23 00:12:14 +02001158 Get the debug mode (:class:`bool`) of the event loop.
1159
1160 The default value is ``True`` if the environment variable
1161 :envvar:`PYTHONASYNCIODEBUG` is set to a non-empty string, ``False``
1162 otherwise.
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001163
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001164.. method:: loop.set_debug(enabled: bool)
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001165
1166 Set the debug mode of the event loop.
1167
Yury Selivanov805e27e2018-09-14 16:57:11 -07001168 .. versionchanged:: 3.7
1169
1170 The new ``-X dev`` command line option can now also be used
1171 to enable the debug mode.
1172
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001173.. seealso::
1174
Victor Stinner62511fd2014-06-23 00:36:11 +02001175 The :ref:`debug mode of asyncio <asyncio-debug-mode>`.
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001176
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001177
1178Running Subprocesses
1179^^^^^^^^^^^^^^^^^^^^
1180
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001181Methods described in this subsections are low-level. In regular
1182async/await code consider using the high-level
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001183:func:`asyncio.create_subprocess_shell` and
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001184:func:`asyncio.create_subprocess_exec` convenience functions instead.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001185
1186.. note::
1187
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001188 The default asyncio event loop on **Windows** does not support
1189 subprocesses. See :ref:`Subprocess Support on Windows
1190 <asyncio-windows-subprocess>` for details.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001191
1192.. coroutinemethod:: loop.subprocess_exec(protocol_factory, \*args, \
1193 stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
1194 stderr=subprocess.PIPE, \*\*kwargs)
1195
1196 Create a subprocess from one or more string arguments specified by
1197 *args*.
1198
1199 *args* must be a list of strings represented by:
1200
1201 * :class:`str`;
1202 * or :class:`bytes`, encoded to the
1203 :ref:`filesystem encoding <filesystem-encoding>`.
1204
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001205 The first string specifies the program executable,
Carol Willing5b7cbd62018-09-12 17:05:17 -07001206 and the remaining strings specify the arguments. Together, string
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001207 arguments form the ``argv`` of the program.
1208
1209 This is similar to the standard library :class:`subprocess.Popen`
1210 class called with ``shell=False`` and the list of strings passed as
1211 the first argument; however, where :class:`~subprocess.Popen` takes
1212 a single argument which is list of strings, *subprocess_exec*
1213 takes multiple string arguments.
1214
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001215 The *protocol_factory* must be a callable returning a subclass of the
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001216 :class:`asyncio.SubprocessProtocol` class.
1217
1218 Other parameters:
1219
1220 * *stdin*: either a file-like object representing a pipe to be
1221 connected to the subprocess's standard input stream using
1222 :meth:`~loop.connect_write_pipe`, or the
1223 :const:`subprocess.PIPE` constant (default). By default a new
1224 pipe will be created and connected.
1225
1226 * *stdout*: either a file-like object representing the pipe to be
1227 connected to the subprocess's standard output stream using
1228 :meth:`~loop.connect_read_pipe`, or the
1229 :const:`subprocess.PIPE` constant (default). By default a new pipe
1230 will be created and connected.
1231
1232 * *stderr*: either a file-like object representing the pipe to be
1233 connected to the subprocess's standard error stream using
1234 :meth:`~loop.connect_read_pipe`, or one of
1235 :const:`subprocess.PIPE` (default) or :const:`subprocess.STDOUT`
1236 constants.
1237
1238 By default a new pipe will be created and connected. When
1239 :const:`subprocess.STDOUT` is specified, the subprocess' standard
1240 error stream will be connected to the same pipe as the standard
1241 output stream.
1242
1243 * All other keyword arguments are passed to :class:`subprocess.Popen`
1244 without interpretation, except for *bufsize*, *universal_newlines*
1245 and *shell*, which should not be specified at all.
1246
1247 See the constructor of the :class:`subprocess.Popen` class
1248 for documentation on other arguments.
1249
1250 Returns a pair of ``(transport, protocol)``, where *transport*
Bumsik Kim5cc583d2018-09-16 19:40:44 -04001251 conforms to the :class:`asyncio.SubprocessTransport` base class and
1252 *protocol* is an object instantiated by the *protocol_factory*.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001253
1254.. coroutinemethod:: loop.subprocess_shell(protocol_factory, cmd, \*, \
1255 stdin=subprocess.PIPE, stdout=subprocess.PIPE, \
1256 stderr=subprocess.PIPE, \*\*kwargs)
1257
1258 Create a subprocess from *cmd*, which can be a :class:`str` or a
1259 :class:`bytes` string encoded to the
1260 :ref:`filesystem encoding <filesystem-encoding>`,
1261 using the platform's "shell" syntax.
1262
1263 This is similar to the standard library :class:`subprocess.Popen`
1264 class called with ``shell=True``.
1265
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001266 The *protocol_factory* must be a callable returning a subclass of the
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001267 :class:`SubprocessProtocol` class.
1268
1269 See :meth:`~loop.subprocess_exec` for more details about
1270 the remaining arguments.
1271
1272 Returns a pair of ``(transport, protocol)``, where *transport*
Bumsik Kim5cc583d2018-09-16 19:40:44 -04001273 conforms to the :class:`SubprocessTransport` base class and
1274 *protocol* is an object instantiated by the *protocol_factory*.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001275
1276.. note::
1277 It is the application's responsibility to ensure that all whitespace
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001278 and special characters are quoted appropriately to avoid `shell injection
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001279 <https://en.wikipedia.org/wiki/Shell_injection#Shell_injection>`_
1280 vulnerabilities. The :func:`shlex.quote` function can be used to
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001281 properly escape whitespace and special characters in strings that
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001282 are going to be used to construct shell commands.
1283
1284
1285Callback Handles
1286================
1287
1288.. class:: Handle
1289
1290 A callback wrapper object returned by :meth:`loop.call_soon`,
1291 :meth:`loop.call_soon_threadsafe`.
1292
1293 .. method:: cancel()
1294
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001295 Cancel the callback. If the callback has already been canceled
1296 or executed, this method has no effect.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001297
1298 .. method:: cancelled()
1299
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001300 Return ``True`` if the callback was cancelled.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001301
1302 .. versionadded:: 3.7
1303
1304.. class:: TimerHandle
1305
1306 A callback wrapper object returned by :meth:`loop.call_later`,
1307 and :meth:`loop.call_at`.
1308
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001309 This class is a subclass of :class:`Handle`.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001310
1311 .. method:: when()
1312
1313 Return a scheduled callback time as :class:`float` seconds.
1314
1315 The time is an absolute timestamp, using the same time
1316 reference as :meth:`loop.time`.
1317
1318 .. versionadded:: 3.7
1319
1320
1321Server Objects
1322==============
1323
1324Server objects are created by :meth:`loop.create_server`,
1325:meth:`loop.create_unix_server`, :func:`start_server`,
1326and :func:`start_unix_server` functions.
1327
1328Do not instantiate the class directly.
Victor Stinner8c462c52014-01-24 18:11:43 +01001329
Victor Stinner8ebeb032014-07-11 23:47:40 +02001330.. class:: Server
Victor Stinner8c462c52014-01-24 18:11:43 +01001331
Yury Selivanovc9070d02018-01-25 18:08:09 -05001332 *Server* objects are asynchronous context managers. When used in an
1333 ``async with`` statement, it's guaranteed that the Server object is
1334 closed and not accepting new connections when the ``async with``
1335 statement is completed::
1336
1337 srv = await loop.create_server(...)
1338
1339 async with srv:
1340 # some code
1341
Carol Willing5b7cbd62018-09-12 17:05:17 -07001342 # At this point, srv is closed and no longer accepts new connections.
Yury Selivanovc9070d02018-01-25 18:08:09 -05001343
1344
1345 .. versionchanged:: 3.7
1346 Server object is an asynchronous context manager since Python 3.7.
Victor Stinner8c462c52014-01-24 18:11:43 +01001347
1348 .. method:: close()
1349
Victor Stinner4bfb14a2014-07-12 03:20:24 +02001350 Stop serving: close listening sockets and set the :attr:`sockets`
1351 attribute to ``None``.
1352
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001353 The sockets that represent existing incoming client connections
1354 are left open.
Victor Stinner8ebeb032014-07-11 23:47:40 +02001355
Berker Peksag49c9edf2016-01-20 07:14:22 +02001356 The server is closed asynchronously, use the :meth:`wait_closed`
1357 coroutine to wait until the server is closed.
Victor Stinner8c462c52014-01-24 18:11:43 +01001358
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)1634fc22017-12-30 20:39:32 +05301359 .. method:: get_loop()
1360
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001361 Return the event loop associated with the server object.
Srinivas Reddy Thatiparthy (శ్రీనివాస్ రెడ్డి తాటిపర్తి)1634fc22017-12-30 20:39:32 +05301362
1363 .. versionadded:: 3.7
1364
Yury Selivanovc9070d02018-01-25 18:08:09 -05001365 .. coroutinemethod:: start_serving()
1366
1367 Start accepting connections.
1368
1369 This method is idempotent, so it can be called when
1370 the server is already being serving.
1371
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001372 The *start_serving* keyword-only parameter to
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001373 :meth:`loop.create_server` and
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001374 :meth:`asyncio.start_server` allows creating a Server object
1375 that is not accepting connections initially. In this case
1376 ``Server.start_serving()``, or :meth:`Server.serve_forever` can be used
1377 to make the Server start accepting connections.
Yury Selivanovc9070d02018-01-25 18:08:09 -05001378
1379 .. versionadded:: 3.7
1380
1381 .. coroutinemethod:: serve_forever()
1382
1383 Start accepting connections until the coroutine is cancelled.
1384 Cancellation of ``serve_forever`` task causes the server
1385 to be closed.
1386
1387 This method can be called if the server is already accepting
1388 connections. Only one ``serve_forever`` task can exist per
1389 one *Server* object.
1390
1391 Example::
1392
1393 async def client_connected(reader, writer):
1394 # Communicate with the client with
1395 # reader/writer streams. For example:
1396 await reader.readline()
1397
1398 async def main(host, port):
1399 srv = await asyncio.start_server(
1400 client_connected, host, port)
Andrew Svetlov17ab8f02018-02-17 19:44:35 +02001401 await srv.serve_forever()
Yury Selivanovc9070d02018-01-25 18:08:09 -05001402
1403 asyncio.run(main('127.0.0.1', 0))
1404
1405 .. versionadded:: 3.7
1406
1407 .. method:: is_serving()
1408
1409 Return ``True`` if the server is accepting new connections.
1410
1411 .. versionadded:: 3.7
1412
Victor Stinnerbdd574d2015-02-12 22:49:18 +01001413 .. coroutinemethod:: wait_closed()
Victor Stinner8c462c52014-01-24 18:11:43 +01001414
Victor Stinner8ebeb032014-07-11 23:47:40 +02001415 Wait until the :meth:`close` method completes.
1416
Victor Stinner8ebeb032014-07-11 23:47:40 +02001417 .. attribute:: sockets
1418
Emmanuel Ariasdf5cdc12019-02-22 14:34:41 -03001419 List of :class:`socket.socket` objects the server is listening on.
Victor Stinner8c462c52014-01-24 18:11:43 +01001420
Yury Selivanovc9070d02018-01-25 18:08:09 -05001421 .. versionchanged:: 3.7
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001422 Prior to Python 3.7 ``Server.sockets`` used to return an
1423 internal list of server sockets directly. In 3.7 a copy
Yury Selivanovc9070d02018-01-25 18:08:09 -05001424 of that list is returned.
1425
Victor Stinner8c462c52014-01-24 18:11:43 +01001426
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001427.. _asyncio-event-loops:
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001428
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001429Event Loop Implementations
1430==========================
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001431
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001432asyncio ships with two different event loop implementations:
1433:class:`SelectorEventLoop` and :class:`ProactorEventLoop`.
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001434
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001435By default asyncio is configured to use :class:`SelectorEventLoop`
1436on all platforms.
Andrew Svetlov3d4dbd82018-02-01 19:59:32 +02001437
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001438
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001439.. class:: SelectorEventLoop
1440
1441 An event loop based on the :mod:`selectors` module.
1442
1443 Uses the most efficient *selector* available for the given
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001444 platform. It is also possible to manually configure the
1445 exact selector implementation to be used::
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001446
1447 import asyncio
1448 import selectors
1449
1450 selector = selectors.SelectSelector()
1451 loop = asyncio.SelectorEventLoop(selector)
1452 asyncio.set_event_loop(loop)
Andrew Svetlov7464e872018-01-19 20:04:29 +02001453
1454
Cheryl Sabella2d6097d2018-10-12 10:55:20 -04001455 .. availability:: Unix, Windows.
Andrew Svetlov7464e872018-01-19 20:04:29 +02001456
1457
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001458.. class:: ProactorEventLoop
1459
1460 An event loop for Windows that uses "I/O Completion Ports" (IOCP).
1461
Cheryl Sabella2d6097d2018-10-12 10:55:20 -04001462 .. availability:: Windows.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001463
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001464 .. seealso::
1465
1466 `MSDN documentation on I/O Completion Ports
1467 <https://docs.microsoft.com/en-ca/windows/desktop/FileIO/i-o-completion-ports>`_.
1468
1469
1470.. class:: AbstractEventLoop
1471
1472 Abstract base class for asyncio-compliant event loops.
1473
1474 The :ref:`Event Loop Methods <asyncio-event-loop>` section lists all
1475 methods that an alternative implementation of ``AbstractEventLoop``
1476 should have defined.
1477
1478
1479Examples
1480========
1481
1482Note that all examples in this section **purposefully** show how
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001483to use the low-level event loop APIs, such as :meth:`loop.run_forever`
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001484and :meth:`loop.call_soon`. Modern asyncio applications rarely
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001485need to be written this way; consider using the high-level functions
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001486like :func:`asyncio.run`.
1487
Yury Selivanov43ee1c12014-02-19 20:58:44 -05001488
Yury Selivanov394374e2018-09-17 15:35:24 -04001489.. _asyncio_example_lowlevel_helloworld:
Victor Stinnerea3183f2013-12-03 01:08:00 +01001490
Victor Stinner7f314ed2014-10-15 18:49:16 +02001491Hello World with call_soon()
Victor Stinnera092a612015-01-09 15:58:41 +01001492^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinnerea3183f2013-12-03 01:08:00 +01001493
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001494An example using the :meth:`loop.call_soon` method to schedule a
1495callback. The callback displays ``"Hello World"`` and then stops the
1496event loop::
Victor Stinnerea3183f2013-12-03 01:08:00 +01001497
1498 import asyncio
1499
Victor Stinner7f314ed2014-10-15 18:49:16 +02001500 def hello_world(loop):
Carol Willing5b7cbd62018-09-12 17:05:17 -07001501 """A callback to print 'Hello World' and stop the event loop"""
Victor Stinnerea3183f2013-12-03 01:08:00 +01001502 print('Hello World')
Victor Stinner7f314ed2014-10-15 18:49:16 +02001503 loop.stop()
Victor Stinnerea3183f2013-12-03 01:08:00 +01001504
1505 loop = asyncio.get_event_loop()
Victor Stinner7f314ed2014-10-15 18:49:16 +02001506
1507 # Schedule a call to hello_world()
1508 loop.call_soon(hello_world, loop)
1509
1510 # Blocking call interrupted by loop.stop()
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001511 try:
1512 loop.run_forever()
1513 finally:
1514 loop.close()
Victor Stinnerea3183f2013-12-03 01:08:00 +01001515
Victor Stinner3e09e322013-12-03 01:22:06 +01001516.. seealso::
Victor Stinnerea3183f2013-12-03 01:08:00 +01001517
Yury Selivanov3faaa882018-09-14 13:32:07 -07001518 A similar :ref:`Hello World <coroutine>`
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001519 example created with a coroutine and the :func:`run` function.
Victor Stinnerea3183f2013-12-03 01:08:00 +01001520
Victor Stinner8b863482014-01-27 10:07:50 +01001521
Yury Selivanov394374e2018-09-17 15:35:24 -04001522.. _asyncio_example_call_later:
Victor Stinner7f314ed2014-10-15 18:49:16 +02001523
1524Display the current date with call_later()
Victor Stinnera092a612015-01-09 15:58:41 +01001525^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinner7f314ed2014-10-15 18:49:16 +02001526
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001527An example of a callback displaying the current date every second. The
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001528callback uses the :meth:`loop.call_later` method to reschedule itself
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001529after 5 seconds, and then stops the event loop::
Victor Stinner7f314ed2014-10-15 18:49:16 +02001530
1531 import asyncio
1532 import datetime
1533
1534 def display_date(end_time, loop):
1535 print(datetime.datetime.now())
1536 if (loop.time() + 1.0) < end_time:
1537 loop.call_later(1, display_date, end_time, loop)
1538 else:
1539 loop.stop()
1540
1541 loop = asyncio.get_event_loop()
1542
1543 # Schedule the first call to display_date()
1544 end_time = loop.time() + 5.0
1545 loop.call_soon(display_date, end_time, loop)
1546
1547 # Blocking call interrupted by loop.stop()
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001548 try:
1549 loop.run_forever()
1550 finally:
1551 loop.close()
Victor Stinner7f314ed2014-10-15 18:49:16 +02001552
1553.. seealso::
1554
Yury Selivanov7372c3b2018-09-14 15:11:24 -07001555 A similar :ref:`current date <asyncio_example_sleep>` example
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001556 created with a coroutine and the :func:`run` function.
Victor Stinner7f314ed2014-10-15 18:49:16 +02001557
1558
Yury Selivanov394374e2018-09-17 15:35:24 -04001559.. _asyncio_example_watch_fd:
Victor Stinner8b863482014-01-27 10:07:50 +01001560
Victor Stinner04e6df32014-10-11 16:16:27 +02001561Watch a file descriptor for read events
Victor Stinnera092a612015-01-09 15:58:41 +01001562^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinner04e6df32014-10-11 16:16:27 +02001563
1564Wait until a file descriptor received some data using the
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001565:meth:`loop.add_reader` method and then close the event loop::
Victor Stinner04e6df32014-10-11 16:16:27 +02001566
1567 import asyncio
Victor Stinnerac577d72017-11-28 21:33:20 +01001568 from socket import socketpair
Victor Stinner04e6df32014-10-11 16:16:27 +02001569
1570 # Create a pair of connected file descriptors
Victor Stinnerccd8e342014-10-11 16:30:02 +02001571 rsock, wsock = socketpair()
Carol Willing5b7cbd62018-09-12 17:05:17 -07001572
Victor Stinner04e6df32014-10-11 16:16:27 +02001573 loop = asyncio.get_event_loop()
1574
1575 def reader():
1576 data = rsock.recv(100)
1577 print("Received:", data.decode())
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001578
Victor Stinner2cef3002014-10-23 22:38:46 +02001579 # We are done: unregister the file descriptor
Victor Stinner04e6df32014-10-11 16:16:27 +02001580 loop.remove_reader(rsock)
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001581
Victor Stinner04e6df32014-10-11 16:16:27 +02001582 # Stop the event loop
1583 loop.stop()
1584
Victor Stinner2cef3002014-10-23 22:38:46 +02001585 # Register the file descriptor for read event
Victor Stinner04e6df32014-10-11 16:16:27 +02001586 loop.add_reader(rsock, reader)
1587
1588 # Simulate the reception of data from the network
1589 loop.call_soon(wsock.send, 'abc'.encode())
1590
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001591 try:
1592 # Run the event loop
1593 loop.run_forever()
1594 finally:
Carol Willing5b7cbd62018-09-12 17:05:17 -07001595 # We are done. Close sockets and the event loop.
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001596 rsock.close()
1597 wsock.close()
1598 loop.close()
Victor Stinner04e6df32014-10-11 16:16:27 +02001599
1600.. seealso::
1601
Yury Selivanov394374e2018-09-17 15:35:24 -04001602 * A similar :ref:`example <asyncio_example_create_connection>`
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001603 using transports, protocols, and the
1604 :meth:`loop.create_connection` method.
Victor Stinner04e6df32014-10-11 16:16:27 +02001605
Yury Selivanov394374e2018-09-17 15:35:24 -04001606 * Another similar :ref:`example <asyncio_example_create_connection-streams>`
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001607 using the high-level :func:`asyncio.open_connection` function
1608 and streams.
Victor Stinner04e6df32014-10-11 16:16:27 +02001609
1610
Yury Selivanov394374e2018-09-17 15:35:24 -04001611.. _asyncio_example_unix_signals:
1612
Victor Stinner04e6df32014-10-11 16:16:27 +02001613Set signal handlers for SIGINT and SIGTERM
Victor Stinnera092a612015-01-09 15:58:41 +01001614^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Victor Stinner04e6df32014-10-11 16:16:27 +02001615
Elvis Pranskevichus1fa2ec42018-09-17 19:16:44 -04001616(This ``signals`` example only works on Unix.)
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001617
1618Register handlers for signals :py:data:`SIGINT` and :py:data:`SIGTERM`
1619using the :meth:`loop.add_signal_handler` method::
Victor Stinner8b863482014-01-27 10:07:50 +01001620
1621 import asyncio
1622 import functools
1623 import os
1624 import signal
1625
Alexander Vasinceb842e2019-05-03 18:25:36 +03001626 def ask_exit(signame, loop):
Victor Stinner8b863482014-01-27 10:07:50 +01001627 print("got signal %s: exit" % signame)
1628 loop.stop()
1629
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001630 async def main():
1631 loop = asyncio.get_running_loop()
Victor Stinner8b863482014-01-27 10:07:50 +01001632
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001633 for signame in {'SIGINT', 'SIGTERM'}:
1634 loop.add_signal_handler(
1635 getattr(signal, signame),
Alexander Vasinceb842e2019-05-03 18:25:36 +03001636 functools.partial(ask_exit, signame, loop))
Victor Stinner2cef3002014-10-23 22:38:46 +02001637
Yury Selivanov7c7605f2018-09-11 09:54:40 -07001638 await asyncio.sleep(3600)
1639
1640 print("Event loop running for 1 hour, press Ctrl+C to interrupt.")
1641 print(f"pid {os.getpid()}: send SIGINT or SIGTERM to exit.")
1642
1643 asyncio.run(main())