blob: 60a189bdfb7ec9c609fb0577de8e13ac0990fbc3 [file] [log] [blame]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001"""Base implementation of event loop.
2
3The event loop can be broken up into a multiplexer (the part
Victor Stinneracdb7822014-07-14 18:33:40 +02004responsible for notifying us of I/O events) and the event loop proper,
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07005which wraps a multiplexer with functionality for scheduling callbacks,
6immediately or at a given time in the future.
7
8Whenever a public API takes a callback, subsequent positional
9arguments will be passed to the callback if/when it is called. This
10avoids the proliferation of trivial lambdas implementing closures.
11Keyword arguments for the callback are not supported; this is a
12conscious design decision, leaving the door open for keyword arguments
13to modify the meaning of the API call itself.
14"""
15
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070016import collections
Serhiy Storchaka2e576f52017-04-24 09:05:00 +030017import collections.abc
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070018import concurrent.futures
19import heapq
Victor Stinner5e4a7d82015-09-21 18:33:43 +020020import itertools
Victor Stinnerb75380f2014-06-30 14:39:11 +020021import os
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070022import socket
23import subprocess
Victor Stinner956de692014-12-26 21:07:52 +010024import threading
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070025import time
Victor Stinnerb75380f2014-06-30 14:39:11 +020026import traceback
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070027import sys
Victor Stinner978a9af2015-01-29 17:50:58 +010028import warnings
Yury Selivanoveb636452016-09-08 22:01:51 -070029import weakref
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070030
Yury Selivanovf111b3d2017-12-30 00:35:36 -050031try:
32 import ssl
33except ImportError: # pragma: no cover
34 ssl = None
35
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080036from . import constants
Victor Stinnerf951d282014-06-29 00:46:45 +020037from . import coroutines
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070038from . import events
Andrew Svetlov0baa72f2018-09-11 10:13:04 -070039from . import exceptions
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070040from . import futures
Andrew Svetlov7c684072018-01-27 21:22:47 +020041from . import protocols
Yury Selivanovf111b3d2017-12-30 00:35:36 -050042from . import sslproto
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070043from . import tasks
Andrew Svetlov7c684072018-01-27 21:22:47 +020044from . import transports
Guido van Rossumfc29e0f2013-10-17 15:39:45 -070045from .log import logger
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070046
47
Yury Selivanov6370f342017-12-10 18:36:12 -050048__all__ = 'BaseEventLoop',
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070049
50
Yury Selivanov592ada92014-09-25 12:07:56 -040051# Minimum number of _scheduled timer handles before cleanup of
52# cancelled handles is performed.
53_MIN_SCHEDULED_TIMER_HANDLES = 100
54
55# Minimum fraction of _scheduled timer handles that are cancelled
56# before cleanup of cancelled handles is performed.
57_MIN_CANCELLED_TIMER_HANDLES_FRACTION = 0.5
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070058
Victor Stinnerc94a93a2016-04-01 21:43:39 +020059# Exceptions which must not call the exception handler in fatal error
60# methods (_fatal_error())
61_FATAL_ERROR_IGNORE = (BrokenPipeError,
62 ConnectionResetError, ConnectionAbortedError)
63
Andrew Svetlov0dd71802018-09-12 14:03:54 -070064if ssl is not None:
65 _FATAL_ERROR_IGNORE = _FATAL_ERROR_IGNORE + (ssl.SSLCertVerificationError,)
66
Yury Selivanovd904c232018-06-28 21:59:32 -040067_HAS_IPv6 = hasattr(socket, 'AF_INET6')
68
MartinAltmayer944451c2018-07-31 15:06:12 +010069# Maximum timeout passed to select to avoid OS limitations
70MAXIMUM_SELECT_TIMEOUT = 24 * 3600
71
Victor Stinnerc94a93a2016-04-01 21:43:39 +020072
Victor Stinner0e6f52a2014-06-20 17:34:15 +020073def _format_handle(handle):
74 cb = handle._callback
Yury Selivanova0c1ba62016-10-28 12:52:37 -040075 if isinstance(getattr(cb, '__self__', None), tasks.Task):
Victor Stinner0e6f52a2014-06-20 17:34:15 +020076 # format the task
77 return repr(cb.__self__)
78 else:
79 return str(handle)
80
81
Victor Stinneracdb7822014-07-14 18:33:40 +020082def _format_pipe(fd):
83 if fd == subprocess.PIPE:
84 return '<pipe>'
85 elif fd == subprocess.STDOUT:
86 return '<stdout>'
87 else:
88 return repr(fd)
89
90
Yury Selivanov5587d7c2016-09-15 15:45:07 -040091def _set_reuseport(sock):
92 if not hasattr(socket, 'SO_REUSEPORT'):
93 raise ValueError('reuse_port not supported by socket module')
94 else:
95 try:
96 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
97 except OSError:
98 raise ValueError('reuse_port not supported by socket module, '
99 'SO_REUSEPORT defined but not implemented.')
100
101
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500102def _ipaddr_info(host, port, family, type, proto):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400103 # Try to skip getaddrinfo if "host" is already an IP. Users might have
104 # handled name resolution in their own code and pass in resolved IPs.
105 if not hasattr(socket, 'inet_pton'):
106 return
107
108 if proto not in {0, socket.IPPROTO_TCP, socket.IPPROTO_UDP} or \
109 host is None:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500110 return None
111
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500112 if type == socket.SOCK_STREAM:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500113 proto = socket.IPPROTO_TCP
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500114 elif type == socket.SOCK_DGRAM:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500115 proto = socket.IPPROTO_UDP
116 else:
117 return None
118
Yury Selivanova7146162016-06-02 16:51:07 -0400119 if port is None:
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400120 port = 0
Guido van Rossume3c65a72016-09-30 08:17:15 -0700121 elif isinstance(port, bytes) and port == b'':
122 port = 0
123 elif isinstance(port, str) and port == '':
124 port = 0
125 else:
126 # If port's a service name like "http", don't skip getaddrinfo.
127 try:
128 port = int(port)
129 except (TypeError, ValueError):
130 return None
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400131
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400132 if family == socket.AF_UNSPEC:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500133 afs = [socket.AF_INET]
Yury Selivanovd904c232018-06-28 21:59:32 -0400134 if _HAS_IPv6:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500135 afs.append(socket.AF_INET6)
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400136 else:
137 afs = [family]
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500138
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400139 if isinstance(host, bytes):
140 host = host.decode('idna')
141 if '%' in host:
142 # Linux's inet_pton doesn't accept an IPv6 zone index after host,
143 # like '::1%lo0'.
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500144 return None
145
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400146 for af in afs:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500147 try:
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400148 socket.inet_pton(af, host)
149 # The host has already been resolved.
Yury Selivanovd904c232018-06-28 21:59:32 -0400150 if _HAS_IPv6 and af == socket.AF_INET6:
151 return af, type, proto, '', (host, port, 0, 0)
152 else:
153 return af, type, proto, '', (host, port)
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400154 except OSError:
155 pass
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500156
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400157 # "host" is not an IP address.
158 return None
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500159
160
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100161def _run_until_complete_cb(fut):
Yury Selivanov36c2c042017-12-19 07:19:53 -0500162 if not fut.cancelled():
163 exc = fut.exception()
164 if isinstance(exc, BaseException) and not isinstance(exc, Exception):
165 # Issue #22429: run_forever() already finished, no need to
166 # stop it.
167 return
Yury Selivanovca9b36c2017-12-23 15:04:15 -0500168 futures._get_loop(fut).stop()
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100169
170
Andrew Svetlov3bc0eba2018-12-03 21:08:13 +0200171if hasattr(socket, 'TCP_NODELAY'):
172 def _set_nodelay(sock):
173 if (sock.family in {socket.AF_INET, socket.AF_INET6} and
174 sock.type == socket.SOCK_STREAM and
175 sock.proto == socket.IPPROTO_TCP):
176 sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
177else:
178 def _set_nodelay(sock):
179 pass
180
181
Andrew Svetlov7c684072018-01-27 21:22:47 +0200182class _SendfileFallbackProtocol(protocols.Protocol):
183 def __init__(self, transp):
184 if not isinstance(transp, transports._FlowControlMixin):
185 raise TypeError("transport should be _FlowControlMixin instance")
186 self._transport = transp
187 self._proto = transp.get_protocol()
188 self._should_resume_reading = transp.is_reading()
189 self._should_resume_writing = transp._protocol_paused
190 transp.pause_reading()
191 transp.set_protocol(self)
192 if self._should_resume_writing:
193 self._write_ready_fut = self._transport._loop.create_future()
194 else:
195 self._write_ready_fut = None
196
197 async def drain(self):
198 if self._transport.is_closing():
199 raise ConnectionError("Connection closed by peer")
200 fut = self._write_ready_fut
201 if fut is None:
202 return
203 await fut
204
205 def connection_made(self, transport):
206 raise RuntimeError("Invalid state: "
207 "connection should have been established already.")
208
209 def connection_lost(self, exc):
210 if self._write_ready_fut is not None:
211 # Never happens if peer disconnects after sending the whole content
212 # Thus disconnection is always an exception from user perspective
213 if exc is None:
214 self._write_ready_fut.set_exception(
215 ConnectionError("Connection is closed by peer"))
216 else:
217 self._write_ready_fut.set_exception(exc)
218 self._proto.connection_lost(exc)
219
220 def pause_writing(self):
221 if self._write_ready_fut is not None:
222 return
223 self._write_ready_fut = self._transport._loop.create_future()
224
225 def resume_writing(self):
226 if self._write_ready_fut is None:
227 return
228 self._write_ready_fut.set_result(False)
229 self._write_ready_fut = None
230
231 def data_received(self, data):
232 raise RuntimeError("Invalid state: reading should be paused")
233
234 def eof_received(self):
235 raise RuntimeError("Invalid state: reading should be paused")
236
237 async def restore(self):
238 self._transport.set_protocol(self._proto)
239 if self._should_resume_reading:
240 self._transport.resume_reading()
241 if self._write_ready_fut is not None:
242 # Cancel the future.
243 # Basically it has no effect because protocol is switched back,
244 # no code should wait for it anymore.
245 self._write_ready_fut.cancel()
246 if self._should_resume_writing:
247 self._proto.resume_writing()
248
249
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700250class Server(events.AbstractServer):
251
Yury Selivanovc9070d02018-01-25 18:08:09 -0500252 def __init__(self, loop, sockets, protocol_factory, ssl_context, backlog,
253 ssl_handshake_timeout):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200254 self._loop = loop
Yury Selivanovc9070d02018-01-25 18:08:09 -0500255 self._sockets = sockets
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200256 self._active_count = 0
257 self._waiters = []
Yury Selivanovc9070d02018-01-25 18:08:09 -0500258 self._protocol_factory = protocol_factory
259 self._backlog = backlog
260 self._ssl_context = ssl_context
261 self._ssl_handshake_timeout = ssl_handshake_timeout
262 self._serving = False
263 self._serving_forever_fut = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700264
Victor Stinnere912e652014-07-12 03:11:53 +0200265 def __repr__(self):
Yury Selivanov6370f342017-12-10 18:36:12 -0500266 return f'<{self.__class__.__name__} sockets={self.sockets!r}>'
Victor Stinnere912e652014-07-12 03:11:53 +0200267
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200268 def _attach(self):
Yury Selivanovc9070d02018-01-25 18:08:09 -0500269 assert self._sockets is not None
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200270 self._active_count += 1
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700271
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200272 def _detach(self):
273 assert self._active_count > 0
274 self._active_count -= 1
Yury Selivanovc9070d02018-01-25 18:08:09 -0500275 if self._active_count == 0 and self._sockets is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700276 self._wakeup()
277
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700278 def _wakeup(self):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200279 waiters = self._waiters
280 self._waiters = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700281 for waiter in waiters:
282 if not waiter.done():
283 waiter.set_result(waiter)
284
Yury Selivanovc9070d02018-01-25 18:08:09 -0500285 def _start_serving(self):
286 if self._serving:
287 return
288 self._serving = True
289 for sock in self._sockets:
290 sock.listen(self._backlog)
291 self._loop._start_serving(
292 self._protocol_factory, sock, self._ssl_context,
293 self, self._backlog, self._ssl_handshake_timeout)
294
295 def get_loop(self):
296 return self._loop
297
298 def is_serving(self):
299 return self._serving
300
301 @property
302 def sockets(self):
303 if self._sockets is None:
304 return []
305 return list(self._sockets)
306
307 def close(self):
308 sockets = self._sockets
309 if sockets is None:
310 return
311 self._sockets = None
312
313 for sock in sockets:
314 self._loop._stop_serving(sock)
315
316 self._serving = False
317
318 if (self._serving_forever_fut is not None and
319 not self._serving_forever_fut.done()):
320 self._serving_forever_fut.cancel()
321 self._serving_forever_fut = None
322
323 if self._active_count == 0:
324 self._wakeup()
325
326 async def start_serving(self):
327 self._start_serving()
Yury Selivanovdbf10222018-05-28 14:31:28 -0400328 # Skip one loop iteration so that all 'loop.add_reader'
329 # go through.
330 await tasks.sleep(0, loop=self._loop)
Yury Selivanovc9070d02018-01-25 18:08:09 -0500331
332 async def serve_forever(self):
333 if self._serving_forever_fut is not None:
334 raise RuntimeError(
335 f'server {self!r} is already being awaited on serve_forever()')
336 if self._sockets is None:
337 raise RuntimeError(f'server {self!r} is closed')
338
339 self._start_serving()
340 self._serving_forever_fut = self._loop.create_future()
341
342 try:
343 await self._serving_forever_fut
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700344 except exceptions.CancelledError:
Yury Selivanovc9070d02018-01-25 18:08:09 -0500345 try:
346 self.close()
347 await self.wait_closed()
348 finally:
349 raise
350 finally:
351 self._serving_forever_fut = None
352
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200353 async def wait_closed(self):
Yury Selivanovc9070d02018-01-25 18:08:09 -0500354 if self._sockets is None or self._waiters is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700355 return
Yury Selivanov7661db62016-05-16 15:38:39 -0400356 waiter = self._loop.create_future()
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200357 self._waiters.append(waiter)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200358 await waiter
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700359
360
361class BaseEventLoop(events.AbstractEventLoop):
362
363 def __init__(self):
Yury Selivanov592ada92014-09-25 12:07:56 -0400364 self._timer_cancelled_count = 0
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200365 self._closed = False
Guido van Rossum41f69f42015-11-19 13:28:47 -0800366 self._stopping = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700367 self._ready = collections.deque()
368 self._scheduled = []
369 self._default_executor = None
370 self._internal_fds = 0
Victor Stinner956de692014-12-26 21:07:52 +0100371 # Identifier of the thread running the event loop, or None if the
372 # event loop is not running
Victor Stinnera87501f2015-02-05 11:45:33 +0100373 self._thread_id = None
Victor Stinnered1654f2014-02-10 23:42:32 +0100374 self._clock_resolution = time.get_clock_info('monotonic').resolution
Yury Selivanov569efa22014-02-18 18:02:19 -0500375 self._exception_handler = None
Victor Stinner44862df2017-11-20 07:14:07 -0800376 self.set_debug(coroutines._is_debug_mode())
Victor Stinner0e6f52a2014-06-20 17:34:15 +0200377 # In debug mode, if the execution of a callback or a step of a task
378 # exceed this duration in seconds, the slow callback/task is logged.
379 self.slow_callback_duration = 0.1
Victor Stinner9b524d52015-01-26 11:05:12 +0100380 self._current_handle = None
Yury Selivanov740169c2015-05-11 14:23:38 -0400381 self._task_factory = None
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800382 self._coroutine_origin_tracking_enabled = False
383 self._coroutine_origin_tracking_saved_depth = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700384
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500385 # A weak set of all asynchronous generators that are
386 # being iterated by the loop.
387 self._asyncgens = weakref.WeakSet()
Yury Selivanoveb636452016-09-08 22:01:51 -0700388 # Set to True when `loop.shutdown_asyncgens` is called.
389 self._asyncgens_shutdown_called = False
390
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200391 def __repr__(self):
Yury Selivanov6370f342017-12-10 18:36:12 -0500392 return (
393 f'<{self.__class__.__name__} running={self.is_running()} '
394 f'closed={self.is_closed()} debug={self.get_debug()}>'
395 )
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200396
Yury Selivanov7661db62016-05-16 15:38:39 -0400397 def create_future(self):
398 """Create a Future object attached to the loop."""
399 return futures.Future(loop=self)
400
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300401 def create_task(self, coro, *, name=None):
Victor Stinner896a25a2014-07-08 11:29:25 +0200402 """Schedule a coroutine object.
403
Victor Stinneracdb7822014-07-14 18:33:40 +0200404 Return a task object.
405 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100406 self._check_closed()
Yury Selivanov740169c2015-05-11 14:23:38 -0400407 if self._task_factory is None:
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300408 task = tasks.Task(coro, loop=self, name=name)
Yury Selivanov740169c2015-05-11 14:23:38 -0400409 if task._source_traceback:
410 del task._source_traceback[-1]
411 else:
412 task = self._task_factory(self, coro)
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300413 tasks._set_task_name(task, name)
414
Victor Stinnerc39ba7d2014-07-11 00:21:27 +0200415 return task
Victor Stinner896a25a2014-07-08 11:29:25 +0200416
Yury Selivanov740169c2015-05-11 14:23:38 -0400417 def set_task_factory(self, factory):
418 """Set a task factory that will be used by loop.create_task().
419
420 If factory is None the default task factory will be set.
421
422 If factory is a callable, it should have a signature matching
423 '(loop, coro)', where 'loop' will be a reference to the active
424 event loop, 'coro' will be a coroutine object. The callable
425 must return a Future.
426 """
427 if factory is not None and not callable(factory):
428 raise TypeError('task factory must be a callable or None')
429 self._task_factory = factory
430
431 def get_task_factory(self):
432 """Return a task factory, or None if the default one is in use."""
433 return self._task_factory
434
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700435 def _make_socket_transport(self, sock, protocol, waiter=None, *,
436 extra=None, server=None):
437 """Create socket transport."""
438 raise NotImplementedError
439
Neil Aspinallf7686c12017-12-19 19:45:42 +0000440 def _make_ssl_transport(
441 self, rawsock, protocol, sslcontext, waiter=None,
442 *, server_side=False, server_hostname=None,
443 extra=None, server=None,
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500444 ssl_handshake_timeout=None,
445 call_connection_made=True):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700446 """Create SSL transport."""
447 raise NotImplementedError
448
449 def _make_datagram_transport(self, sock, protocol,
Victor Stinnerbfff45d2014-07-08 23:57:31 +0200450 address=None, waiter=None, extra=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700451 """Create datagram transport."""
452 raise NotImplementedError
453
454 def _make_read_pipe_transport(self, pipe, protocol, waiter=None,
455 extra=None):
456 """Create read pipe transport."""
457 raise NotImplementedError
458
459 def _make_write_pipe_transport(self, pipe, protocol, waiter=None,
460 extra=None):
461 """Create write pipe transport."""
462 raise NotImplementedError
463
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200464 async def _make_subprocess_transport(self, protocol, args, shell,
465 stdin, stdout, stderr, bufsize,
466 extra=None, **kwargs):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700467 """Create subprocess transport."""
468 raise NotImplementedError
469
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700470 def _write_to_self(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200471 """Write a byte to self-pipe, to wake up the event loop.
472
473 This may be called from a different thread.
474
475 The subclass is responsible for implementing the self-pipe.
476 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700477 raise NotImplementedError
478
479 def _process_events(self, event_list):
480 """Process selector events."""
481 raise NotImplementedError
482
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200483 def _check_closed(self):
484 if self._closed:
485 raise RuntimeError('Event loop is closed')
486
Yury Selivanoveb636452016-09-08 22:01:51 -0700487 def _asyncgen_finalizer_hook(self, agen):
488 self._asyncgens.discard(agen)
489 if not self.is_closed():
twisteroid ambassadorc880ffe2018-10-09 23:30:21 +0800490 self.call_soon_threadsafe(self.create_task, agen.aclose())
Yury Selivanoveb636452016-09-08 22:01:51 -0700491
492 def _asyncgen_firstiter_hook(self, agen):
493 if self._asyncgens_shutdown_called:
494 warnings.warn(
Yury Selivanov6370f342017-12-10 18:36:12 -0500495 f"asynchronous generator {agen!r} was scheduled after "
496 f"loop.shutdown_asyncgens() call",
Yury Selivanoveb636452016-09-08 22:01:51 -0700497 ResourceWarning, source=self)
498
499 self._asyncgens.add(agen)
500
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200501 async def shutdown_asyncgens(self):
Yury Selivanoveb636452016-09-08 22:01:51 -0700502 """Shutdown all active asynchronous generators."""
503 self._asyncgens_shutdown_called = True
504
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500505 if not len(self._asyncgens):
Yury Selivanov0a91d482016-09-15 13:24:03 -0400506 # If Python version is <3.6 or we don't have any asynchronous
507 # generators alive.
Yury Selivanoveb636452016-09-08 22:01:51 -0700508 return
509
510 closing_agens = list(self._asyncgens)
511 self._asyncgens.clear()
512
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200513 results = await tasks.gather(
Yury Selivanoveb636452016-09-08 22:01:51 -0700514 *[ag.aclose() for ag in closing_agens],
515 return_exceptions=True,
516 loop=self)
517
Yury Selivanoveb636452016-09-08 22:01:51 -0700518 for result, agen in zip(results, closing_agens):
519 if isinstance(result, Exception):
520 self.call_exception_handler({
Yury Selivanov6370f342017-12-10 18:36:12 -0500521 'message': f'an error occurred during closing of '
522 f'asynchronous generator {agen!r}',
Yury Selivanoveb636452016-09-08 22:01:51 -0700523 'exception': result,
524 'asyncgen': agen
525 })
526
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700527 def run_forever(self):
528 """Run until stop() is called."""
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200529 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100530 if self.is_running():
Yury Selivanov600a3492016-11-04 14:29:28 -0400531 raise RuntimeError('This event loop is already running')
532 if events._get_running_loop() is not None:
533 raise RuntimeError(
534 'Cannot run the event loop while another loop is running')
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800535 self._set_coroutine_origin_tracking(self._debug)
Victor Stinnera87501f2015-02-05 11:45:33 +0100536 self._thread_id = threading.get_ident()
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500537
538 old_agen_hooks = sys.get_asyncgen_hooks()
539 sys.set_asyncgen_hooks(firstiter=self._asyncgen_firstiter_hook,
540 finalizer=self._asyncgen_finalizer_hook)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700541 try:
Yury Selivanov600a3492016-11-04 14:29:28 -0400542 events._set_running_loop(self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700543 while True:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800544 self._run_once()
545 if self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700546 break
547 finally:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800548 self._stopping = False
Victor Stinnera87501f2015-02-05 11:45:33 +0100549 self._thread_id = None
Yury Selivanov600a3492016-11-04 14:29:28 -0400550 events._set_running_loop(None)
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800551 self._set_coroutine_origin_tracking(False)
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500552 sys.set_asyncgen_hooks(*old_agen_hooks)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700553
554 def run_until_complete(self, future):
555 """Run until the Future is done.
556
557 If the argument is a coroutine, it is wrapped in a Task.
558
Victor Stinneracdb7822014-07-14 18:33:40 +0200559 WARNING: It would be disastrous to call run_until_complete()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700560 with the same coroutine twice -- it would wrap it in two
561 different Tasks and that can't be good.
562
563 Return the Future's result, or raise its exception.
564 """
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200565 self._check_closed()
Victor Stinner98b63912014-06-30 14:51:04 +0200566
Guido van Rossum7b3b3dc2016-09-09 14:26:31 -0700567 new_task = not futures.isfuture(future)
Yury Selivanov59eb9a42015-05-11 14:48:38 -0400568 future = tasks.ensure_future(future, loop=self)
Victor Stinner98b63912014-06-30 14:51:04 +0200569 if new_task:
570 # An exception is raised if the future didn't complete, so there
571 # is no need to log the "destroy pending task" message
572 future._log_destroy_pending = False
573
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100574 future.add_done_callback(_run_until_complete_cb)
Victor Stinnerc8bd53f2014-10-11 14:30:18 +0200575 try:
576 self.run_forever()
577 except:
578 if new_task and future.done() and not future.cancelled():
579 # The coroutine raised a BaseException. Consume the exception
580 # to not log a warning, the caller doesn't have access to the
581 # local task.
582 future.exception()
583 raise
jimmylai21b3e042017-05-22 22:32:46 -0700584 finally:
585 future.remove_done_callback(_run_until_complete_cb)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700586 if not future.done():
587 raise RuntimeError('Event loop stopped before Future completed.')
588
589 return future.result()
590
591 def stop(self):
592 """Stop running the event loop.
593
Guido van Rossum41f69f42015-11-19 13:28:47 -0800594 Every callback already scheduled will still run. This simply informs
595 run_forever to stop looping after a complete iteration.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700596 """
Guido van Rossum41f69f42015-11-19 13:28:47 -0800597 self._stopping = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700598
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200599 def close(self):
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700600 """Close the event loop.
601
602 This clears the queues and shuts down the executor,
603 but does not wait for the executor to finish.
Victor Stinnerf328c7d2014-06-23 01:02:37 +0200604
605 The event loop must not be running.
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700606 """
Victor Stinner956de692014-12-26 21:07:52 +0100607 if self.is_running():
Victor Stinneracdb7822014-07-14 18:33:40 +0200608 raise RuntimeError("Cannot close a running event loop")
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200609 if self._closed:
610 return
Victor Stinnere912e652014-07-12 03:11:53 +0200611 if self._debug:
612 logger.debug("Close %r", self)
Yury Selivanove8944cb2015-05-12 11:43:04 -0400613 self._closed = True
614 self._ready.clear()
615 self._scheduled.clear()
616 executor = self._default_executor
617 if executor is not None:
618 self._default_executor = None
619 executor.shutdown(wait=False)
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200620
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200621 def is_closed(self):
622 """Returns True if the event loop was closed."""
623 return self._closed
624
INADA Naoki3e2ad8e2017-04-25 10:57:18 +0900625 def __del__(self):
626 if not self.is_closed():
Yury Selivanov6370f342017-12-10 18:36:12 -0500627 warnings.warn(f"unclosed event loop {self!r}", ResourceWarning,
INADA Naoki3e2ad8e2017-04-25 10:57:18 +0900628 source=self)
629 if not self.is_running():
630 self.close()
Victor Stinner978a9af2015-01-29 17:50:58 +0100631
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700632 def is_running(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200633 """Returns True if the event loop is running."""
Victor Stinnera87501f2015-02-05 11:45:33 +0100634 return (self._thread_id is not None)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700635
636 def time(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200637 """Return the time according to the event loop's clock.
638
639 This is a float expressed in seconds since an epoch, but the
640 epoch, precision, accuracy and drift are unspecified and may
641 differ per event loop.
642 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700643 return time.monotonic()
644
Yury Selivanovf23746a2018-01-22 19:11:18 -0500645 def call_later(self, delay, callback, *args, context=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700646 """Arrange for a callback to be called at a given time.
647
648 Return a Handle: an opaque object with a cancel() method that
649 can be used to cancel the call.
650
651 The delay can be an int or float, expressed in seconds. It is
Victor Stinneracdb7822014-07-14 18:33:40 +0200652 always relative to the current time.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700653
654 Each callback will be called exactly once. If two callbacks
655 are scheduled for exactly the same time, it undefined which
656 will be called first.
657
658 Any positional arguments after the callback will be passed to
659 the callback when it is called.
660 """
Yury Selivanovf23746a2018-01-22 19:11:18 -0500661 timer = self.call_at(self.time() + delay, callback, *args,
662 context=context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200663 if timer._source_traceback:
664 del timer._source_traceback[-1]
665 return timer
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700666
Yury Selivanovf23746a2018-01-22 19:11:18 -0500667 def call_at(self, when, callback, *args, context=None):
Victor Stinneracdb7822014-07-14 18:33:40 +0200668 """Like call_later(), but uses an absolute time.
669
670 Absolute time corresponds to the event loop's time() method.
671 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100672 self._check_closed()
Victor Stinner93569c22014-03-21 10:00:52 +0100673 if self._debug:
Victor Stinner956de692014-12-26 21:07:52 +0100674 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700675 self._check_callback(callback, 'call_at')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500676 timer = events.TimerHandle(when, callback, args, self, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200677 if timer._source_traceback:
678 del timer._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700679 heapq.heappush(self._scheduled, timer)
Yury Selivanov592ada92014-09-25 12:07:56 -0400680 timer._scheduled = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700681 return timer
682
Yury Selivanovf23746a2018-01-22 19:11:18 -0500683 def call_soon(self, callback, *args, context=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700684 """Arrange for a callback to be called as soon as possible.
685
Victor Stinneracdb7822014-07-14 18:33:40 +0200686 This operates as a FIFO queue: callbacks are called in the
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700687 order in which they are registered. Each callback will be
688 called exactly once.
689
690 Any positional arguments after the callback will be passed to
691 the callback when it is called.
692 """
Yury Selivanov491a9122016-11-03 15:09:24 -0700693 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100694 if self._debug:
695 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700696 self._check_callback(callback, 'call_soon')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500697 handle = self._call_soon(callback, args, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200698 if handle._source_traceback:
699 del handle._source_traceback[-1]
700 return handle
Victor Stinner93569c22014-03-21 10:00:52 +0100701
Yury Selivanov491a9122016-11-03 15:09:24 -0700702 def _check_callback(self, callback, method):
703 if (coroutines.iscoroutine(callback) or
704 coroutines.iscoroutinefunction(callback)):
705 raise TypeError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500706 f"coroutines cannot be used with {method}()")
Yury Selivanov491a9122016-11-03 15:09:24 -0700707 if not callable(callback):
708 raise TypeError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500709 f'a callable object was expected by {method}(), '
710 f'got {callback!r}')
Yury Selivanov491a9122016-11-03 15:09:24 -0700711
Yury Selivanovf23746a2018-01-22 19:11:18 -0500712 def _call_soon(self, callback, args, context):
713 handle = events.Handle(callback, args, self, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200714 if handle._source_traceback:
715 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700716 self._ready.append(handle)
717 return handle
718
Victor Stinner956de692014-12-26 21:07:52 +0100719 def _check_thread(self):
720 """Check that the current thread is the thread running the event loop.
Victor Stinner93569c22014-03-21 10:00:52 +0100721
Victor Stinneracdb7822014-07-14 18:33:40 +0200722 Non-thread-safe methods of this class make this assumption and will
Victor Stinner93569c22014-03-21 10:00:52 +0100723 likely behave incorrectly when the assumption is violated.
724
Victor Stinneracdb7822014-07-14 18:33:40 +0200725 Should only be called when (self._debug == True). The caller is
Victor Stinner93569c22014-03-21 10:00:52 +0100726 responsible for checking this condition for performance reasons.
727 """
Victor Stinnera87501f2015-02-05 11:45:33 +0100728 if self._thread_id is None:
Victor Stinner751c7c02014-06-23 15:14:13 +0200729 return
Victor Stinner956de692014-12-26 21:07:52 +0100730 thread_id = threading.get_ident()
Victor Stinnera87501f2015-02-05 11:45:33 +0100731 if thread_id != self._thread_id:
Victor Stinner93569c22014-03-21 10:00:52 +0100732 raise RuntimeError(
Victor Stinneracdb7822014-07-14 18:33:40 +0200733 "Non-thread-safe operation invoked on an event loop other "
Victor Stinner93569c22014-03-21 10:00:52 +0100734 "than the current one")
735
Yury Selivanovf23746a2018-01-22 19:11:18 -0500736 def call_soon_threadsafe(self, callback, *args, context=None):
Victor Stinneracdb7822014-07-14 18:33:40 +0200737 """Like call_soon(), but thread-safe."""
Yury Selivanov491a9122016-11-03 15:09:24 -0700738 self._check_closed()
739 if self._debug:
740 self._check_callback(callback, 'call_soon_threadsafe')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500741 handle = self._call_soon(callback, args, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200742 if handle._source_traceback:
743 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700744 self._write_to_self()
745 return handle
746
Yury Selivanovbec23722018-01-28 14:09:40 -0500747 def run_in_executor(self, executor, func, *args):
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100748 self._check_closed()
Yury Selivanov491a9122016-11-03 15:09:24 -0700749 if self._debug:
750 self._check_callback(func, 'run_in_executor')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700751 if executor is None:
752 executor = self._default_executor
753 if executor is None:
Yury Selivanove8a60452016-10-21 17:40:42 -0400754 executor = concurrent.futures.ThreadPoolExecutor()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700755 self._default_executor = executor
Yury Selivanovbec23722018-01-28 14:09:40 -0500756 return futures.wrap_future(
Yury Selivanov19a44f62017-12-14 20:53:26 -0500757 executor.submit(func, *args), loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700758
759 def set_default_executor(self, executor):
Elvis Pranskevichus22d25082018-07-30 11:42:43 +0100760 if not isinstance(executor, concurrent.futures.ThreadPoolExecutor):
761 warnings.warn(
762 'Using the default executor that is not an instance of '
763 'ThreadPoolExecutor is deprecated and will be prohibited '
764 'in Python 3.9',
765 DeprecationWarning, 2)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700766 self._default_executor = executor
767
Victor Stinnere912e652014-07-12 03:11:53 +0200768 def _getaddrinfo_debug(self, host, port, family, type, proto, flags):
Yury Selivanov6370f342017-12-10 18:36:12 -0500769 msg = [f"{host}:{port!r}"]
Victor Stinnere912e652014-07-12 03:11:53 +0200770 if family:
Yury Selivanov19d0d542017-12-10 19:52:53 -0500771 msg.append(f'family={family!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200772 if type:
Yury Selivanov6370f342017-12-10 18:36:12 -0500773 msg.append(f'type={type!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200774 if proto:
Yury Selivanov6370f342017-12-10 18:36:12 -0500775 msg.append(f'proto={proto!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200776 if flags:
Yury Selivanov6370f342017-12-10 18:36:12 -0500777 msg.append(f'flags={flags!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200778 msg = ', '.join(msg)
Victor Stinneracdb7822014-07-14 18:33:40 +0200779 logger.debug('Get address info %s', msg)
Victor Stinnere912e652014-07-12 03:11:53 +0200780
781 t0 = self.time()
782 addrinfo = socket.getaddrinfo(host, port, family, type, proto, flags)
783 dt = self.time() - t0
784
Yury Selivanov6370f342017-12-10 18:36:12 -0500785 msg = f'Getting address info {msg} took {dt * 1e3:.3f}ms: {addrinfo!r}'
Victor Stinnere912e652014-07-12 03:11:53 +0200786 if dt >= self.slow_callback_duration:
787 logger.info(msg)
788 else:
789 logger.debug(msg)
790 return addrinfo
791
Yury Selivanov19a44f62017-12-14 20:53:26 -0500792 async def getaddrinfo(self, host, port, *,
793 family=0, type=0, proto=0, flags=0):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400794 if self._debug:
Yury Selivanov19a44f62017-12-14 20:53:26 -0500795 getaddr_func = self._getaddrinfo_debug
Victor Stinnere912e652014-07-12 03:11:53 +0200796 else:
Yury Selivanov19a44f62017-12-14 20:53:26 -0500797 getaddr_func = socket.getaddrinfo
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700798
Yury Selivanov19a44f62017-12-14 20:53:26 -0500799 return await self.run_in_executor(
800 None, getaddr_func, host, port, family, type, proto, flags)
801
802 async def getnameinfo(self, sockaddr, flags=0):
803 return await self.run_in_executor(
804 None, socket.getnameinfo, sockaddr, flags)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700805
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200806 async def sock_sendfile(self, sock, file, offset=0, count=None,
807 *, fallback=True):
808 if self._debug and sock.gettimeout() != 0:
809 raise ValueError("the socket must be non-blocking")
810 self._check_sendfile_params(sock, file, offset, count)
811 try:
812 return await self._sock_sendfile_native(sock, file,
813 offset, count)
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700814 except exceptions.SendfileNotAvailableError as exc:
Andrew Svetlov7464e872018-01-19 20:04:29 +0200815 if not fallback:
816 raise
817 return await self._sock_sendfile_fallback(sock, file,
818 offset, count)
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200819
820 async def _sock_sendfile_native(self, sock, file, offset, count):
821 # NB: sendfile syscall is not supported for SSL sockets and
822 # non-mmap files even if sendfile is supported by OS
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700823 raise exceptions.SendfileNotAvailableError(
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200824 f"syscall sendfile is not available for socket {sock!r} "
825 "and file {file!r} combination")
826
827 async def _sock_sendfile_fallback(self, sock, file, offset, count):
828 if offset:
829 file.seek(offset)
Yury Selivanov71657542018-05-28 18:31:55 -0400830 blocksize = (
831 min(count, constants.SENDFILE_FALLBACK_READBUFFER_SIZE)
832 if count else constants.SENDFILE_FALLBACK_READBUFFER_SIZE
833 )
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200834 buf = bytearray(blocksize)
835 total_sent = 0
836 try:
837 while True:
838 if count:
839 blocksize = min(count - total_sent, blocksize)
840 if blocksize <= 0:
841 break
842 view = memoryview(buf)[:blocksize]
Yury Selivanov71657542018-05-28 18:31:55 -0400843 read = await self.run_in_executor(None, file.readinto, view)
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200844 if not read:
845 break # EOF
846 await self.sock_sendall(sock, view)
847 total_sent += read
848 return total_sent
849 finally:
850 if total_sent > 0 and hasattr(file, 'seek'):
851 file.seek(offset + total_sent)
852
853 def _check_sendfile_params(self, sock, file, offset, count):
854 if 'b' not in getattr(file, 'mode', 'b'):
855 raise ValueError("file should be opened in binary mode")
856 if not sock.type == socket.SOCK_STREAM:
857 raise ValueError("only SOCK_STREAM type sockets are supported")
858 if count is not None:
859 if not isinstance(count, int):
860 raise TypeError(
861 "count must be a positive integer (got {!r})".format(count))
862 if count <= 0:
863 raise ValueError(
864 "count must be a positive integer (got {!r})".format(count))
865 if not isinstance(offset, int):
866 raise TypeError(
867 "offset must be a non-negative integer (got {!r})".format(
868 offset))
869 if offset < 0:
870 raise ValueError(
871 "offset must be a non-negative integer (got {!r})".format(
872 offset))
873
Neil Aspinallf7686c12017-12-19 19:45:42 +0000874 async def create_connection(
875 self, protocol_factory, host=None, port=None,
876 *, ssl=None, family=0,
877 proto=0, flags=0, sock=None,
878 local_addr=None, server_hostname=None,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +0200879 ssl_handshake_timeout=None):
Victor Stinnerd1432092014-06-19 17:11:49 +0200880 """Connect to a TCP server.
881
882 Create a streaming transport connection to a given Internet host and
883 port: socket family AF_INET or socket.AF_INET6 depending on host (or
884 family if specified), socket type SOCK_STREAM. protocol_factory must be
885 a callable returning a protocol instance.
886
887 This method is a coroutine which will try to establish the connection
888 in the background. When successful, the coroutine returns a
889 (transport, protocol) pair.
890 """
Guido van Rossum21c85a72013-11-01 14:16:54 -0700891 if server_hostname is not None and not ssl:
892 raise ValueError('server_hostname is only meaningful with ssl')
893
894 if server_hostname is None and ssl:
895 # Use host as default for server_hostname. It is an error
896 # if host is empty or not set, e.g. when an
897 # already-connected socket was passed or when only a port
898 # is given. To avoid this error, you can pass
899 # server_hostname='' -- this will bypass the hostname
900 # check. (This also means that if host is a numeric
901 # IP/IPv6 address, we will attempt to verify that exact
902 # address; this will probably fail, but it is possible to
903 # create a certificate for a specific IP address, so we
904 # don't judge it here.)
905 if not host:
906 raise ValueError('You must set server_hostname '
907 'when using ssl without a host')
908 server_hostname = host
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700909
Andrew Svetlov51eb1c62017-12-20 20:24:43 +0200910 if ssl_handshake_timeout is not None and not ssl:
911 raise ValueError(
912 'ssl_handshake_timeout is only meaningful with ssl')
913
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700914 if host is not None or port is not None:
915 if sock is not None:
916 raise ValueError(
917 'host/port and sock can not be specified at the same time')
918
Yury Selivanov19a44f62017-12-14 20:53:26 -0500919 infos = await self._ensure_resolved(
920 (host, port), family=family,
921 type=socket.SOCK_STREAM, proto=proto, flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700922 if not infos:
923 raise OSError('getaddrinfo() returned empty list')
Yury Selivanov19a44f62017-12-14 20:53:26 -0500924
925 if local_addr is not None:
926 laddr_infos = await self._ensure_resolved(
927 local_addr, family=family,
928 type=socket.SOCK_STREAM, proto=proto,
929 flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700930 if not laddr_infos:
931 raise OSError('getaddrinfo() returned empty list')
932
933 exceptions = []
934 for family, type, proto, cname, address in infos:
935 try:
936 sock = socket.socket(family=family, type=type, proto=proto)
937 sock.setblocking(False)
Yury Selivanov19a44f62017-12-14 20:53:26 -0500938 if local_addr is not None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700939 for _, _, _, _, laddr in laddr_infos:
940 try:
941 sock.bind(laddr)
942 break
943 except OSError as exc:
Yury Selivanov6370f342017-12-10 18:36:12 -0500944 msg = (
945 f'error while attempting to bind on '
946 f'address {laddr!r}: '
947 f'{exc.strerror.lower()}'
948 )
949 exc = OSError(exc.errno, msg)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700950 exceptions.append(exc)
951 else:
952 sock.close()
953 sock = None
954 continue
Victor Stinnere912e652014-07-12 03:11:53 +0200955 if self._debug:
956 logger.debug("connect %r to %r", sock, address)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200957 await self.sock_connect(sock, address)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700958 except OSError as exc:
959 if sock is not None:
960 sock.close()
961 exceptions.append(exc)
Victor Stinner223a6242014-06-04 00:11:52 +0200962 except:
963 if sock is not None:
964 sock.close()
965 raise
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700966 else:
967 break
968 else:
969 if len(exceptions) == 1:
970 raise exceptions[0]
971 else:
972 # If they all have the same str(), raise one.
973 model = str(exceptions[0])
974 if all(str(exc) == model for exc in exceptions):
975 raise exceptions[0]
976 # Raise a combined exception so the user can see all
977 # the various error messages.
978 raise OSError('Multiple exceptions: {}'.format(
979 ', '.join(str(exc) for exc in exceptions)))
980
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500981 else:
982 if sock is None:
983 raise ValueError(
984 'host and port was not specified and no sock specified')
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500985 if sock.type != socket.SOCK_STREAM:
Yury Selivanovdab05842016-11-21 17:47:27 -0500986 # We allow AF_INET, AF_INET6, AF_UNIX as long as they
987 # are SOCK_STREAM.
988 # We support passing AF_UNIX sockets even though we have
989 # a dedicated API for that: create_unix_connection.
990 # Disallowing AF_UNIX in this method, breaks backwards
991 # compatibility.
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500992 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500993 f'A Stream Socket was expected, got {sock!r}')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700994
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200995 transport, protocol = await self._create_connection_transport(
Neil Aspinallf7686c12017-12-19 19:45:42 +0000996 sock, protocol_factory, ssl, server_hostname,
997 ssl_handshake_timeout=ssl_handshake_timeout)
Victor Stinnere912e652014-07-12 03:11:53 +0200998 if self._debug:
Victor Stinnerb2614752014-08-25 23:20:52 +0200999 # Get the socket from the transport because SSL transport closes
1000 # the old socket and creates a new SSL socket
1001 sock = transport.get_extra_info('socket')
Victor Stinneracdb7822014-07-14 18:33:40 +02001002 logger.debug("%r connected to %s:%r: (%r, %r)",
1003 sock, host, port, transport, protocol)
Yury Selivanovb057c522014-02-18 12:15:06 -05001004 return transport, protocol
1005
Neil Aspinallf7686c12017-12-19 19:45:42 +00001006 async def _create_connection_transport(
1007 self, sock, protocol_factory, ssl,
1008 server_hostname, server_side=False,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001009 ssl_handshake_timeout=None):
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001010
1011 sock.setblocking(False)
1012
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001013 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001014 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001015 if ssl:
1016 sslcontext = None if isinstance(ssl, bool) else ssl
1017 transport = self._make_ssl_transport(
1018 sock, protocol, sslcontext, waiter,
Neil Aspinallf7686c12017-12-19 19:45:42 +00001019 server_side=server_side, server_hostname=server_hostname,
1020 ssl_handshake_timeout=ssl_handshake_timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001021 else:
1022 transport = self._make_socket_transport(sock, protocol, waiter)
1023
Victor Stinner29ad0112015-01-15 00:04:21 +01001024 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001025 await waiter
Victor Stinner0c2e4082015-01-22 00:17:41 +01001026 except:
Victor Stinner29ad0112015-01-15 00:04:21 +01001027 transport.close()
1028 raise
1029
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001030 return transport, protocol
1031
Andrew Svetlov7c684072018-01-27 21:22:47 +02001032 async def sendfile(self, transport, file, offset=0, count=None,
1033 *, fallback=True):
1034 """Send a file to transport.
1035
1036 Return the total number of bytes which were sent.
1037
1038 The method uses high-performance os.sendfile if available.
1039
1040 file must be a regular file object opened in binary mode.
1041
1042 offset tells from where to start reading the file. If specified,
1043 count is the total number of bytes to transmit as opposed to
1044 sending the file until EOF is reached. File position is updated on
1045 return or also in case of error in which case file.tell()
1046 can be used to figure out the number of bytes
1047 which were sent.
1048
1049 fallback set to True makes asyncio to manually read and send
1050 the file when the platform does not support the sendfile syscall
1051 (e.g. Windows or SSL socket on Unix).
1052
1053 Raise SendfileNotAvailableError if the system does not support
1054 sendfile syscall and fallback is False.
1055 """
1056 if transport.is_closing():
1057 raise RuntimeError("Transport is closing")
1058 mode = getattr(transport, '_sendfile_compatible',
1059 constants._SendfileMode.UNSUPPORTED)
1060 if mode is constants._SendfileMode.UNSUPPORTED:
1061 raise RuntimeError(
1062 f"sendfile is not supported for transport {transport!r}")
1063 if mode is constants._SendfileMode.TRY_NATIVE:
1064 try:
1065 return await self._sendfile_native(transport, file,
1066 offset, count)
Andrew Svetlov0baa72f2018-09-11 10:13:04 -07001067 except exceptions.SendfileNotAvailableError as exc:
Andrew Svetlov7c684072018-01-27 21:22:47 +02001068 if not fallback:
1069 raise
Yury Selivanovb1a6ac42018-01-27 15:52:52 -05001070
1071 if not fallback:
1072 raise RuntimeError(
1073 f"fallback is disabled and native sendfile is not "
1074 f"supported for transport {transport!r}")
1075
Andrew Svetlov7c684072018-01-27 21:22:47 +02001076 return await self._sendfile_fallback(transport, file,
1077 offset, count)
1078
1079 async def _sendfile_native(self, transp, file, offset, count):
Andrew Svetlov0baa72f2018-09-11 10:13:04 -07001080 raise exceptions.SendfileNotAvailableError(
Andrew Svetlov7c684072018-01-27 21:22:47 +02001081 "sendfile syscall is not supported")
1082
1083 async def _sendfile_fallback(self, transp, file, offset, count):
1084 if offset:
1085 file.seek(offset)
1086 blocksize = min(count, 16384) if count else 16384
1087 buf = bytearray(blocksize)
1088 total_sent = 0
1089 proto = _SendfileFallbackProtocol(transp)
1090 try:
1091 while True:
1092 if count:
1093 blocksize = min(count - total_sent, blocksize)
1094 if blocksize <= 0:
1095 return total_sent
1096 view = memoryview(buf)[:blocksize]
1097 read = file.readinto(view)
1098 if not read:
1099 return total_sent # EOF
1100 await proto.drain()
1101 transp.write(view)
1102 total_sent += read
1103 finally:
1104 if total_sent > 0 and hasattr(file, 'seek'):
1105 file.seek(offset + total_sent)
1106 await proto.restore()
1107
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001108 async def start_tls(self, transport, protocol, sslcontext, *,
1109 server_side=False,
1110 server_hostname=None,
1111 ssl_handshake_timeout=None):
1112 """Upgrade transport to TLS.
1113
1114 Return a new transport that *protocol* should start using
1115 immediately.
1116 """
1117 if ssl is None:
1118 raise RuntimeError('Python ssl module is not available')
1119
1120 if not isinstance(sslcontext, ssl.SSLContext):
1121 raise TypeError(
1122 f'sslcontext is expected to be an instance of ssl.SSLContext, '
1123 f'got {sslcontext!r}')
1124
1125 if not getattr(transport, '_start_tls_compatible', False):
1126 raise TypeError(
Yury Selivanov415bc462018-06-05 08:59:58 -04001127 f'transport {transport!r} is not supported by start_tls()')
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001128
1129 waiter = self.create_future()
1130 ssl_protocol = sslproto.SSLProtocol(
1131 self, protocol, sslcontext, waiter,
1132 server_side, server_hostname,
1133 ssl_handshake_timeout=ssl_handshake_timeout,
1134 call_connection_made=False)
1135
Yury Selivanovf2955872018-05-29 01:00:12 -04001136 # Pause early so that "ssl_protocol.data_received()" doesn't
1137 # have a chance to get called before "ssl_protocol.connection_made()".
1138 transport.pause_reading()
1139
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001140 transport.set_protocol(ssl_protocol)
Yury Selivanov415bc462018-06-05 08:59:58 -04001141 conmade_cb = self.call_soon(ssl_protocol.connection_made, transport)
1142 resume_cb = self.call_soon(transport.resume_reading)
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001143
Yury Selivanov96026432018-06-04 11:32:35 -04001144 try:
1145 await waiter
1146 except Exception:
1147 transport.close()
Yury Selivanov415bc462018-06-05 08:59:58 -04001148 conmade_cb.cancel()
1149 resume_cb.cancel()
Yury Selivanov96026432018-06-04 11:32:35 -04001150 raise
1151
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001152 return ssl_protocol._app_transport
1153
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001154 async def create_datagram_endpoint(self, protocol_factory,
1155 local_addr=None, remote_addr=None, *,
1156 family=0, proto=0, flags=0,
1157 reuse_address=None, reuse_port=None,
1158 allow_broadcast=None, sock=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001159 """Create datagram connection."""
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001160 if sock is not None:
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001161 if sock.type != socket.SOCK_DGRAM:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001162 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001163 f'A UDP Socket was expected, got {sock!r}')
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001164 if (local_addr or remote_addr or
1165 family or proto or flags or
1166 reuse_address or reuse_port or allow_broadcast):
1167 # show the problematic kwargs in exception msg
1168 opts = dict(local_addr=local_addr, remote_addr=remote_addr,
1169 family=family, proto=proto, flags=flags,
1170 reuse_address=reuse_address, reuse_port=reuse_port,
1171 allow_broadcast=allow_broadcast)
Yury Selivanov6370f342017-12-10 18:36:12 -05001172 problems = ', '.join(f'{k}={v}' for k, v in opts.items() if v)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001173 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001174 f'socket modifier keyword arguments can not be used '
1175 f'when sock is specified. ({problems})')
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001176 sock.setblocking(False)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001177 r_addr = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001178 else:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001179 if not (local_addr or remote_addr):
1180 if family == 0:
1181 raise ValueError('unexpected address family')
1182 addr_pairs_info = (((family, proto), (None, None)),)
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001183 elif hasattr(socket, 'AF_UNIX') and family == socket.AF_UNIX:
1184 for addr in (local_addr, remote_addr):
Victor Stinner28e61652017-11-28 00:34:08 +01001185 if addr is not None and not isinstance(addr, str):
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001186 raise TypeError('string is expected')
1187 addr_pairs_info = (((family, proto),
1188 (local_addr, remote_addr)), )
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001189 else:
1190 # join address by (family, protocol)
1191 addr_infos = collections.OrderedDict()
1192 for idx, addr in ((0, local_addr), (1, remote_addr)):
1193 if addr is not None:
1194 assert isinstance(addr, tuple) and len(addr) == 2, (
1195 '2-tuple is expected')
1196
Yury Selivanov19a44f62017-12-14 20:53:26 -05001197 infos = await self._ensure_resolved(
Yury Selivanovf1c6fa92016-06-08 12:33:31 -04001198 addr, family=family, type=socket.SOCK_DGRAM,
1199 proto=proto, flags=flags, loop=self)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001200 if not infos:
1201 raise OSError('getaddrinfo() returned empty list')
1202
1203 for fam, _, pro, _, address in infos:
1204 key = (fam, pro)
1205 if key not in addr_infos:
1206 addr_infos[key] = [None, None]
1207 addr_infos[key][idx] = address
1208
1209 # each addr has to have info for each (family, proto) pair
1210 addr_pairs_info = [
1211 (key, addr_pair) for key, addr_pair in addr_infos.items()
1212 if not ((local_addr and addr_pair[0] is None) or
1213 (remote_addr and addr_pair[1] is None))]
1214
1215 if not addr_pairs_info:
1216 raise ValueError('can not get address information')
1217
1218 exceptions = []
1219
1220 if reuse_address is None:
1221 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
1222
1223 for ((family, proto),
1224 (local_address, remote_address)) in addr_pairs_info:
1225 sock = None
1226 r_addr = None
1227 try:
1228 sock = socket.socket(
1229 family=family, type=socket.SOCK_DGRAM, proto=proto)
1230 if reuse_address:
1231 sock.setsockopt(
1232 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1233 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001234 _set_reuseport(sock)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001235 if allow_broadcast:
1236 sock.setsockopt(
1237 socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
1238 sock.setblocking(False)
1239
1240 if local_addr:
1241 sock.bind(local_address)
1242 if remote_addr:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001243 await self.sock_connect(sock, remote_address)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001244 r_addr = remote_address
1245 except OSError as exc:
1246 if sock is not None:
1247 sock.close()
1248 exceptions.append(exc)
1249 except:
1250 if sock is not None:
1251 sock.close()
1252 raise
1253 else:
1254 break
1255 else:
1256 raise exceptions[0]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001257
1258 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001259 waiter = self.create_future()
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001260 transport = self._make_datagram_transport(
1261 sock, protocol, r_addr, waiter)
Victor Stinnere912e652014-07-12 03:11:53 +02001262 if self._debug:
1263 if local_addr:
1264 logger.info("Datagram endpoint local_addr=%r remote_addr=%r "
1265 "created: (%r, %r)",
1266 local_addr, remote_addr, transport, protocol)
1267 else:
1268 logger.debug("Datagram endpoint remote_addr=%r created: "
1269 "(%r, %r)",
1270 remote_addr, transport, protocol)
Victor Stinner2596dd02015-01-26 11:02:18 +01001271
1272 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001273 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001274 except:
1275 transport.close()
1276 raise
1277
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001278 return transport, protocol
1279
Yury Selivanov19a44f62017-12-14 20:53:26 -05001280 async def _ensure_resolved(self, address, *,
1281 family=0, type=socket.SOCK_STREAM,
1282 proto=0, flags=0, loop):
1283 host, port = address[:2]
1284 info = _ipaddr_info(host, port, family, type, proto)
1285 if info is not None:
1286 # "host" is already a resolved IP.
1287 return [info]
1288 else:
1289 return await loop.getaddrinfo(host, port, family=family, type=type,
1290 proto=proto, flags=flags)
1291
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001292 async def _create_server_getaddrinfo(self, host, port, family, flags):
Yury Selivanov19a44f62017-12-14 20:53:26 -05001293 infos = await self._ensure_resolved((host, port), family=family,
1294 type=socket.SOCK_STREAM,
1295 flags=flags, loop=self)
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001296 if not infos:
Yury Selivanov6370f342017-12-10 18:36:12 -05001297 raise OSError(f'getaddrinfo({host!r}) returned empty list')
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001298 return infos
1299
Neil Aspinallf7686c12017-12-19 19:45:42 +00001300 async def create_server(
1301 self, protocol_factory, host=None, port=None,
1302 *,
1303 family=socket.AF_UNSPEC,
1304 flags=socket.AI_PASSIVE,
1305 sock=None,
1306 backlog=100,
1307 ssl=None,
1308 reuse_address=None,
1309 reuse_port=None,
Yury Selivanovc9070d02018-01-25 18:08:09 -05001310 ssl_handshake_timeout=None,
1311 start_serving=True):
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001312 """Create a TCP server.
1313
Yury Selivanov6370f342017-12-10 18:36:12 -05001314 The host parameter can be a string, in that case the TCP server is
1315 bound to host and port.
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001316
1317 The host parameter can also be a sequence of strings and in that case
Yury Selivanove076ffb2016-03-02 11:17:01 -05001318 the TCP server is bound to all hosts of the sequence. If a host
1319 appears multiple times (possibly indirectly e.g. when hostnames
1320 resolve to the same IP address), the server is only bound once to that
1321 host.
Victor Stinnerd1432092014-06-19 17:11:49 +02001322
Victor Stinneracdb7822014-07-14 18:33:40 +02001323 Return a Server object which can be used to stop the service.
Victor Stinnerd1432092014-06-19 17:11:49 +02001324
1325 This method is a coroutine.
1326 """
Guido van Rossum28dff0d2013-11-01 14:22:30 -07001327 if isinstance(ssl, bool):
1328 raise TypeError('ssl argument must be an SSLContext or None')
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001329
1330 if ssl_handshake_timeout is not None and ssl is None:
1331 raise ValueError(
1332 'ssl_handshake_timeout is only meaningful with ssl')
1333
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001334 if host is not None or port is not None:
1335 if sock is not None:
1336 raise ValueError(
1337 'host/port and sock can not be specified at the same time')
1338
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001339 if reuse_address is None:
1340 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
1341 sockets = []
1342 if host == '':
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001343 hosts = [None]
1344 elif (isinstance(host, str) or
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001345 not isinstance(host, collections.abc.Iterable)):
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001346 hosts = [host]
1347 else:
1348 hosts = host
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001349
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001350 fs = [self._create_server_getaddrinfo(host, port, family=family,
1351 flags=flags)
1352 for host in hosts]
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001353 infos = await tasks.gather(*fs, loop=self)
Yury Selivanove076ffb2016-03-02 11:17:01 -05001354 infos = set(itertools.chain.from_iterable(infos))
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001355
1356 completed = False
1357 try:
1358 for res in infos:
1359 af, socktype, proto, canonname, sa = res
Guido van Rossum32e46852013-10-19 17:04:25 -07001360 try:
1361 sock = socket.socket(af, socktype, proto)
1362 except socket.error:
1363 # Assume it's a bad family/type/protocol combination.
Victor Stinnerb2614752014-08-25 23:20:52 +02001364 if self._debug:
1365 logger.warning('create_server() failed to create '
1366 'socket.socket(%r, %r, %r)',
1367 af, socktype, proto, exc_info=True)
Guido van Rossum32e46852013-10-19 17:04:25 -07001368 continue
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001369 sockets.append(sock)
1370 if reuse_address:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001371 sock.setsockopt(
1372 socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
1373 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001374 _set_reuseport(sock)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001375 # Disable IPv4/IPv6 dual stack support (enabled by
1376 # default on Linux) which makes a single socket
1377 # listen on both address families.
Yury Selivanovd904c232018-06-28 21:59:32 -04001378 if (_HAS_IPv6 and
1379 af == socket.AF_INET6 and
1380 hasattr(socket, 'IPPROTO_IPV6')):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001381 sock.setsockopt(socket.IPPROTO_IPV6,
1382 socket.IPV6_V6ONLY,
1383 True)
1384 try:
1385 sock.bind(sa)
1386 except OSError as err:
1387 raise OSError(err.errno, 'error while attempting '
1388 'to bind on address %r: %s'
Serhiy Storchaka5affd232017-04-05 09:37:24 +03001389 % (sa, err.strerror.lower())) from None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001390 completed = True
1391 finally:
1392 if not completed:
1393 for sock in sockets:
1394 sock.close()
1395 else:
1396 if sock is None:
Victor Stinneracdb7822014-07-14 18:33:40 +02001397 raise ValueError('Neither host/port nor sock were specified')
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001398 if sock.type != socket.SOCK_STREAM:
Yury Selivanov6370f342017-12-10 18:36:12 -05001399 raise ValueError(f'A Stream Socket was expected, got {sock!r}')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001400 sockets = [sock]
1401
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001402 for sock in sockets:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001403 sock.setblocking(False)
Yury Selivanovc9070d02018-01-25 18:08:09 -05001404
1405 server = Server(self, sockets, protocol_factory,
1406 ssl, backlog, ssl_handshake_timeout)
1407 if start_serving:
1408 server._start_serving()
Yury Selivanovdbf10222018-05-28 14:31:28 -04001409 # Skip one loop iteration so that all 'loop.add_reader'
1410 # go through.
1411 await tasks.sleep(0, loop=self)
Yury Selivanovc9070d02018-01-25 18:08:09 -05001412
Victor Stinnere912e652014-07-12 03:11:53 +02001413 if self._debug:
1414 logger.info("%r is serving", server)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001415 return server
1416
Neil Aspinallf7686c12017-12-19 19:45:42 +00001417 async def connect_accepted_socket(
1418 self, protocol_factory, sock,
1419 *, ssl=None,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001420 ssl_handshake_timeout=None):
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001421 """Handle an accepted connection.
1422
1423 This is used by servers that accept connections outside of
1424 asyncio but that use asyncio to handle connections.
1425
1426 This method is a coroutine. When completed, the coroutine
1427 returns a (transport, protocol) pair.
1428 """
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001429 if sock.type != socket.SOCK_STREAM:
Yury Selivanov6370f342017-12-10 18:36:12 -05001430 raise ValueError(f'A Stream Socket was expected, got {sock!r}')
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001431
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001432 if ssl_handshake_timeout is not None and not ssl:
1433 raise ValueError(
1434 'ssl_handshake_timeout is only meaningful with ssl')
1435
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001436 transport, protocol = await self._create_connection_transport(
Neil Aspinallf7686c12017-12-19 19:45:42 +00001437 sock, protocol_factory, ssl, '', server_side=True,
1438 ssl_handshake_timeout=ssl_handshake_timeout)
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001439 if self._debug:
1440 # Get the socket from the transport because SSL transport closes
1441 # the old socket and creates a new SSL socket
1442 sock = transport.get_extra_info('socket')
1443 logger.debug("%r handled: (%r, %r)", sock, transport, protocol)
1444 return transport, protocol
1445
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001446 async def connect_read_pipe(self, protocol_factory, pipe):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001447 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001448 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001449 transport = self._make_read_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001450
1451 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001452 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001453 except:
1454 transport.close()
1455 raise
1456
Victor Stinneracdb7822014-07-14 18:33:40 +02001457 if self._debug:
1458 logger.debug('Read pipe %r connected: (%r, %r)',
1459 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001460 return transport, protocol
1461
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001462 async def connect_write_pipe(self, protocol_factory, pipe):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001463 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001464 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001465 transport = self._make_write_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001466
1467 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001468 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001469 except:
1470 transport.close()
1471 raise
1472
Victor Stinneracdb7822014-07-14 18:33:40 +02001473 if self._debug:
1474 logger.debug('Write pipe %r connected: (%r, %r)',
1475 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001476 return transport, protocol
1477
Victor Stinneracdb7822014-07-14 18:33:40 +02001478 def _log_subprocess(self, msg, stdin, stdout, stderr):
1479 info = [msg]
1480 if stdin is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001481 info.append(f'stdin={_format_pipe(stdin)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001482 if stdout is not None and stderr == subprocess.STDOUT:
Yury Selivanov6370f342017-12-10 18:36:12 -05001483 info.append(f'stdout=stderr={_format_pipe(stdout)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001484 else:
1485 if stdout is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001486 info.append(f'stdout={_format_pipe(stdout)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001487 if stderr is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001488 info.append(f'stderr={_format_pipe(stderr)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001489 logger.debug(' '.join(info))
1490
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001491 async def subprocess_shell(self, protocol_factory, cmd, *,
1492 stdin=subprocess.PIPE,
1493 stdout=subprocess.PIPE,
1494 stderr=subprocess.PIPE,
1495 universal_newlines=False,
1496 shell=True, bufsize=0,
1497 **kwargs):
Victor Stinner20e07432014-02-11 11:44:56 +01001498 if not isinstance(cmd, (bytes, str)):
Victor Stinnere623a122014-01-29 14:35:15 -08001499 raise ValueError("cmd must be a string")
1500 if universal_newlines:
1501 raise ValueError("universal_newlines must be False")
1502 if not shell:
Victor Stinner323748e2014-01-31 12:28:30 +01001503 raise ValueError("shell must be True")
Victor Stinnere623a122014-01-29 14:35:15 -08001504 if bufsize != 0:
1505 raise ValueError("bufsize must be 0")
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001506 protocol = protocol_factory()
Yury Selivanov12f482e2018-06-08 18:24:37 -04001507 debug_log = None
Victor Stinneracdb7822014-07-14 18:33:40 +02001508 if self._debug:
1509 # don't log parameters: they may contain sensitive information
1510 # (password) and may be too long
1511 debug_log = 'run shell command %r' % cmd
1512 self._log_subprocess(debug_log, stdin, stdout, stderr)
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001513 transport = await self._make_subprocess_transport(
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001514 protocol, cmd, True, stdin, stdout, stderr, bufsize, **kwargs)
Yury Selivanov12f482e2018-06-08 18:24:37 -04001515 if self._debug and debug_log is not None:
Vinay Sajipdd917f82016-08-31 08:22:29 +01001516 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001517 return transport, protocol
1518
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001519 async def subprocess_exec(self, protocol_factory, program, *args,
1520 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1521 stderr=subprocess.PIPE, universal_newlines=False,
1522 shell=False, bufsize=0, **kwargs):
Victor Stinnere623a122014-01-29 14:35:15 -08001523 if universal_newlines:
1524 raise ValueError("universal_newlines must be False")
1525 if shell:
1526 raise ValueError("shell must be False")
1527 if bufsize != 0:
1528 raise ValueError("bufsize must be 0")
Victor Stinner20e07432014-02-11 11:44:56 +01001529 popen_args = (program,) + args
1530 for arg in popen_args:
1531 if not isinstance(arg, (str, bytes)):
Yury Selivanov6370f342017-12-10 18:36:12 -05001532 raise TypeError(
1533 f"program arguments must be a bytes or text string, "
1534 f"not {type(arg).__name__}")
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001535 protocol = protocol_factory()
Yury Selivanov12f482e2018-06-08 18:24:37 -04001536 debug_log = None
Victor Stinneracdb7822014-07-14 18:33:40 +02001537 if self._debug:
1538 # don't log parameters: they may contain sensitive information
1539 # (password) and may be too long
Yury Selivanov6370f342017-12-10 18:36:12 -05001540 debug_log = f'execute program {program!r}'
Victor Stinneracdb7822014-07-14 18:33:40 +02001541 self._log_subprocess(debug_log, stdin, stdout, stderr)
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001542 transport = await self._make_subprocess_transport(
Yury Selivanov57797522014-02-18 22:56:15 -05001543 protocol, popen_args, False, stdin, stdout, stderr,
1544 bufsize, **kwargs)
Yury Selivanov12f482e2018-06-08 18:24:37 -04001545 if self._debug and debug_log is not None:
Vinay Sajipdd917f82016-08-31 08:22:29 +01001546 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001547 return transport, protocol
1548
Yury Selivanov7ed7ce62016-05-16 15:20:38 -04001549 def get_exception_handler(self):
1550 """Return an exception handler, or None if the default one is in use.
1551 """
1552 return self._exception_handler
1553
Yury Selivanov569efa22014-02-18 18:02:19 -05001554 def set_exception_handler(self, handler):
1555 """Set handler as the new event loop exception handler.
1556
1557 If handler is None, the default exception handler will
1558 be set.
1559
1560 If handler is a callable object, it should have a
Victor Stinneracdb7822014-07-14 18:33:40 +02001561 signature matching '(loop, context)', where 'loop'
Yury Selivanov569efa22014-02-18 18:02:19 -05001562 will be a reference to the active event loop, 'context'
1563 will be a dict object (see `call_exception_handler()`
1564 documentation for details about context).
1565 """
1566 if handler is not None and not callable(handler):
Yury Selivanov6370f342017-12-10 18:36:12 -05001567 raise TypeError(f'A callable object or None is expected, '
1568 f'got {handler!r}')
Yury Selivanov569efa22014-02-18 18:02:19 -05001569 self._exception_handler = handler
1570
1571 def default_exception_handler(self, context):
1572 """Default exception handler.
1573
1574 This is called when an exception occurs and no exception
1575 handler is set, and can be called by a custom exception
1576 handler that wants to defer to the default behavior.
1577
Antoine Pitrou921e9432017-11-07 17:23:29 +01001578 This default handler logs the error message and other
1579 context-dependent information. In debug mode, a truncated
1580 stack trace is also appended showing where the given object
1581 (e.g. a handle or future or task) was created, if any.
1582
Victor Stinneracdb7822014-07-14 18:33:40 +02001583 The context parameter has the same meaning as in
Yury Selivanov569efa22014-02-18 18:02:19 -05001584 `call_exception_handler()`.
1585 """
1586 message = context.get('message')
1587 if not message:
1588 message = 'Unhandled exception in event loop'
1589
1590 exception = context.get('exception')
1591 if exception is not None:
1592 exc_info = (type(exception), exception, exception.__traceback__)
1593 else:
1594 exc_info = False
1595
Yury Selivanov6370f342017-12-10 18:36:12 -05001596 if ('source_traceback' not in context and
1597 self._current_handle is not None and
1598 self._current_handle._source_traceback):
1599 context['handle_traceback'] = \
1600 self._current_handle._source_traceback
Victor Stinner9b524d52015-01-26 11:05:12 +01001601
Yury Selivanov569efa22014-02-18 18:02:19 -05001602 log_lines = [message]
1603 for key in sorted(context):
1604 if key in {'message', 'exception'}:
1605 continue
Victor Stinner80f53aa2014-06-27 13:52:20 +02001606 value = context[key]
1607 if key == 'source_traceback':
1608 tb = ''.join(traceback.format_list(value))
1609 value = 'Object created at (most recent call last):\n'
1610 value += tb.rstrip()
Victor Stinner9b524d52015-01-26 11:05:12 +01001611 elif key == 'handle_traceback':
1612 tb = ''.join(traceback.format_list(value))
1613 value = 'Handle created at (most recent call last):\n'
1614 value += tb.rstrip()
Victor Stinner80f53aa2014-06-27 13:52:20 +02001615 else:
1616 value = repr(value)
Yury Selivanov6370f342017-12-10 18:36:12 -05001617 log_lines.append(f'{key}: {value}')
Yury Selivanov569efa22014-02-18 18:02:19 -05001618
1619 logger.error('\n'.join(log_lines), exc_info=exc_info)
1620
1621 def call_exception_handler(self, context):
Victor Stinneracdb7822014-07-14 18:33:40 +02001622 """Call the current event loop's exception handler.
Yury Selivanov569efa22014-02-18 18:02:19 -05001623
Victor Stinneracdb7822014-07-14 18:33:40 +02001624 The context argument is a dict containing the following keys:
1625
Yury Selivanov569efa22014-02-18 18:02:19 -05001626 - 'message': Error message;
1627 - 'exception' (optional): Exception object;
1628 - 'future' (optional): Future instance;
Yury Selivanova4afcdf2018-01-21 14:56:59 -05001629 - 'task' (optional): Task instance;
Yury Selivanov569efa22014-02-18 18:02:19 -05001630 - 'handle' (optional): Handle instance;
1631 - 'protocol' (optional): Protocol instance;
1632 - 'transport' (optional): Transport instance;
Yury Selivanoveb636452016-09-08 22:01:51 -07001633 - 'socket' (optional): Socket instance;
1634 - 'asyncgen' (optional): Asynchronous generator that caused
1635 the exception.
Yury Selivanov569efa22014-02-18 18:02:19 -05001636
Victor Stinneracdb7822014-07-14 18:33:40 +02001637 New keys maybe introduced in the future.
1638
1639 Note: do not overload this method in an event loop subclass.
1640 For custom exception handling, use the
Yury Selivanov569efa22014-02-18 18:02:19 -05001641 `set_exception_handler()` method.
1642 """
1643 if self._exception_handler is None:
1644 try:
1645 self.default_exception_handler(context)
1646 except Exception:
1647 # Second protection layer for unexpected errors
1648 # in the default implementation, as well as for subclassed
1649 # event loops with overloaded "default_exception_handler".
1650 logger.error('Exception in default exception handler',
1651 exc_info=True)
1652 else:
1653 try:
1654 self._exception_handler(self, context)
1655 except Exception as exc:
1656 # Exception in the user set custom exception handler.
1657 try:
1658 # Let's try default handler.
1659 self.default_exception_handler({
1660 'message': 'Unhandled error in exception handler',
1661 'exception': exc,
1662 'context': context,
1663 })
1664 except Exception:
Victor Stinneracdb7822014-07-14 18:33:40 +02001665 # Guard 'default_exception_handler' in case it is
Yury Selivanov569efa22014-02-18 18:02:19 -05001666 # overloaded.
1667 logger.error('Exception in default exception handler '
1668 'while handling an unexpected error '
1669 'in custom exception handler',
1670 exc_info=True)
1671
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001672 def _add_callback(self, handle):
Victor Stinneracdb7822014-07-14 18:33:40 +02001673 """Add a Handle to _scheduled (TimerHandle) or _ready."""
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001674 assert isinstance(handle, events.Handle), 'A Handle is required here'
1675 if handle._cancelled:
1676 return
Yury Selivanov592ada92014-09-25 12:07:56 -04001677 assert not isinstance(handle, events.TimerHandle)
1678 self._ready.append(handle)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001679
1680 def _add_callback_signalsafe(self, handle):
1681 """Like _add_callback() but called from a signal handler."""
1682 self._add_callback(handle)
1683 self._write_to_self()
1684
Yury Selivanov592ada92014-09-25 12:07:56 -04001685 def _timer_handle_cancelled(self, handle):
1686 """Notification that a TimerHandle has been cancelled."""
1687 if handle._scheduled:
1688 self._timer_cancelled_count += 1
1689
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001690 def _run_once(self):
1691 """Run one full iteration of the event loop.
1692
1693 This calls all currently ready callbacks, polls for I/O,
1694 schedules the resulting callbacks, and finally schedules
1695 'call_later' callbacks.
1696 """
Yury Selivanov592ada92014-09-25 12:07:56 -04001697
Yury Selivanov592ada92014-09-25 12:07:56 -04001698 sched_count = len(self._scheduled)
1699 if (sched_count > _MIN_SCHEDULED_TIMER_HANDLES and
1700 self._timer_cancelled_count / sched_count >
1701 _MIN_CANCELLED_TIMER_HANDLES_FRACTION):
Victor Stinner68da8fc2014-09-30 18:08:36 +02001702 # Remove delayed calls that were cancelled if their number
1703 # is too high
1704 new_scheduled = []
Yury Selivanov592ada92014-09-25 12:07:56 -04001705 for handle in self._scheduled:
1706 if handle._cancelled:
1707 handle._scheduled = False
Victor Stinner68da8fc2014-09-30 18:08:36 +02001708 else:
1709 new_scheduled.append(handle)
Yury Selivanov592ada92014-09-25 12:07:56 -04001710
Victor Stinner68da8fc2014-09-30 18:08:36 +02001711 heapq.heapify(new_scheduled)
1712 self._scheduled = new_scheduled
Yury Selivanov592ada92014-09-25 12:07:56 -04001713 self._timer_cancelled_count = 0
Yury Selivanov592ada92014-09-25 12:07:56 -04001714 else:
1715 # Remove delayed calls that were cancelled from head of queue.
1716 while self._scheduled and self._scheduled[0]._cancelled:
1717 self._timer_cancelled_count -= 1
1718 handle = heapq.heappop(self._scheduled)
1719 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001720
1721 timeout = None
Guido van Rossum41f69f42015-11-19 13:28:47 -08001722 if self._ready or self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001723 timeout = 0
1724 elif self._scheduled:
1725 # Compute the desired timeout.
1726 when = self._scheduled[0]._when
MartinAltmayer944451c2018-07-31 15:06:12 +01001727 timeout = min(max(0, when - self.time()), MAXIMUM_SELECT_TIMEOUT)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001728
Andrew Svetlovd5bd0362018-09-30 08:28:40 +03001729 event_list = self._selector.select(timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001730 self._process_events(event_list)
1731
1732 # Handle 'later' callbacks that are ready.
Victor Stinnered1654f2014-02-10 23:42:32 +01001733 end_time = self.time() + self._clock_resolution
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001734 while self._scheduled:
1735 handle = self._scheduled[0]
Victor Stinnered1654f2014-02-10 23:42:32 +01001736 if handle._when >= end_time:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001737 break
1738 handle = heapq.heappop(self._scheduled)
Yury Selivanov592ada92014-09-25 12:07:56 -04001739 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001740 self._ready.append(handle)
1741
1742 # This is the only place where callbacks are actually *called*.
1743 # All other places just add them to ready.
1744 # Note: We run all currently scheduled callbacks, but not any
1745 # callbacks scheduled by callbacks run this time around --
1746 # they will be run the next time (after another I/O poll).
Victor Stinneracdb7822014-07-14 18:33:40 +02001747 # Use an idiom that is thread-safe without using locks.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001748 ntodo = len(self._ready)
1749 for i in range(ntodo):
1750 handle = self._ready.popleft()
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001751 if handle._cancelled:
1752 continue
1753 if self._debug:
Victor Stinner9b524d52015-01-26 11:05:12 +01001754 try:
1755 self._current_handle = handle
1756 t0 = self.time()
1757 handle._run()
1758 dt = self.time() - t0
1759 if dt >= self.slow_callback_duration:
1760 logger.warning('Executing %s took %.3f seconds',
1761 _format_handle(handle), dt)
1762 finally:
1763 self._current_handle = None
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001764 else:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001765 handle._run()
1766 handle = None # Needed to break cycles when an exception occurs.
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001767
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001768 def _set_coroutine_origin_tracking(self, enabled):
1769 if bool(enabled) == bool(self._coroutine_origin_tracking_enabled):
Yury Selivanove8944cb2015-05-12 11:43:04 -04001770 return
1771
Yury Selivanove8944cb2015-05-12 11:43:04 -04001772 if enabled:
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001773 self._coroutine_origin_tracking_saved_depth = (
1774 sys.get_coroutine_origin_tracking_depth())
1775 sys.set_coroutine_origin_tracking_depth(
1776 constants.DEBUG_STACK_DEPTH)
Yury Selivanove8944cb2015-05-12 11:43:04 -04001777 else:
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001778 sys.set_coroutine_origin_tracking_depth(
1779 self._coroutine_origin_tracking_saved_depth)
1780
1781 self._coroutine_origin_tracking_enabled = enabled
Yury Selivanove8944cb2015-05-12 11:43:04 -04001782
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001783 def get_debug(self):
1784 return self._debug
1785
1786 def set_debug(self, enabled):
1787 self._debug = enabled
Yury Selivanov1af2bf72015-05-11 22:27:25 -04001788
Yury Selivanove8944cb2015-05-12 11:43:04 -04001789 if self.is_running():
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001790 self.call_soon_threadsafe(self._set_coroutine_origin_tracking, enabled)