blob: adcdec171b07a9f9d27cc8f908575f58661aedcd [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
twisteroid ambassador88f07a82019-05-05 19:14:35 +080019import functools
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070020import heapq
Victor Stinner5e4a7d82015-09-21 18:33:43 +020021import itertools
Victor Stinnerb75380f2014-06-30 14:39:11 +020022import os
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070023import socket
Quentin Dawans56065d42019-04-09 15:40:59 +020024import stat
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070025import subprocess
Victor Stinner956de692014-12-26 21:07:52 +010026import threading
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070027import time
Victor Stinnerb75380f2014-06-30 14:39:11 +020028import traceback
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070029import sys
Victor Stinner978a9af2015-01-29 17:50:58 +010030import warnings
Yury Selivanoveb636452016-09-08 22:01:51 -070031import weakref
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070032
Yury Selivanovf111b3d2017-12-30 00:35:36 -050033try:
34 import ssl
35except ImportError: # pragma: no cover
36 ssl = None
37
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080038from . import constants
Victor Stinnerf951d282014-06-29 00:46:45 +020039from . import coroutines
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070040from . import events
Andrew Svetlov0baa72f2018-09-11 10:13:04 -070041from . import exceptions
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070042from . import futures
Andrew Svetlov7c684072018-01-27 21:22:47 +020043from . import protocols
Yury Selivanovf111b3d2017-12-30 00:35:36 -050044from . import sslproto
twisteroid ambassador88f07a82019-05-05 19:14:35 +080045from . import staggered
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070046from . import tasks
Andrew Svetlov7c684072018-01-27 21:22:47 +020047from . import transports
Yury Selivanov8cd51652019-05-27 15:57:20 +020048from . import trsock
Guido van Rossumfc29e0f2013-10-17 15:39:45 -070049from .log import logger
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070050
51
Yury Selivanov6370f342017-12-10 18:36:12 -050052__all__ = 'BaseEventLoop',
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070053
54
Yury Selivanov592ada92014-09-25 12:07:56 -040055# Minimum number of _scheduled timer handles before cleanup of
56# cancelled handles is performed.
57_MIN_SCHEDULED_TIMER_HANDLES = 100
58
59# Minimum fraction of _scheduled timer handles that are cancelled
60# before cleanup of cancelled handles is performed.
61_MIN_CANCELLED_TIMER_HANDLES_FRACTION = 0.5
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070062
Andrew Svetlov0dd71802018-09-12 14:03:54 -070063
Yury Selivanovd904c232018-06-28 21:59:32 -040064_HAS_IPv6 = hasattr(socket, 'AF_INET6')
65
MartinAltmayer944451c2018-07-31 15:06:12 +010066# Maximum timeout passed to select to avoid OS limitations
67MAXIMUM_SELECT_TIMEOUT = 24 * 3600
68
Kyle Stanleyab513a32019-12-09 09:21:10 -050069# Used for deprecation and removal of `loop.create_datagram_endpoint()`'s
70# *reuse_address* parameter
71_unset = object()
72
Victor Stinnerc94a93a2016-04-01 21:43:39 +020073
Victor Stinner0e6f52a2014-06-20 17:34:15 +020074def _format_handle(handle):
75 cb = handle._callback
Yury Selivanova0c1ba62016-10-28 12:52:37 -040076 if isinstance(getattr(cb, '__self__', None), tasks.Task):
Victor Stinner0e6f52a2014-06-20 17:34:15 +020077 # format the task
78 return repr(cb.__self__)
79 else:
80 return str(handle)
81
82
Victor Stinneracdb7822014-07-14 18:33:40 +020083def _format_pipe(fd):
84 if fd == subprocess.PIPE:
85 return '<pipe>'
86 elif fd == subprocess.STDOUT:
87 return '<stdout>'
88 else:
89 return repr(fd)
90
91
Yury Selivanov5587d7c2016-09-15 15:45:07 -040092def _set_reuseport(sock):
93 if not hasattr(socket, 'SO_REUSEPORT'):
94 raise ValueError('reuse_port not supported by socket module')
95 else:
96 try:
97 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
98 except OSError:
99 raise ValueError('reuse_port not supported by socket module, '
100 'SO_REUSEPORT defined but not implemented.')
101
102
Erwan Le Papeac8eb8f2019-05-17 10:28:39 +0200103def _ipaddr_info(host, port, family, type, proto, flowinfo=0, scopeid=0):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400104 # Try to skip getaddrinfo if "host" is already an IP. Users might have
105 # handled name resolution in their own code and pass in resolved IPs.
106 if not hasattr(socket, 'inet_pton'):
107 return
108
109 if proto not in {0, socket.IPPROTO_TCP, socket.IPPROTO_UDP} or \
110 host is None:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500111 return None
112
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500113 if type == socket.SOCK_STREAM:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500114 proto = socket.IPPROTO_TCP
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500115 elif type == socket.SOCK_DGRAM:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500116 proto = socket.IPPROTO_UDP
117 else:
118 return None
119
Yury Selivanova7146162016-06-02 16:51:07 -0400120 if port is None:
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400121 port = 0
Guido van Rossume3c65a72016-09-30 08:17:15 -0700122 elif isinstance(port, bytes) and port == b'':
123 port = 0
124 elif isinstance(port, str) and port == '':
125 port = 0
126 else:
127 # If port's a service name like "http", don't skip getaddrinfo.
128 try:
129 port = int(port)
130 except (TypeError, ValueError):
131 return None
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400132
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400133 if family == socket.AF_UNSPEC:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500134 afs = [socket.AF_INET]
Yury Selivanovd904c232018-06-28 21:59:32 -0400135 if _HAS_IPv6:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500136 afs.append(socket.AF_INET6)
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400137 else:
138 afs = [family]
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500139
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400140 if isinstance(host, bytes):
141 host = host.decode('idna')
142 if '%' in host:
143 # Linux's inet_pton doesn't accept an IPv6 zone index after host,
144 # like '::1%lo0'.
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500145 return None
146
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400147 for af in afs:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500148 try:
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400149 socket.inet_pton(af, host)
150 # The host has already been resolved.
Yury Selivanovd904c232018-06-28 21:59:32 -0400151 if _HAS_IPv6 and af == socket.AF_INET6:
Erwan Le Papeac8eb8f2019-05-17 10:28:39 +0200152 return af, type, proto, '', (host, port, flowinfo, scopeid)
Yury Selivanovd904c232018-06-28 21:59:32 -0400153 else:
154 return af, type, proto, '', (host, port)
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400155 except OSError:
156 pass
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500157
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400158 # "host" is not an IP address.
159 return None
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500160
161
twisteroid ambassador88f07a82019-05-05 19:14:35 +0800162def _interleave_addrinfos(addrinfos, first_address_family_count=1):
163 """Interleave list of addrinfo tuples by family."""
164 # Group addresses by family
165 addrinfos_by_family = collections.OrderedDict()
166 for addr in addrinfos:
167 family = addr[0]
168 if family not in addrinfos_by_family:
169 addrinfos_by_family[family] = []
170 addrinfos_by_family[family].append(addr)
171 addrinfos_lists = list(addrinfos_by_family.values())
172
173 reordered = []
174 if first_address_family_count > 1:
175 reordered.extend(addrinfos_lists[0][:first_address_family_count - 1])
176 del addrinfos_lists[0][:first_address_family_count - 1]
177 reordered.extend(
178 a for a in itertools.chain.from_iterable(
179 itertools.zip_longest(*addrinfos_lists)
180 ) if a is not None)
181 return reordered
182
183
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100184def _run_until_complete_cb(fut):
Yury Selivanov36c2c042017-12-19 07:19:53 -0500185 if not fut.cancelled():
186 exc = fut.exception()
Yury Selivanov431b5402019-05-27 14:45:12 +0200187 if isinstance(exc, (SystemExit, KeyboardInterrupt)):
Yury Selivanov36c2c042017-12-19 07:19:53 -0500188 # Issue #22429: run_forever() already finished, no need to
189 # stop it.
190 return
Yury Selivanovca9b36c2017-12-23 15:04:15 -0500191 futures._get_loop(fut).stop()
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100192
193
Andrew Svetlov3bc0eba2018-12-03 21:08:13 +0200194if hasattr(socket, 'TCP_NODELAY'):
195 def _set_nodelay(sock):
196 if (sock.family in {socket.AF_INET, socket.AF_INET6} and
197 sock.type == socket.SOCK_STREAM and
198 sock.proto == socket.IPPROTO_TCP):
199 sock.setsockopt(socket.IPPROTO_TCP, socket.TCP_NODELAY, 1)
200else:
201 def _set_nodelay(sock):
202 pass
203
204
Andrew Svetlov7c684072018-01-27 21:22:47 +0200205class _SendfileFallbackProtocol(protocols.Protocol):
206 def __init__(self, transp):
207 if not isinstance(transp, transports._FlowControlMixin):
208 raise TypeError("transport should be _FlowControlMixin instance")
209 self._transport = transp
210 self._proto = transp.get_protocol()
211 self._should_resume_reading = transp.is_reading()
212 self._should_resume_writing = transp._protocol_paused
213 transp.pause_reading()
214 transp.set_protocol(self)
215 if self._should_resume_writing:
216 self._write_ready_fut = self._transport._loop.create_future()
217 else:
218 self._write_ready_fut = None
219
220 async def drain(self):
221 if self._transport.is_closing():
222 raise ConnectionError("Connection closed by peer")
223 fut = self._write_ready_fut
224 if fut is None:
225 return
226 await fut
227
228 def connection_made(self, transport):
229 raise RuntimeError("Invalid state: "
230 "connection should have been established already.")
231
232 def connection_lost(self, exc):
233 if self._write_ready_fut is not None:
234 # Never happens if peer disconnects after sending the whole content
235 # Thus disconnection is always an exception from user perspective
236 if exc is None:
237 self._write_ready_fut.set_exception(
238 ConnectionError("Connection is closed by peer"))
239 else:
240 self._write_ready_fut.set_exception(exc)
241 self._proto.connection_lost(exc)
242
243 def pause_writing(self):
244 if self._write_ready_fut is not None:
245 return
246 self._write_ready_fut = self._transport._loop.create_future()
247
248 def resume_writing(self):
249 if self._write_ready_fut is None:
250 return
251 self._write_ready_fut.set_result(False)
252 self._write_ready_fut = None
253
254 def data_received(self, data):
255 raise RuntimeError("Invalid state: reading should be paused")
256
257 def eof_received(self):
258 raise RuntimeError("Invalid state: reading should be paused")
259
260 async def restore(self):
261 self._transport.set_protocol(self._proto)
262 if self._should_resume_reading:
263 self._transport.resume_reading()
264 if self._write_ready_fut is not None:
265 # Cancel the future.
266 # Basically it has no effect because protocol is switched back,
267 # no code should wait for it anymore.
268 self._write_ready_fut.cancel()
269 if self._should_resume_writing:
270 self._proto.resume_writing()
271
272
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700273class Server(events.AbstractServer):
274
Yury Selivanovc9070d02018-01-25 18:08:09 -0500275 def __init__(self, loop, sockets, protocol_factory, ssl_context, backlog,
276 ssl_handshake_timeout):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200277 self._loop = loop
Yury Selivanovc9070d02018-01-25 18:08:09 -0500278 self._sockets = sockets
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200279 self._active_count = 0
280 self._waiters = []
Yury Selivanovc9070d02018-01-25 18:08:09 -0500281 self._protocol_factory = protocol_factory
282 self._backlog = backlog
283 self._ssl_context = ssl_context
284 self._ssl_handshake_timeout = ssl_handshake_timeout
285 self._serving = False
286 self._serving_forever_fut = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700287
Victor Stinnere912e652014-07-12 03:11:53 +0200288 def __repr__(self):
Yury Selivanov6370f342017-12-10 18:36:12 -0500289 return f'<{self.__class__.__name__} sockets={self.sockets!r}>'
Victor Stinnere912e652014-07-12 03:11:53 +0200290
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200291 def _attach(self):
Yury Selivanovc9070d02018-01-25 18:08:09 -0500292 assert self._sockets is not None
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200293 self._active_count += 1
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700294
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200295 def _detach(self):
296 assert self._active_count > 0
297 self._active_count -= 1
Yury Selivanovc9070d02018-01-25 18:08:09 -0500298 if self._active_count == 0 and self._sockets is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700299 self._wakeup()
300
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700301 def _wakeup(self):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200302 waiters = self._waiters
303 self._waiters = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700304 for waiter in waiters:
305 if not waiter.done():
306 waiter.set_result(waiter)
307
Yury Selivanovc9070d02018-01-25 18:08:09 -0500308 def _start_serving(self):
309 if self._serving:
310 return
311 self._serving = True
312 for sock in self._sockets:
313 sock.listen(self._backlog)
314 self._loop._start_serving(
315 self._protocol_factory, sock, self._ssl_context,
316 self, self._backlog, self._ssl_handshake_timeout)
317
318 def get_loop(self):
319 return self._loop
320
321 def is_serving(self):
322 return self._serving
323
324 @property
325 def sockets(self):
326 if self._sockets is None:
Yury Selivanov8cd51652019-05-27 15:57:20 +0200327 return ()
328 return tuple(trsock.TransportSocket(s) for s in self._sockets)
Yury Selivanovc9070d02018-01-25 18:08:09 -0500329
330 def close(self):
331 sockets = self._sockets
332 if sockets is None:
333 return
334 self._sockets = None
335
336 for sock in sockets:
337 self._loop._stop_serving(sock)
338
339 self._serving = False
340
341 if (self._serving_forever_fut is not None and
342 not self._serving_forever_fut.done()):
343 self._serving_forever_fut.cancel()
344 self._serving_forever_fut = None
345
346 if self._active_count == 0:
347 self._wakeup()
348
349 async def start_serving(self):
350 self._start_serving()
Yury Selivanovdbf10222018-05-28 14:31:28 -0400351 # Skip one loop iteration so that all 'loop.add_reader'
352 # go through.
353 await tasks.sleep(0, loop=self._loop)
Yury Selivanovc9070d02018-01-25 18:08:09 -0500354
355 async def serve_forever(self):
356 if self._serving_forever_fut is not None:
357 raise RuntimeError(
358 f'server {self!r} is already being awaited on serve_forever()')
359 if self._sockets is None:
360 raise RuntimeError(f'server {self!r} is closed')
361
362 self._start_serving()
363 self._serving_forever_fut = self._loop.create_future()
364
365 try:
366 await self._serving_forever_fut
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700367 except exceptions.CancelledError:
Yury Selivanovc9070d02018-01-25 18:08:09 -0500368 try:
369 self.close()
370 await self.wait_closed()
371 finally:
372 raise
373 finally:
374 self._serving_forever_fut = None
375
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200376 async def wait_closed(self):
Yury Selivanovc9070d02018-01-25 18:08:09 -0500377 if self._sockets is None or self._waiters is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700378 return
Yury Selivanov7661db62016-05-16 15:38:39 -0400379 waiter = self._loop.create_future()
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200380 self._waiters.append(waiter)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200381 await waiter
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700382
383
384class BaseEventLoop(events.AbstractEventLoop):
385
386 def __init__(self):
Yury Selivanov592ada92014-09-25 12:07:56 -0400387 self._timer_cancelled_count = 0
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200388 self._closed = False
Guido van Rossum41f69f42015-11-19 13:28:47 -0800389 self._stopping = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700390 self._ready = collections.deque()
391 self._scheduled = []
392 self._default_executor = None
393 self._internal_fds = 0
Victor Stinner956de692014-12-26 21:07:52 +0100394 # Identifier of the thread running the event loop, or None if the
395 # event loop is not running
Victor Stinnera87501f2015-02-05 11:45:33 +0100396 self._thread_id = None
Victor Stinnered1654f2014-02-10 23:42:32 +0100397 self._clock_resolution = time.get_clock_info('monotonic').resolution
Yury Selivanov569efa22014-02-18 18:02:19 -0500398 self._exception_handler = None
Victor Stinner44862df2017-11-20 07:14:07 -0800399 self.set_debug(coroutines._is_debug_mode())
Victor Stinner0e6f52a2014-06-20 17:34:15 +0200400 # In debug mode, if the execution of a callback or a step of a task
401 # exceed this duration in seconds, the slow callback/task is logged.
402 self.slow_callback_duration = 0.1
Victor Stinner9b524d52015-01-26 11:05:12 +0100403 self._current_handle = None
Yury Selivanov740169c2015-05-11 14:23:38 -0400404 self._task_factory = None
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800405 self._coroutine_origin_tracking_enabled = False
406 self._coroutine_origin_tracking_saved_depth = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700407
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500408 # A weak set of all asynchronous generators that are
409 # being iterated by the loop.
410 self._asyncgens = weakref.WeakSet()
Yury Selivanoveb636452016-09-08 22:01:51 -0700411 # Set to True when `loop.shutdown_asyncgens` is called.
412 self._asyncgens_shutdown_called = False
Kyle Stanley9fdc64c2019-09-19 08:47:22 -0400413 # Set to True when `loop.shutdown_default_executor` is called.
414 self._executor_shutdown_called = False
Yury Selivanoveb636452016-09-08 22:01:51 -0700415
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200416 def __repr__(self):
Yury Selivanov6370f342017-12-10 18:36:12 -0500417 return (
418 f'<{self.__class__.__name__} running={self.is_running()} '
419 f'closed={self.is_closed()} debug={self.get_debug()}>'
420 )
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200421
Yury Selivanov7661db62016-05-16 15:38:39 -0400422 def create_future(self):
423 """Create a Future object attached to the loop."""
424 return futures.Future(loop=self)
425
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300426 def create_task(self, coro, *, name=None):
Victor Stinner896a25a2014-07-08 11:29:25 +0200427 """Schedule a coroutine object.
428
Victor Stinneracdb7822014-07-14 18:33:40 +0200429 Return a task object.
430 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100431 self._check_closed()
Yury Selivanov740169c2015-05-11 14:23:38 -0400432 if self._task_factory is None:
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300433 task = tasks.Task(coro, loop=self, name=name)
Yury Selivanov740169c2015-05-11 14:23:38 -0400434 if task._source_traceback:
435 del task._source_traceback[-1]
436 else:
437 task = self._task_factory(self, coro)
Alex Grönholmcca4eec2018-08-09 00:06:47 +0300438 tasks._set_task_name(task, name)
439
Victor Stinnerc39ba7d2014-07-11 00:21:27 +0200440 return task
Victor Stinner896a25a2014-07-08 11:29:25 +0200441
Yury Selivanov740169c2015-05-11 14:23:38 -0400442 def set_task_factory(self, factory):
443 """Set a task factory that will be used by loop.create_task().
444
445 If factory is None the default task factory will be set.
446
447 If factory is a callable, it should have a signature matching
448 '(loop, coro)', where 'loop' will be a reference to the active
449 event loop, 'coro' will be a coroutine object. The callable
450 must return a Future.
451 """
452 if factory is not None and not callable(factory):
453 raise TypeError('task factory must be a callable or None')
454 self._task_factory = factory
455
456 def get_task_factory(self):
457 """Return a task factory, or None if the default one is in use."""
458 return self._task_factory
459
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700460 def _make_socket_transport(self, sock, protocol, waiter=None, *,
461 extra=None, server=None):
462 """Create socket transport."""
463 raise NotImplementedError
464
Neil Aspinallf7686c12017-12-19 19:45:42 +0000465 def _make_ssl_transport(
466 self, rawsock, protocol, sslcontext, waiter=None,
467 *, server_side=False, server_hostname=None,
468 extra=None, server=None,
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500469 ssl_handshake_timeout=None,
470 call_connection_made=True):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700471 """Create SSL transport."""
472 raise NotImplementedError
473
474 def _make_datagram_transport(self, sock, protocol,
Victor Stinnerbfff45d2014-07-08 23:57:31 +0200475 address=None, waiter=None, extra=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700476 """Create datagram transport."""
477 raise NotImplementedError
478
479 def _make_read_pipe_transport(self, pipe, protocol, waiter=None,
480 extra=None):
481 """Create read pipe transport."""
482 raise NotImplementedError
483
484 def _make_write_pipe_transport(self, pipe, protocol, waiter=None,
485 extra=None):
486 """Create write pipe transport."""
487 raise NotImplementedError
488
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200489 async def _make_subprocess_transport(self, protocol, args, shell,
490 stdin, stdout, stderr, bufsize,
491 extra=None, **kwargs):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700492 """Create subprocess transport."""
493 raise NotImplementedError
494
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700495 def _write_to_self(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200496 """Write a byte to self-pipe, to wake up the event loop.
497
498 This may be called from a different thread.
499
500 The subclass is responsible for implementing the self-pipe.
501 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700502 raise NotImplementedError
503
504 def _process_events(self, event_list):
505 """Process selector events."""
506 raise NotImplementedError
507
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200508 def _check_closed(self):
509 if self._closed:
510 raise RuntimeError('Event loop is closed')
511
Kyle Stanley9fdc64c2019-09-19 08:47:22 -0400512 def _check_default_executor(self):
513 if self._executor_shutdown_called:
514 raise RuntimeError('Executor shutdown has been called')
515
Yury Selivanoveb636452016-09-08 22:01:51 -0700516 def _asyncgen_finalizer_hook(self, agen):
517 self._asyncgens.discard(agen)
518 if not self.is_closed():
twisteroid ambassadorc880ffe2018-10-09 23:30:21 +0800519 self.call_soon_threadsafe(self.create_task, agen.aclose())
Yury Selivanoveb636452016-09-08 22:01:51 -0700520
521 def _asyncgen_firstiter_hook(self, agen):
522 if self._asyncgens_shutdown_called:
523 warnings.warn(
Yury Selivanov6370f342017-12-10 18:36:12 -0500524 f"asynchronous generator {agen!r} was scheduled after "
525 f"loop.shutdown_asyncgens() call",
Yury Selivanoveb636452016-09-08 22:01:51 -0700526 ResourceWarning, source=self)
527
528 self._asyncgens.add(agen)
529
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200530 async def shutdown_asyncgens(self):
Yury Selivanoveb636452016-09-08 22:01:51 -0700531 """Shutdown all active asynchronous generators."""
532 self._asyncgens_shutdown_called = True
533
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500534 if not len(self._asyncgens):
Yury Selivanov0a91d482016-09-15 13:24:03 -0400535 # If Python version is <3.6 or we don't have any asynchronous
536 # generators alive.
Yury Selivanoveb636452016-09-08 22:01:51 -0700537 return
538
539 closing_agens = list(self._asyncgens)
540 self._asyncgens.clear()
541
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200542 results = await tasks.gather(
Yury Selivanoveb636452016-09-08 22:01:51 -0700543 *[ag.aclose() for ag in closing_agens],
544 return_exceptions=True,
545 loop=self)
546
Yury Selivanoveb636452016-09-08 22:01:51 -0700547 for result, agen in zip(results, closing_agens):
548 if isinstance(result, Exception):
549 self.call_exception_handler({
Yury Selivanov6370f342017-12-10 18:36:12 -0500550 'message': f'an error occurred during closing of '
551 f'asynchronous generator {agen!r}',
Yury Selivanoveb636452016-09-08 22:01:51 -0700552 'exception': result,
553 'asyncgen': agen
554 })
555
Kyle Stanley9fdc64c2019-09-19 08:47:22 -0400556 async def shutdown_default_executor(self):
557 """Schedule the shutdown of the default executor."""
558 self._executor_shutdown_called = True
559 if self._default_executor is None:
560 return
561 future = self.create_future()
562 thread = threading.Thread(target=self._do_shutdown, args=(future,))
563 thread.start()
564 try:
565 await future
566 finally:
567 thread.join()
568
569 def _do_shutdown(self, future):
570 try:
571 self._default_executor.shutdown(wait=True)
572 self.call_soon_threadsafe(future.set_result, None)
573 except Exception as ex:
574 self.call_soon_threadsafe(future.set_exception, ex)
575
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700576 def run_forever(self):
577 """Run until stop() is called."""
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200578 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100579 if self.is_running():
Yury Selivanov600a3492016-11-04 14:29:28 -0400580 raise RuntimeError('This event loop is already running')
581 if events._get_running_loop() is not None:
582 raise RuntimeError(
583 'Cannot run the event loop while another loop is running')
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800584 self._set_coroutine_origin_tracking(self._debug)
Victor Stinnera87501f2015-02-05 11:45:33 +0100585 self._thread_id = threading.get_ident()
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500586
587 old_agen_hooks = sys.get_asyncgen_hooks()
588 sys.set_asyncgen_hooks(firstiter=self._asyncgen_firstiter_hook,
589 finalizer=self._asyncgen_finalizer_hook)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700590 try:
Yury Selivanov600a3492016-11-04 14:29:28 -0400591 events._set_running_loop(self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700592 while True:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800593 self._run_once()
594 if self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700595 break
596 finally:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800597 self._stopping = False
Victor Stinnera87501f2015-02-05 11:45:33 +0100598 self._thread_id = None
Yury Selivanov600a3492016-11-04 14:29:28 -0400599 events._set_running_loop(None)
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800600 self._set_coroutine_origin_tracking(False)
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500601 sys.set_asyncgen_hooks(*old_agen_hooks)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700602
603 def run_until_complete(self, future):
604 """Run until the Future is done.
605
606 If the argument is a coroutine, it is wrapped in a Task.
607
Victor Stinneracdb7822014-07-14 18:33:40 +0200608 WARNING: It would be disastrous to call run_until_complete()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700609 with the same coroutine twice -- it would wrap it in two
610 different Tasks and that can't be good.
611
612 Return the Future's result, or raise its exception.
613 """
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200614 self._check_closed()
Victor Stinner98b63912014-06-30 14:51:04 +0200615
Guido van Rossum7b3b3dc2016-09-09 14:26:31 -0700616 new_task = not futures.isfuture(future)
Yury Selivanov59eb9a42015-05-11 14:48:38 -0400617 future = tasks.ensure_future(future, loop=self)
Victor Stinner98b63912014-06-30 14:51:04 +0200618 if new_task:
619 # An exception is raised if the future didn't complete, so there
620 # is no need to log the "destroy pending task" message
621 future._log_destroy_pending = False
622
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100623 future.add_done_callback(_run_until_complete_cb)
Victor Stinnerc8bd53f2014-10-11 14:30:18 +0200624 try:
625 self.run_forever()
626 except:
627 if new_task and future.done() and not future.cancelled():
628 # The coroutine raised a BaseException. Consume the exception
629 # to not log a warning, the caller doesn't have access to the
630 # local task.
631 future.exception()
632 raise
jimmylai21b3e042017-05-22 22:32:46 -0700633 finally:
634 future.remove_done_callback(_run_until_complete_cb)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700635 if not future.done():
636 raise RuntimeError('Event loop stopped before Future completed.')
637
638 return future.result()
639
640 def stop(self):
641 """Stop running the event loop.
642
Guido van Rossum41f69f42015-11-19 13:28:47 -0800643 Every callback already scheduled will still run. This simply informs
644 run_forever to stop looping after a complete iteration.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700645 """
Guido van Rossum41f69f42015-11-19 13:28:47 -0800646 self._stopping = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700647
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200648 def close(self):
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700649 """Close the event loop.
650
651 This clears the queues and shuts down the executor,
652 but does not wait for the executor to finish.
Victor Stinnerf328c7d2014-06-23 01:02:37 +0200653
654 The event loop must not be running.
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700655 """
Victor Stinner956de692014-12-26 21:07:52 +0100656 if self.is_running():
Victor Stinneracdb7822014-07-14 18:33:40 +0200657 raise RuntimeError("Cannot close a running event loop")
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200658 if self._closed:
659 return
Victor Stinnere912e652014-07-12 03:11:53 +0200660 if self._debug:
661 logger.debug("Close %r", self)
Yury Selivanove8944cb2015-05-12 11:43:04 -0400662 self._closed = True
663 self._ready.clear()
664 self._scheduled.clear()
Kyle Stanley9fdc64c2019-09-19 08:47:22 -0400665 self._executor_shutdown_called = True
Yury Selivanove8944cb2015-05-12 11:43:04 -0400666 executor = self._default_executor
667 if executor is not None:
668 self._default_executor = None
Łukasz Langa7f9a2ae2019-06-04 13:03:20 +0200669 executor.shutdown(wait=False)
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200670
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200671 def is_closed(self):
672 """Returns True if the event loop was closed."""
673 return self._closed
674
Victor Stinnerfb2c3462019-01-10 11:24:40 +0100675 def __del__(self, _warn=warnings.warn):
INADA Naoki3e2ad8e2017-04-25 10:57:18 +0900676 if not self.is_closed():
Victor Stinnerfb2c3462019-01-10 11:24:40 +0100677 _warn(f"unclosed event loop {self!r}", ResourceWarning, source=self)
INADA Naoki3e2ad8e2017-04-25 10:57:18 +0900678 if not self.is_running():
679 self.close()
Victor Stinner978a9af2015-01-29 17:50:58 +0100680
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700681 def is_running(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200682 """Returns True if the event loop is running."""
Victor Stinnera87501f2015-02-05 11:45:33 +0100683 return (self._thread_id is not None)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700684
685 def time(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200686 """Return the time according to the event loop's clock.
687
688 This is a float expressed in seconds since an epoch, but the
689 epoch, precision, accuracy and drift are unspecified and may
690 differ per event loop.
691 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700692 return time.monotonic()
693
Yury Selivanovf23746a2018-01-22 19:11:18 -0500694 def call_later(self, delay, callback, *args, context=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700695 """Arrange for a callback to be called at a given time.
696
697 Return a Handle: an opaque object with a cancel() method that
698 can be used to cancel the call.
699
700 The delay can be an int or float, expressed in seconds. It is
Victor Stinneracdb7822014-07-14 18:33:40 +0200701 always relative to the current time.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700702
703 Each callback will be called exactly once. If two callbacks
704 are scheduled for exactly the same time, it undefined which
705 will be called first.
706
707 Any positional arguments after the callback will be passed to
708 the callback when it is called.
709 """
Yury Selivanovf23746a2018-01-22 19:11:18 -0500710 timer = self.call_at(self.time() + delay, callback, *args,
711 context=context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200712 if timer._source_traceback:
713 del timer._source_traceback[-1]
714 return timer
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700715
Yury Selivanovf23746a2018-01-22 19:11:18 -0500716 def call_at(self, when, callback, *args, context=None):
Victor Stinneracdb7822014-07-14 18:33:40 +0200717 """Like call_later(), but uses an absolute time.
718
719 Absolute time corresponds to the event loop's time() method.
720 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100721 self._check_closed()
Victor Stinner93569c22014-03-21 10:00:52 +0100722 if self._debug:
Victor Stinner956de692014-12-26 21:07:52 +0100723 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700724 self._check_callback(callback, 'call_at')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500725 timer = events.TimerHandle(when, callback, args, self, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200726 if timer._source_traceback:
727 del timer._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700728 heapq.heappush(self._scheduled, timer)
Yury Selivanov592ada92014-09-25 12:07:56 -0400729 timer._scheduled = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700730 return timer
731
Yury Selivanovf23746a2018-01-22 19:11:18 -0500732 def call_soon(self, callback, *args, context=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700733 """Arrange for a callback to be called as soon as possible.
734
Victor Stinneracdb7822014-07-14 18:33:40 +0200735 This operates as a FIFO queue: callbacks are called in the
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700736 order in which they are registered. Each callback will be
737 called exactly once.
738
739 Any positional arguments after the callback will be passed to
740 the callback when it is called.
741 """
Yury Selivanov491a9122016-11-03 15:09:24 -0700742 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100743 if self._debug:
744 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700745 self._check_callback(callback, 'call_soon')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500746 handle = self._call_soon(callback, args, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200747 if handle._source_traceback:
748 del handle._source_traceback[-1]
749 return handle
Victor Stinner93569c22014-03-21 10:00:52 +0100750
Yury Selivanov491a9122016-11-03 15:09:24 -0700751 def _check_callback(self, callback, method):
752 if (coroutines.iscoroutine(callback) or
753 coroutines.iscoroutinefunction(callback)):
754 raise TypeError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500755 f"coroutines cannot be used with {method}()")
Yury Selivanov491a9122016-11-03 15:09:24 -0700756 if not callable(callback):
757 raise TypeError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500758 f'a callable object was expected by {method}(), '
759 f'got {callback!r}')
Yury Selivanov491a9122016-11-03 15:09:24 -0700760
Yury Selivanovf23746a2018-01-22 19:11:18 -0500761 def _call_soon(self, callback, args, context):
762 handle = events.Handle(callback, args, self, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200763 if handle._source_traceback:
764 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700765 self._ready.append(handle)
766 return handle
767
Victor Stinner956de692014-12-26 21:07:52 +0100768 def _check_thread(self):
769 """Check that the current thread is the thread running the event loop.
Victor Stinner93569c22014-03-21 10:00:52 +0100770
Victor Stinneracdb7822014-07-14 18:33:40 +0200771 Non-thread-safe methods of this class make this assumption and will
Victor Stinner93569c22014-03-21 10:00:52 +0100772 likely behave incorrectly when the assumption is violated.
773
Victor Stinneracdb7822014-07-14 18:33:40 +0200774 Should only be called when (self._debug == True). The caller is
Victor Stinner93569c22014-03-21 10:00:52 +0100775 responsible for checking this condition for performance reasons.
776 """
Victor Stinnera87501f2015-02-05 11:45:33 +0100777 if self._thread_id is None:
Victor Stinner751c7c02014-06-23 15:14:13 +0200778 return
Victor Stinner956de692014-12-26 21:07:52 +0100779 thread_id = threading.get_ident()
Victor Stinnera87501f2015-02-05 11:45:33 +0100780 if thread_id != self._thread_id:
Victor Stinner93569c22014-03-21 10:00:52 +0100781 raise RuntimeError(
Victor Stinneracdb7822014-07-14 18:33:40 +0200782 "Non-thread-safe operation invoked on an event loop other "
Victor Stinner93569c22014-03-21 10:00:52 +0100783 "than the current one")
784
Yury Selivanovf23746a2018-01-22 19:11:18 -0500785 def call_soon_threadsafe(self, callback, *args, context=None):
Victor Stinneracdb7822014-07-14 18:33:40 +0200786 """Like call_soon(), but thread-safe."""
Yury Selivanov491a9122016-11-03 15:09:24 -0700787 self._check_closed()
788 if self._debug:
789 self._check_callback(callback, 'call_soon_threadsafe')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500790 handle = self._call_soon(callback, args, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200791 if handle._source_traceback:
792 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700793 self._write_to_self()
794 return handle
795
Yury Selivanovbec23722018-01-28 14:09:40 -0500796 def run_in_executor(self, executor, func, *args):
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100797 self._check_closed()
Yury Selivanov491a9122016-11-03 15:09:24 -0700798 if self._debug:
799 self._check_callback(func, 'run_in_executor')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700800 if executor is None:
801 executor = self._default_executor
Kyle Stanley9fdc64c2019-09-19 08:47:22 -0400802 # Only check when the default executor is being used
803 self._check_default_executor()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700804 if executor is None:
Yury Selivanove8a60452016-10-21 17:40:42 -0400805 executor = concurrent.futures.ThreadPoolExecutor()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700806 self._default_executor = executor
Yury Selivanovbec23722018-01-28 14:09:40 -0500807 return futures.wrap_future(
Yury Selivanov19a44f62017-12-14 20:53:26 -0500808 executor.submit(func, *args), loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700809
810 def set_default_executor(self, executor):
Elvis Pranskevichus22d25082018-07-30 11:42:43 +0100811 if not isinstance(executor, concurrent.futures.ThreadPoolExecutor):
812 warnings.warn(
813 'Using the default executor that is not an instance of '
814 'ThreadPoolExecutor is deprecated and will be prohibited '
815 'in Python 3.9',
816 DeprecationWarning, 2)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700817 self._default_executor = executor
818
Victor Stinnere912e652014-07-12 03:11:53 +0200819 def _getaddrinfo_debug(self, host, port, family, type, proto, flags):
Yury Selivanov6370f342017-12-10 18:36:12 -0500820 msg = [f"{host}:{port!r}"]
Victor Stinnere912e652014-07-12 03:11:53 +0200821 if family:
Yury Selivanov19d0d542017-12-10 19:52:53 -0500822 msg.append(f'family={family!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200823 if type:
Yury Selivanov6370f342017-12-10 18:36:12 -0500824 msg.append(f'type={type!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200825 if proto:
Yury Selivanov6370f342017-12-10 18:36:12 -0500826 msg.append(f'proto={proto!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200827 if flags:
Yury Selivanov6370f342017-12-10 18:36:12 -0500828 msg.append(f'flags={flags!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200829 msg = ', '.join(msg)
Victor Stinneracdb7822014-07-14 18:33:40 +0200830 logger.debug('Get address info %s', msg)
Victor Stinnere912e652014-07-12 03:11:53 +0200831
832 t0 = self.time()
833 addrinfo = socket.getaddrinfo(host, port, family, type, proto, flags)
834 dt = self.time() - t0
835
Yury Selivanov6370f342017-12-10 18:36:12 -0500836 msg = f'Getting address info {msg} took {dt * 1e3:.3f}ms: {addrinfo!r}'
Victor Stinnere912e652014-07-12 03:11:53 +0200837 if dt >= self.slow_callback_duration:
838 logger.info(msg)
839 else:
840 logger.debug(msg)
841 return addrinfo
842
Yury Selivanov19a44f62017-12-14 20:53:26 -0500843 async def getaddrinfo(self, host, port, *,
844 family=0, type=0, proto=0, flags=0):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400845 if self._debug:
Yury Selivanov19a44f62017-12-14 20:53:26 -0500846 getaddr_func = self._getaddrinfo_debug
Victor Stinnere912e652014-07-12 03:11:53 +0200847 else:
Yury Selivanov19a44f62017-12-14 20:53:26 -0500848 getaddr_func = socket.getaddrinfo
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700849
Yury Selivanov19a44f62017-12-14 20:53:26 -0500850 return await self.run_in_executor(
851 None, getaddr_func, host, port, family, type, proto, flags)
852
853 async def getnameinfo(self, sockaddr, flags=0):
854 return await self.run_in_executor(
855 None, socket.getnameinfo, sockaddr, flags)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700856
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200857 async def sock_sendfile(self, sock, file, offset=0, count=None,
858 *, fallback=True):
859 if self._debug and sock.gettimeout() != 0:
860 raise ValueError("the socket must be non-blocking")
861 self._check_sendfile_params(sock, file, offset, count)
862 try:
863 return await self._sock_sendfile_native(sock, file,
864 offset, count)
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700865 except exceptions.SendfileNotAvailableError as exc:
Andrew Svetlov7464e872018-01-19 20:04:29 +0200866 if not fallback:
867 raise
868 return await self._sock_sendfile_fallback(sock, file,
869 offset, count)
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200870
871 async def _sock_sendfile_native(self, sock, file, offset, count):
872 # NB: sendfile syscall is not supported for SSL sockets and
873 # non-mmap files even if sendfile is supported by OS
Andrew Svetlov0baa72f2018-09-11 10:13:04 -0700874 raise exceptions.SendfileNotAvailableError(
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200875 f"syscall sendfile is not available for socket {sock!r} "
876 "and file {file!r} combination")
877
878 async def _sock_sendfile_fallback(self, sock, file, offset, count):
879 if offset:
880 file.seek(offset)
Yury Selivanov71657542018-05-28 18:31:55 -0400881 blocksize = (
882 min(count, constants.SENDFILE_FALLBACK_READBUFFER_SIZE)
883 if count else constants.SENDFILE_FALLBACK_READBUFFER_SIZE
884 )
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200885 buf = bytearray(blocksize)
886 total_sent = 0
887 try:
888 while True:
889 if count:
890 blocksize = min(count - total_sent, blocksize)
891 if blocksize <= 0:
892 break
893 view = memoryview(buf)[:blocksize]
Yury Selivanov71657542018-05-28 18:31:55 -0400894 read = await self.run_in_executor(None, file.readinto, view)
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200895 if not read:
896 break # EOF
Andrew Svetlovef215232019-06-15 14:05:08 +0300897 await self.sock_sendall(sock, view[:read])
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200898 total_sent += read
899 return total_sent
900 finally:
901 if total_sent > 0 and hasattr(file, 'seek'):
902 file.seek(offset + total_sent)
903
904 def _check_sendfile_params(self, sock, file, offset, count):
905 if 'b' not in getattr(file, 'mode', 'b'):
906 raise ValueError("file should be opened in binary mode")
907 if not sock.type == socket.SOCK_STREAM:
908 raise ValueError("only SOCK_STREAM type sockets are supported")
909 if count is not None:
910 if not isinstance(count, int):
911 raise TypeError(
912 "count must be a positive integer (got {!r})".format(count))
913 if count <= 0:
914 raise ValueError(
915 "count must be a positive integer (got {!r})".format(count))
916 if not isinstance(offset, int):
917 raise TypeError(
918 "offset must be a non-negative integer (got {!r})".format(
919 offset))
920 if offset < 0:
921 raise ValueError(
922 "offset must be a non-negative integer (got {!r})".format(
923 offset))
924
twisteroid ambassador88f07a82019-05-05 19:14:35 +0800925 async def _connect_sock(self, exceptions, addr_info, local_addr_infos=None):
926 """Create, bind and connect one socket."""
927 my_exceptions = []
928 exceptions.append(my_exceptions)
929 family, type_, proto, _, address = addr_info
930 sock = None
931 try:
932 sock = socket.socket(family=family, type=type_, proto=proto)
933 sock.setblocking(False)
934 if local_addr_infos is not None:
935 for _, _, _, _, laddr in local_addr_infos:
936 try:
937 sock.bind(laddr)
938 break
939 except OSError as exc:
940 msg = (
941 f'error while attempting to bind on '
942 f'address {laddr!r}: '
943 f'{exc.strerror.lower()}'
944 )
945 exc = OSError(exc.errno, msg)
946 my_exceptions.append(exc)
947 else: # all bind attempts failed
948 raise my_exceptions.pop()
949 await self.sock_connect(sock, address)
950 return sock
951 except OSError as exc:
952 my_exceptions.append(exc)
953 if sock is not None:
954 sock.close()
955 raise
956 except:
957 if sock is not None:
958 sock.close()
959 raise
960
Neil Aspinallf7686c12017-12-19 19:45:42 +0000961 async def create_connection(
962 self, protocol_factory, host=None, port=None,
963 *, ssl=None, family=0,
964 proto=0, flags=0, sock=None,
965 local_addr=None, server_hostname=None,
twisteroid ambassador88f07a82019-05-05 19:14:35 +0800966 ssl_handshake_timeout=None,
967 happy_eyeballs_delay=None, interleave=None):
Victor Stinnerd1432092014-06-19 17:11:49 +0200968 """Connect to a TCP server.
969
970 Create a streaming transport connection to a given Internet host and
971 port: socket family AF_INET or socket.AF_INET6 depending on host (or
972 family if specified), socket type SOCK_STREAM. protocol_factory must be
973 a callable returning a protocol instance.
974
975 This method is a coroutine which will try to establish the connection
976 in the background. When successful, the coroutine returns a
977 (transport, protocol) pair.
978 """
Guido van Rossum21c85a72013-11-01 14:16:54 -0700979 if server_hostname is not None and not ssl:
980 raise ValueError('server_hostname is only meaningful with ssl')
981
982 if server_hostname is None and ssl:
983 # Use host as default for server_hostname. It is an error
984 # if host is empty or not set, e.g. when an
985 # already-connected socket was passed or when only a port
986 # is given. To avoid this error, you can pass
987 # server_hostname='' -- this will bypass the hostname
988 # check. (This also means that if host is a numeric
989 # IP/IPv6 address, we will attempt to verify that exact
990 # address; this will probably fail, but it is possible to
991 # create a certificate for a specific IP address, so we
992 # don't judge it here.)
993 if not host:
994 raise ValueError('You must set server_hostname '
995 'when using ssl without a host')
996 server_hostname = host
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700997
Andrew Svetlov51eb1c62017-12-20 20:24:43 +0200998 if ssl_handshake_timeout is not None and not ssl:
999 raise ValueError(
1000 'ssl_handshake_timeout is only meaningful with ssl')
1001
twisteroid ambassador88f07a82019-05-05 19:14:35 +08001002 if happy_eyeballs_delay is not None and interleave is None:
1003 # If using happy eyeballs, default to interleave addresses by family
1004 interleave = 1
1005
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001006 if host is not None or port is not None:
1007 if sock is not None:
1008 raise ValueError(
1009 'host/port and sock can not be specified at the same time')
1010
Yury Selivanov19a44f62017-12-14 20:53:26 -05001011 infos = await self._ensure_resolved(
1012 (host, port), family=family,
1013 type=socket.SOCK_STREAM, proto=proto, flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001014 if not infos:
1015 raise OSError('getaddrinfo() returned empty list')
Yury Selivanov19a44f62017-12-14 20:53:26 -05001016
1017 if local_addr is not None:
1018 laddr_infos = await self._ensure_resolved(
1019 local_addr, family=family,
1020 type=socket.SOCK_STREAM, proto=proto,
1021 flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001022 if not laddr_infos:
1023 raise OSError('getaddrinfo() returned empty list')
twisteroid ambassador88f07a82019-05-05 19:14:35 +08001024 else:
1025 laddr_infos = None
1026
1027 if interleave:
1028 infos = _interleave_addrinfos(infos, interleave)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001029
1030 exceptions = []
twisteroid ambassador88f07a82019-05-05 19:14:35 +08001031 if happy_eyeballs_delay is None:
1032 # not using happy eyeballs
1033 for addrinfo in infos:
1034 try:
1035 sock = await self._connect_sock(
1036 exceptions, addrinfo, laddr_infos)
1037 break
1038 except OSError:
1039 continue
1040 else: # using happy eyeballs
1041 sock, _, _ = await staggered.staggered_race(
1042 (functools.partial(self._connect_sock,
1043 exceptions, addrinfo, laddr_infos)
1044 for addrinfo in infos),
1045 happy_eyeballs_delay, loop=self)
1046
1047 if sock is None:
1048 exceptions = [exc for sub in exceptions for exc in sub]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001049 if len(exceptions) == 1:
1050 raise exceptions[0]
1051 else:
1052 # If they all have the same str(), raise one.
1053 model = str(exceptions[0])
1054 if all(str(exc) == model for exc in exceptions):
1055 raise exceptions[0]
1056 # Raise a combined exception so the user can see all
1057 # the various error messages.
1058 raise OSError('Multiple exceptions: {}'.format(
1059 ', '.join(str(exc) for exc in exceptions)))
1060
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001061 else:
1062 if sock is None:
1063 raise ValueError(
1064 'host and port was not specified and no sock specified')
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001065 if sock.type != socket.SOCK_STREAM:
Yury Selivanovdab05842016-11-21 17:47:27 -05001066 # We allow AF_INET, AF_INET6, AF_UNIX as long as they
1067 # are SOCK_STREAM.
1068 # We support passing AF_UNIX sockets even though we have
1069 # a dedicated API for that: create_unix_connection.
1070 # Disallowing AF_UNIX in this method, breaks backwards
1071 # compatibility.
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001072 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001073 f'A Stream Socket was expected, got {sock!r}')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001074
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001075 transport, protocol = await self._create_connection_transport(
Neil Aspinallf7686c12017-12-19 19:45:42 +00001076 sock, protocol_factory, ssl, server_hostname,
1077 ssl_handshake_timeout=ssl_handshake_timeout)
Victor Stinnere912e652014-07-12 03:11:53 +02001078 if self._debug:
Victor Stinnerb2614752014-08-25 23:20:52 +02001079 # Get the socket from the transport because SSL transport closes
1080 # the old socket and creates a new SSL socket
1081 sock = transport.get_extra_info('socket')
Victor Stinneracdb7822014-07-14 18:33:40 +02001082 logger.debug("%r connected to %s:%r: (%r, %r)",
1083 sock, host, port, transport, protocol)
Yury Selivanovb057c522014-02-18 12:15:06 -05001084 return transport, protocol
1085
Neil Aspinallf7686c12017-12-19 19:45:42 +00001086 async def _create_connection_transport(
1087 self, sock, protocol_factory, ssl,
1088 server_hostname, server_side=False,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001089 ssl_handshake_timeout=None):
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001090
1091 sock.setblocking(False)
1092
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001093 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001094 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001095 if ssl:
1096 sslcontext = None if isinstance(ssl, bool) else ssl
1097 transport = self._make_ssl_transport(
1098 sock, protocol, sslcontext, waiter,
Neil Aspinallf7686c12017-12-19 19:45:42 +00001099 server_side=server_side, server_hostname=server_hostname,
1100 ssl_handshake_timeout=ssl_handshake_timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001101 else:
1102 transport = self._make_socket_transport(sock, protocol, waiter)
1103
Victor Stinner29ad0112015-01-15 00:04:21 +01001104 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001105 await waiter
Victor Stinner0c2e4082015-01-22 00:17:41 +01001106 except:
Victor Stinner29ad0112015-01-15 00:04:21 +01001107 transport.close()
1108 raise
1109
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001110 return transport, protocol
1111
Andrew Svetlov7c684072018-01-27 21:22:47 +02001112 async def sendfile(self, transport, file, offset=0, count=None,
1113 *, fallback=True):
1114 """Send a file to transport.
1115
1116 Return the total number of bytes which were sent.
1117
1118 The method uses high-performance os.sendfile if available.
1119
1120 file must be a regular file object opened in binary mode.
1121
1122 offset tells from where to start reading the file. If specified,
1123 count is the total number of bytes to transmit as opposed to
1124 sending the file until EOF is reached. File position is updated on
1125 return or also in case of error in which case file.tell()
1126 can be used to figure out the number of bytes
1127 which were sent.
1128
1129 fallback set to True makes asyncio to manually read and send
1130 the file when the platform does not support the sendfile syscall
1131 (e.g. Windows or SSL socket on Unix).
1132
1133 Raise SendfileNotAvailableError if the system does not support
1134 sendfile syscall and fallback is False.
1135 """
1136 if transport.is_closing():
1137 raise RuntimeError("Transport is closing")
1138 mode = getattr(transport, '_sendfile_compatible',
1139 constants._SendfileMode.UNSUPPORTED)
1140 if mode is constants._SendfileMode.UNSUPPORTED:
1141 raise RuntimeError(
1142 f"sendfile is not supported for transport {transport!r}")
1143 if mode is constants._SendfileMode.TRY_NATIVE:
1144 try:
1145 return await self._sendfile_native(transport, file,
1146 offset, count)
Andrew Svetlov0baa72f2018-09-11 10:13:04 -07001147 except exceptions.SendfileNotAvailableError as exc:
Andrew Svetlov7c684072018-01-27 21:22:47 +02001148 if not fallback:
1149 raise
Yury Selivanovb1a6ac42018-01-27 15:52:52 -05001150
1151 if not fallback:
1152 raise RuntimeError(
1153 f"fallback is disabled and native sendfile is not "
1154 f"supported for transport {transport!r}")
1155
Andrew Svetlov7c684072018-01-27 21:22:47 +02001156 return await self._sendfile_fallback(transport, file,
1157 offset, count)
1158
1159 async def _sendfile_native(self, transp, file, offset, count):
Andrew Svetlov0baa72f2018-09-11 10:13:04 -07001160 raise exceptions.SendfileNotAvailableError(
Andrew Svetlov7c684072018-01-27 21:22:47 +02001161 "sendfile syscall is not supported")
1162
1163 async def _sendfile_fallback(self, transp, file, offset, count):
1164 if offset:
1165 file.seek(offset)
1166 blocksize = min(count, 16384) if count else 16384
1167 buf = bytearray(blocksize)
1168 total_sent = 0
1169 proto = _SendfileFallbackProtocol(transp)
1170 try:
1171 while True:
1172 if count:
1173 blocksize = min(count - total_sent, blocksize)
1174 if blocksize <= 0:
1175 return total_sent
1176 view = memoryview(buf)[:blocksize]
Andrew Svetlov02372652019-06-15 14:05:35 +03001177 read = await self.run_in_executor(None, file.readinto, view)
Andrew Svetlov7c684072018-01-27 21:22:47 +02001178 if not read:
1179 return total_sent # EOF
1180 await proto.drain()
Andrew Svetlovef215232019-06-15 14:05:08 +03001181 transp.write(view[:read])
Andrew Svetlov7c684072018-01-27 21:22:47 +02001182 total_sent += read
1183 finally:
1184 if total_sent > 0 and hasattr(file, 'seek'):
1185 file.seek(offset + total_sent)
1186 await proto.restore()
1187
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001188 async def start_tls(self, transport, protocol, sslcontext, *,
1189 server_side=False,
1190 server_hostname=None,
1191 ssl_handshake_timeout=None):
1192 """Upgrade transport to TLS.
1193
1194 Return a new transport that *protocol* should start using
1195 immediately.
1196 """
1197 if ssl is None:
1198 raise RuntimeError('Python ssl module is not available')
1199
1200 if not isinstance(sslcontext, ssl.SSLContext):
1201 raise TypeError(
1202 f'sslcontext is expected to be an instance of ssl.SSLContext, '
1203 f'got {sslcontext!r}')
1204
1205 if not getattr(transport, '_start_tls_compatible', False):
1206 raise TypeError(
Yury Selivanov415bc462018-06-05 08:59:58 -04001207 f'transport {transport!r} is not supported by start_tls()')
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001208
1209 waiter = self.create_future()
1210 ssl_protocol = sslproto.SSLProtocol(
1211 self, protocol, sslcontext, waiter,
1212 server_side, server_hostname,
1213 ssl_handshake_timeout=ssl_handshake_timeout,
1214 call_connection_made=False)
1215
Yury Selivanovf2955872018-05-29 01:00:12 -04001216 # Pause early so that "ssl_protocol.data_received()" doesn't
1217 # have a chance to get called before "ssl_protocol.connection_made()".
1218 transport.pause_reading()
1219
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001220 transport.set_protocol(ssl_protocol)
Yury Selivanov415bc462018-06-05 08:59:58 -04001221 conmade_cb = self.call_soon(ssl_protocol.connection_made, transport)
1222 resume_cb = self.call_soon(transport.resume_reading)
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001223
Yury Selivanov96026432018-06-04 11:32:35 -04001224 try:
1225 await waiter
Yury Selivanov431b5402019-05-27 14:45:12 +02001226 except BaseException:
Yury Selivanov96026432018-06-04 11:32:35 -04001227 transport.close()
Yury Selivanov415bc462018-06-05 08:59:58 -04001228 conmade_cb.cancel()
1229 resume_cb.cancel()
Yury Selivanov96026432018-06-04 11:32:35 -04001230 raise
1231
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001232 return ssl_protocol._app_transport
1233
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001234 async def create_datagram_endpoint(self, protocol_factory,
1235 local_addr=None, remote_addr=None, *,
1236 family=0, proto=0, flags=0,
Kyle Stanleyab513a32019-12-09 09:21:10 -05001237 reuse_address=_unset, reuse_port=None,
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001238 allow_broadcast=None, sock=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001239 """Create datagram connection."""
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001240 if sock is not None:
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001241 if sock.type != socket.SOCK_DGRAM:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001242 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001243 f'A UDP Socket was expected, got {sock!r}')
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001244 if (local_addr or remote_addr or
1245 family or proto or flags or
Kyle Stanleyab513a32019-12-09 09:21:10 -05001246 reuse_port or allow_broadcast):
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001247 # show the problematic kwargs in exception msg
1248 opts = dict(local_addr=local_addr, remote_addr=remote_addr,
1249 family=family, proto=proto, flags=flags,
1250 reuse_address=reuse_address, reuse_port=reuse_port,
1251 allow_broadcast=allow_broadcast)
Yury Selivanov6370f342017-12-10 18:36:12 -05001252 problems = ', '.join(f'{k}={v}' for k, v in opts.items() if v)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001253 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001254 f'socket modifier keyword arguments can not be used '
1255 f'when sock is specified. ({problems})')
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001256 sock.setblocking(False)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001257 r_addr = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001258 else:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001259 if not (local_addr or remote_addr):
1260 if family == 0:
1261 raise ValueError('unexpected address family')
1262 addr_pairs_info = (((family, proto), (None, None)),)
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001263 elif hasattr(socket, 'AF_UNIX') and family == socket.AF_UNIX:
1264 for addr in (local_addr, remote_addr):
Victor Stinner28e61652017-11-28 00:34:08 +01001265 if addr is not None and not isinstance(addr, str):
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001266 raise TypeError('string is expected')
Quentin Dawans56065d42019-04-09 15:40:59 +02001267
1268 if local_addr and local_addr[0] not in (0, '\x00'):
1269 try:
1270 if stat.S_ISSOCK(os.stat(local_addr).st_mode):
1271 os.remove(local_addr)
1272 except FileNotFoundError:
1273 pass
1274 except OSError as err:
1275 # Directory may have permissions only to create socket.
1276 logger.error('Unable to check or remove stale UNIX '
1277 'socket %r: %r',
1278 local_addr, err)
1279
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001280 addr_pairs_info = (((family, proto),
1281 (local_addr, remote_addr)), )
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001282 else:
1283 # join address by (family, protocol)
Inada Naokif3451702019-02-05 17:04:40 +09001284 addr_infos = {} # Using order preserving dict
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001285 for idx, addr in ((0, local_addr), (1, remote_addr)):
1286 if addr is not None:
1287 assert isinstance(addr, tuple) and len(addr) == 2, (
1288 '2-tuple is expected')
1289
Yury Selivanov19a44f62017-12-14 20:53:26 -05001290 infos = await self._ensure_resolved(
Yury Selivanovf1c6fa92016-06-08 12:33:31 -04001291 addr, family=family, type=socket.SOCK_DGRAM,
1292 proto=proto, flags=flags, loop=self)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001293 if not infos:
1294 raise OSError('getaddrinfo() returned empty list')
1295
1296 for fam, _, pro, _, address in infos:
1297 key = (fam, pro)
1298 if key not in addr_infos:
1299 addr_infos[key] = [None, None]
1300 addr_infos[key][idx] = address
1301
1302 # each addr has to have info for each (family, proto) pair
1303 addr_pairs_info = [
1304 (key, addr_pair) for key, addr_pair in addr_infos.items()
1305 if not ((local_addr and addr_pair[0] is None) or
1306 (remote_addr and addr_pair[1] is None))]
1307
1308 if not addr_pairs_info:
1309 raise ValueError('can not get address information')
1310
1311 exceptions = []
1312
Kyle Stanleyab513a32019-12-09 09:21:10 -05001313 # bpo-37228
1314 if reuse_address is not _unset:
1315 if reuse_address:
1316 raise ValueError("Passing `reuse_address=True` is no "
1317 "longer supported, as the usage of "
1318 "SO_REUSEPORT in UDP poses a significant "
1319 "security concern.")
1320 else:
1321 warnings.warn("The *reuse_address* parameter has been "
1322 "deprecated as of 3.5.10 and is scheduled "
1323 "for removal in 3.11.", DeprecationWarning,
1324 stacklevel=2)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001325
1326 for ((family, proto),
1327 (local_address, remote_address)) in addr_pairs_info:
1328 sock = None
1329 r_addr = None
1330 try:
1331 sock = socket.socket(
1332 family=family, type=socket.SOCK_DGRAM, proto=proto)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001333 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001334 _set_reuseport(sock)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001335 if allow_broadcast:
1336 sock.setsockopt(
1337 socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
1338 sock.setblocking(False)
1339
1340 if local_addr:
1341 sock.bind(local_address)
1342 if remote_addr:
Vincent Michel63deaa52019-05-07 19:18:49 +02001343 if not allow_broadcast:
1344 await self.sock_connect(sock, remote_address)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001345 r_addr = remote_address
1346 except OSError as exc:
1347 if sock is not None:
1348 sock.close()
1349 exceptions.append(exc)
1350 except:
1351 if sock is not None:
1352 sock.close()
1353 raise
1354 else:
1355 break
1356 else:
1357 raise exceptions[0]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001358
1359 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001360 waiter = self.create_future()
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001361 transport = self._make_datagram_transport(
1362 sock, protocol, r_addr, waiter)
Victor Stinnere912e652014-07-12 03:11:53 +02001363 if self._debug:
1364 if local_addr:
1365 logger.info("Datagram endpoint local_addr=%r remote_addr=%r "
1366 "created: (%r, %r)",
1367 local_addr, remote_addr, transport, protocol)
1368 else:
1369 logger.debug("Datagram endpoint remote_addr=%r created: "
1370 "(%r, %r)",
1371 remote_addr, transport, protocol)
Victor Stinner2596dd02015-01-26 11:02:18 +01001372
1373 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001374 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001375 except:
1376 transport.close()
1377 raise
1378
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001379 return transport, protocol
1380
Yury Selivanov19a44f62017-12-14 20:53:26 -05001381 async def _ensure_resolved(self, address, *,
1382 family=0, type=socket.SOCK_STREAM,
1383 proto=0, flags=0, loop):
1384 host, port = address[:2]
Erwan Le Papeac8eb8f2019-05-17 10:28:39 +02001385 info = _ipaddr_info(host, port, family, type, proto, *address[2:])
Yury Selivanov19a44f62017-12-14 20:53:26 -05001386 if info is not None:
1387 # "host" is already a resolved IP.
1388 return [info]
1389 else:
1390 return await loop.getaddrinfo(host, port, family=family, type=type,
1391 proto=proto, flags=flags)
1392
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001393 async def _create_server_getaddrinfo(self, host, port, family, flags):
Yury Selivanov19a44f62017-12-14 20:53:26 -05001394 infos = await self._ensure_resolved((host, port), family=family,
1395 type=socket.SOCK_STREAM,
1396 flags=flags, loop=self)
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001397 if not infos:
Yury Selivanov6370f342017-12-10 18:36:12 -05001398 raise OSError(f'getaddrinfo({host!r}) returned empty list')
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001399 return infos
1400
Neil Aspinallf7686c12017-12-19 19:45:42 +00001401 async def create_server(
1402 self, protocol_factory, host=None, port=None,
1403 *,
1404 family=socket.AF_UNSPEC,
1405 flags=socket.AI_PASSIVE,
1406 sock=None,
1407 backlog=100,
1408 ssl=None,
1409 reuse_address=None,
1410 reuse_port=None,
Yury Selivanovc9070d02018-01-25 18:08:09 -05001411 ssl_handshake_timeout=None,
1412 start_serving=True):
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001413 """Create a TCP server.
1414
Yury Selivanov6370f342017-12-10 18:36:12 -05001415 The host parameter can be a string, in that case the TCP server is
1416 bound to host and port.
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001417
1418 The host parameter can also be a sequence of strings and in that case
Yury Selivanove076ffb2016-03-02 11:17:01 -05001419 the TCP server is bound to all hosts of the sequence. If a host
1420 appears multiple times (possibly indirectly e.g. when hostnames
1421 resolve to the same IP address), the server is only bound once to that
1422 host.
Victor Stinnerd1432092014-06-19 17:11:49 +02001423
Victor Stinneracdb7822014-07-14 18:33:40 +02001424 Return a Server object which can be used to stop the service.
Victor Stinnerd1432092014-06-19 17:11:49 +02001425
1426 This method is a coroutine.
1427 """
Guido van Rossum28dff0d2013-11-01 14:22:30 -07001428 if isinstance(ssl, bool):
1429 raise TypeError('ssl argument must be an SSLContext or None')
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001430
1431 if ssl_handshake_timeout is not None and ssl is None:
1432 raise ValueError(
1433 'ssl_handshake_timeout is only meaningful with ssl')
1434
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001435 if host is not None or port is not None:
1436 if sock is not None:
1437 raise ValueError(
1438 'host/port and sock can not be specified at the same time')
1439
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001440 if reuse_address is None:
1441 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
1442 sockets = []
1443 if host == '':
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001444 hosts = [None]
1445 elif (isinstance(host, str) or
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001446 not isinstance(host, collections.abc.Iterable)):
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001447 hosts = [host]
1448 else:
1449 hosts = host
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001450
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001451 fs = [self._create_server_getaddrinfo(host, port, family=family,
1452 flags=flags)
1453 for host in hosts]
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001454 infos = await tasks.gather(*fs, loop=self)
Yury Selivanove076ffb2016-03-02 11:17:01 -05001455 infos = set(itertools.chain.from_iterable(infos))
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001456
1457 completed = False
1458 try:
1459 for res in infos:
1460 af, socktype, proto, canonname, sa = res
Guido van Rossum32e46852013-10-19 17:04:25 -07001461 try:
1462 sock = socket.socket(af, socktype, proto)
1463 except socket.error:
1464 # Assume it's a bad family/type/protocol combination.
Victor Stinnerb2614752014-08-25 23:20:52 +02001465 if self._debug:
1466 logger.warning('create_server() failed to create '
1467 'socket.socket(%r, %r, %r)',
1468 af, socktype, proto, exc_info=True)
Guido van Rossum32e46852013-10-19 17:04:25 -07001469 continue
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001470 sockets.append(sock)
1471 if reuse_address:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001472 sock.setsockopt(
1473 socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
1474 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001475 _set_reuseport(sock)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001476 # Disable IPv4/IPv6 dual stack support (enabled by
1477 # default on Linux) which makes a single socket
1478 # listen on both address families.
Yury Selivanovd904c232018-06-28 21:59:32 -04001479 if (_HAS_IPv6 and
1480 af == socket.AF_INET6 and
1481 hasattr(socket, 'IPPROTO_IPV6')):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001482 sock.setsockopt(socket.IPPROTO_IPV6,
1483 socket.IPV6_V6ONLY,
1484 True)
1485 try:
1486 sock.bind(sa)
1487 except OSError as err:
1488 raise OSError(err.errno, 'error while attempting '
1489 'to bind on address %r: %s'
Serhiy Storchaka5affd232017-04-05 09:37:24 +03001490 % (sa, err.strerror.lower())) from None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001491 completed = True
1492 finally:
1493 if not completed:
1494 for sock in sockets:
1495 sock.close()
1496 else:
1497 if sock is None:
Victor Stinneracdb7822014-07-14 18:33:40 +02001498 raise ValueError('Neither host/port nor sock were specified')
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001499 if sock.type != socket.SOCK_STREAM:
Yury Selivanov6370f342017-12-10 18:36:12 -05001500 raise ValueError(f'A Stream Socket was expected, got {sock!r}')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001501 sockets = [sock]
1502
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001503 for sock in sockets:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001504 sock.setblocking(False)
Yury Selivanovc9070d02018-01-25 18:08:09 -05001505
1506 server = Server(self, sockets, protocol_factory,
1507 ssl, backlog, ssl_handshake_timeout)
1508 if start_serving:
1509 server._start_serving()
Yury Selivanovdbf10222018-05-28 14:31:28 -04001510 # Skip one loop iteration so that all 'loop.add_reader'
1511 # go through.
1512 await tasks.sleep(0, loop=self)
Yury Selivanovc9070d02018-01-25 18:08:09 -05001513
Victor Stinnere912e652014-07-12 03:11:53 +02001514 if self._debug:
1515 logger.info("%r is serving", server)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001516 return server
1517
Neil Aspinallf7686c12017-12-19 19:45:42 +00001518 async def connect_accepted_socket(
1519 self, protocol_factory, sock,
1520 *, ssl=None,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001521 ssl_handshake_timeout=None):
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001522 """Handle an accepted connection.
1523
1524 This is used by servers that accept connections outside of
1525 asyncio but that use asyncio to handle connections.
1526
1527 This method is a coroutine. When completed, the coroutine
1528 returns a (transport, protocol) pair.
1529 """
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001530 if sock.type != socket.SOCK_STREAM:
Yury Selivanov6370f342017-12-10 18:36:12 -05001531 raise ValueError(f'A Stream Socket was expected, got {sock!r}')
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001532
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001533 if ssl_handshake_timeout is not None and not ssl:
1534 raise ValueError(
1535 'ssl_handshake_timeout is only meaningful with ssl')
1536
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001537 transport, protocol = await self._create_connection_transport(
Neil Aspinallf7686c12017-12-19 19:45:42 +00001538 sock, protocol_factory, ssl, '', server_side=True,
1539 ssl_handshake_timeout=ssl_handshake_timeout)
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001540 if self._debug:
1541 # Get the socket from the transport because SSL transport closes
1542 # the old socket and creates a new SSL socket
1543 sock = transport.get_extra_info('socket')
1544 logger.debug("%r handled: (%r, %r)", sock, transport, protocol)
1545 return transport, protocol
1546
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001547 async def connect_read_pipe(self, protocol_factory, pipe):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001548 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001549 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001550 transport = self._make_read_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001551
1552 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001553 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001554 except:
1555 transport.close()
1556 raise
1557
Victor Stinneracdb7822014-07-14 18:33:40 +02001558 if self._debug:
1559 logger.debug('Read pipe %r connected: (%r, %r)',
1560 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001561 return transport, protocol
1562
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001563 async def connect_write_pipe(self, protocol_factory, pipe):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001564 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001565 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001566 transport = self._make_write_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001567
1568 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001569 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001570 except:
1571 transport.close()
1572 raise
1573
Victor Stinneracdb7822014-07-14 18:33:40 +02001574 if self._debug:
1575 logger.debug('Write pipe %r connected: (%r, %r)',
1576 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001577 return transport, protocol
1578
Victor Stinneracdb7822014-07-14 18:33:40 +02001579 def _log_subprocess(self, msg, stdin, stdout, stderr):
1580 info = [msg]
1581 if stdin is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001582 info.append(f'stdin={_format_pipe(stdin)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001583 if stdout is not None and stderr == subprocess.STDOUT:
Yury Selivanov6370f342017-12-10 18:36:12 -05001584 info.append(f'stdout=stderr={_format_pipe(stdout)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001585 else:
1586 if stdout is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001587 info.append(f'stdout={_format_pipe(stdout)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001588 if stderr is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001589 info.append(f'stderr={_format_pipe(stderr)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001590 logger.debug(' '.join(info))
1591
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001592 async def subprocess_shell(self, protocol_factory, cmd, *,
1593 stdin=subprocess.PIPE,
1594 stdout=subprocess.PIPE,
1595 stderr=subprocess.PIPE,
1596 universal_newlines=False,
1597 shell=True, bufsize=0,
sbstpf0d4c642019-05-27 19:51:19 -04001598 encoding=None, errors=None, text=None,
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001599 **kwargs):
Victor Stinner20e07432014-02-11 11:44:56 +01001600 if not isinstance(cmd, (bytes, str)):
Victor Stinnere623a122014-01-29 14:35:15 -08001601 raise ValueError("cmd must be a string")
1602 if universal_newlines:
1603 raise ValueError("universal_newlines must be False")
1604 if not shell:
Victor Stinner323748e2014-01-31 12:28:30 +01001605 raise ValueError("shell must be True")
Victor Stinnere623a122014-01-29 14:35:15 -08001606 if bufsize != 0:
1607 raise ValueError("bufsize must be 0")
sbstpf0d4c642019-05-27 19:51:19 -04001608 if text:
1609 raise ValueError("text must be False")
1610 if encoding is not None:
1611 raise ValueError("encoding must be None")
1612 if errors is not None:
1613 raise ValueError("errors must be None")
1614
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001615 protocol = protocol_factory()
Yury Selivanov12f482e2018-06-08 18:24:37 -04001616 debug_log = None
Victor Stinneracdb7822014-07-14 18:33:40 +02001617 if self._debug:
1618 # don't log parameters: they may contain sensitive information
1619 # (password) and may be too long
1620 debug_log = 'run shell command %r' % cmd
1621 self._log_subprocess(debug_log, stdin, stdout, stderr)
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001622 transport = await self._make_subprocess_transport(
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001623 protocol, cmd, True, stdin, stdout, stderr, bufsize, **kwargs)
Yury Selivanov12f482e2018-06-08 18:24:37 -04001624 if self._debug and debug_log is not None:
Vinay Sajipdd917f82016-08-31 08:22:29 +01001625 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001626 return transport, protocol
1627
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001628 async def subprocess_exec(self, protocol_factory, program, *args,
1629 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1630 stderr=subprocess.PIPE, universal_newlines=False,
sbstpf0d4c642019-05-27 19:51:19 -04001631 shell=False, bufsize=0,
1632 encoding=None, errors=None, text=None,
1633 **kwargs):
Victor Stinnere623a122014-01-29 14:35:15 -08001634 if universal_newlines:
1635 raise ValueError("universal_newlines must be False")
1636 if shell:
1637 raise ValueError("shell must be False")
1638 if bufsize != 0:
1639 raise ValueError("bufsize must be 0")
sbstpf0d4c642019-05-27 19:51:19 -04001640 if text:
1641 raise ValueError("text must be False")
1642 if encoding is not None:
1643 raise ValueError("encoding must be None")
1644 if errors is not None:
1645 raise ValueError("errors must be None")
1646
Victor Stinner20e07432014-02-11 11:44:56 +01001647 popen_args = (program,) + args
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001648 protocol = protocol_factory()
Yury Selivanov12f482e2018-06-08 18:24:37 -04001649 debug_log = None
Victor Stinneracdb7822014-07-14 18:33:40 +02001650 if self._debug:
1651 # don't log parameters: they may contain sensitive information
1652 # (password) and may be too long
Yury Selivanov6370f342017-12-10 18:36:12 -05001653 debug_log = f'execute program {program!r}'
Victor Stinneracdb7822014-07-14 18:33:40 +02001654 self._log_subprocess(debug_log, stdin, stdout, stderr)
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001655 transport = await self._make_subprocess_transport(
Yury Selivanov57797522014-02-18 22:56:15 -05001656 protocol, popen_args, False, stdin, stdout, stderr,
1657 bufsize, **kwargs)
Yury Selivanov12f482e2018-06-08 18:24:37 -04001658 if self._debug and debug_log is not None:
Vinay Sajipdd917f82016-08-31 08:22:29 +01001659 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001660 return transport, protocol
1661
Yury Selivanov7ed7ce62016-05-16 15:20:38 -04001662 def get_exception_handler(self):
1663 """Return an exception handler, or None if the default one is in use.
1664 """
1665 return self._exception_handler
1666
Yury Selivanov569efa22014-02-18 18:02:19 -05001667 def set_exception_handler(self, handler):
1668 """Set handler as the new event loop exception handler.
1669
1670 If handler is None, the default exception handler will
1671 be set.
1672
1673 If handler is a callable object, it should have a
Victor Stinneracdb7822014-07-14 18:33:40 +02001674 signature matching '(loop, context)', where 'loop'
Yury Selivanov569efa22014-02-18 18:02:19 -05001675 will be a reference to the active event loop, 'context'
1676 will be a dict object (see `call_exception_handler()`
1677 documentation for details about context).
1678 """
1679 if handler is not None and not callable(handler):
Yury Selivanov6370f342017-12-10 18:36:12 -05001680 raise TypeError(f'A callable object or None is expected, '
1681 f'got {handler!r}')
Yury Selivanov569efa22014-02-18 18:02:19 -05001682 self._exception_handler = handler
1683
1684 def default_exception_handler(self, context):
1685 """Default exception handler.
1686
1687 This is called when an exception occurs and no exception
1688 handler is set, and can be called by a custom exception
1689 handler that wants to defer to the default behavior.
1690
Antoine Pitrou921e9432017-11-07 17:23:29 +01001691 This default handler logs the error message and other
1692 context-dependent information. In debug mode, a truncated
1693 stack trace is also appended showing where the given object
1694 (e.g. a handle or future or task) was created, if any.
1695
Victor Stinneracdb7822014-07-14 18:33:40 +02001696 The context parameter has the same meaning as in
Yury Selivanov569efa22014-02-18 18:02:19 -05001697 `call_exception_handler()`.
1698 """
1699 message = context.get('message')
1700 if not message:
1701 message = 'Unhandled exception in event loop'
1702
1703 exception = context.get('exception')
1704 if exception is not None:
1705 exc_info = (type(exception), exception, exception.__traceback__)
1706 else:
1707 exc_info = False
1708
Yury Selivanov6370f342017-12-10 18:36:12 -05001709 if ('source_traceback' not in context and
1710 self._current_handle is not None and
1711 self._current_handle._source_traceback):
1712 context['handle_traceback'] = \
1713 self._current_handle._source_traceback
Victor Stinner9b524d52015-01-26 11:05:12 +01001714
Yury Selivanov569efa22014-02-18 18:02:19 -05001715 log_lines = [message]
1716 for key in sorted(context):
1717 if key in {'message', 'exception'}:
1718 continue
Victor Stinner80f53aa2014-06-27 13:52:20 +02001719 value = context[key]
1720 if key == 'source_traceback':
1721 tb = ''.join(traceback.format_list(value))
1722 value = 'Object created at (most recent call last):\n'
1723 value += tb.rstrip()
Victor Stinner9b524d52015-01-26 11:05:12 +01001724 elif key == 'handle_traceback':
1725 tb = ''.join(traceback.format_list(value))
1726 value = 'Handle created at (most recent call last):\n'
1727 value += tb.rstrip()
Victor Stinner80f53aa2014-06-27 13:52:20 +02001728 else:
1729 value = repr(value)
Yury Selivanov6370f342017-12-10 18:36:12 -05001730 log_lines.append(f'{key}: {value}')
Yury Selivanov569efa22014-02-18 18:02:19 -05001731
1732 logger.error('\n'.join(log_lines), exc_info=exc_info)
1733
1734 def call_exception_handler(self, context):
Victor Stinneracdb7822014-07-14 18:33:40 +02001735 """Call the current event loop's exception handler.
Yury Selivanov569efa22014-02-18 18:02:19 -05001736
Victor Stinneracdb7822014-07-14 18:33:40 +02001737 The context argument is a dict containing the following keys:
1738
Yury Selivanov569efa22014-02-18 18:02:19 -05001739 - 'message': Error message;
1740 - 'exception' (optional): Exception object;
1741 - 'future' (optional): Future instance;
Yury Selivanova4afcdf2018-01-21 14:56:59 -05001742 - 'task' (optional): Task instance;
Yury Selivanov569efa22014-02-18 18:02:19 -05001743 - 'handle' (optional): Handle instance;
1744 - 'protocol' (optional): Protocol instance;
1745 - 'transport' (optional): Transport instance;
Yury Selivanoveb636452016-09-08 22:01:51 -07001746 - 'socket' (optional): Socket instance;
1747 - 'asyncgen' (optional): Asynchronous generator that caused
1748 the exception.
Yury Selivanov569efa22014-02-18 18:02:19 -05001749
Victor Stinneracdb7822014-07-14 18:33:40 +02001750 New keys maybe introduced in the future.
1751
1752 Note: do not overload this method in an event loop subclass.
1753 For custom exception handling, use the
Yury Selivanov569efa22014-02-18 18:02:19 -05001754 `set_exception_handler()` method.
1755 """
1756 if self._exception_handler is None:
1757 try:
1758 self.default_exception_handler(context)
Yury Selivanov431b5402019-05-27 14:45:12 +02001759 except (SystemExit, KeyboardInterrupt):
1760 raise
1761 except BaseException:
Yury Selivanov569efa22014-02-18 18:02:19 -05001762 # Second protection layer for unexpected errors
1763 # in the default implementation, as well as for subclassed
1764 # event loops with overloaded "default_exception_handler".
1765 logger.error('Exception in default exception handler',
1766 exc_info=True)
1767 else:
1768 try:
1769 self._exception_handler(self, context)
Yury Selivanov431b5402019-05-27 14:45:12 +02001770 except (SystemExit, KeyboardInterrupt):
1771 raise
1772 except BaseException as exc:
Yury Selivanov569efa22014-02-18 18:02:19 -05001773 # Exception in the user set custom exception handler.
1774 try:
1775 # Let's try default handler.
1776 self.default_exception_handler({
1777 'message': 'Unhandled error in exception handler',
1778 'exception': exc,
1779 'context': context,
1780 })
Yury Selivanov431b5402019-05-27 14:45:12 +02001781 except (SystemExit, KeyboardInterrupt):
1782 raise
1783 except BaseException:
Victor Stinneracdb7822014-07-14 18:33:40 +02001784 # Guard 'default_exception_handler' in case it is
Yury Selivanov569efa22014-02-18 18:02:19 -05001785 # overloaded.
1786 logger.error('Exception in default exception handler '
1787 'while handling an unexpected error '
1788 'in custom exception handler',
1789 exc_info=True)
1790
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001791 def _add_callback(self, handle):
Victor Stinneracdb7822014-07-14 18:33:40 +02001792 """Add a Handle to _scheduled (TimerHandle) or _ready."""
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001793 assert isinstance(handle, events.Handle), 'A Handle is required here'
1794 if handle._cancelled:
1795 return
Yury Selivanov592ada92014-09-25 12:07:56 -04001796 assert not isinstance(handle, events.TimerHandle)
1797 self._ready.append(handle)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001798
1799 def _add_callback_signalsafe(self, handle):
1800 """Like _add_callback() but called from a signal handler."""
1801 self._add_callback(handle)
1802 self._write_to_self()
1803
Yury Selivanov592ada92014-09-25 12:07:56 -04001804 def _timer_handle_cancelled(self, handle):
1805 """Notification that a TimerHandle has been cancelled."""
1806 if handle._scheduled:
1807 self._timer_cancelled_count += 1
1808
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001809 def _run_once(self):
1810 """Run one full iteration of the event loop.
1811
1812 This calls all currently ready callbacks, polls for I/O,
1813 schedules the resulting callbacks, and finally schedules
1814 'call_later' callbacks.
1815 """
Yury Selivanov592ada92014-09-25 12:07:56 -04001816
Yury Selivanov592ada92014-09-25 12:07:56 -04001817 sched_count = len(self._scheduled)
1818 if (sched_count > _MIN_SCHEDULED_TIMER_HANDLES and
1819 self._timer_cancelled_count / sched_count >
1820 _MIN_CANCELLED_TIMER_HANDLES_FRACTION):
Victor Stinner68da8fc2014-09-30 18:08:36 +02001821 # Remove delayed calls that were cancelled if their number
1822 # is too high
1823 new_scheduled = []
Yury Selivanov592ada92014-09-25 12:07:56 -04001824 for handle in self._scheduled:
1825 if handle._cancelled:
1826 handle._scheduled = False
Victor Stinner68da8fc2014-09-30 18:08:36 +02001827 else:
1828 new_scheduled.append(handle)
Yury Selivanov592ada92014-09-25 12:07:56 -04001829
Victor Stinner68da8fc2014-09-30 18:08:36 +02001830 heapq.heapify(new_scheduled)
1831 self._scheduled = new_scheduled
Yury Selivanov592ada92014-09-25 12:07:56 -04001832 self._timer_cancelled_count = 0
Yury Selivanov592ada92014-09-25 12:07:56 -04001833 else:
1834 # Remove delayed calls that were cancelled from head of queue.
1835 while self._scheduled and self._scheduled[0]._cancelled:
1836 self._timer_cancelled_count -= 1
1837 handle = heapq.heappop(self._scheduled)
1838 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001839
1840 timeout = None
Guido van Rossum41f69f42015-11-19 13:28:47 -08001841 if self._ready or self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001842 timeout = 0
1843 elif self._scheduled:
1844 # Compute the desired timeout.
1845 when = self._scheduled[0]._when
MartinAltmayer944451c2018-07-31 15:06:12 +01001846 timeout = min(max(0, when - self.time()), MAXIMUM_SELECT_TIMEOUT)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001847
Andrew Svetlovd5bd0362018-09-30 08:28:40 +03001848 event_list = self._selector.select(timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001849 self._process_events(event_list)
1850
1851 # Handle 'later' callbacks that are ready.
Victor Stinnered1654f2014-02-10 23:42:32 +01001852 end_time = self.time() + self._clock_resolution
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001853 while self._scheduled:
1854 handle = self._scheduled[0]
Victor Stinnered1654f2014-02-10 23:42:32 +01001855 if handle._when >= end_time:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001856 break
1857 handle = heapq.heappop(self._scheduled)
Yury Selivanov592ada92014-09-25 12:07:56 -04001858 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001859 self._ready.append(handle)
1860
1861 # This is the only place where callbacks are actually *called*.
1862 # All other places just add them to ready.
1863 # Note: We run all currently scheduled callbacks, but not any
1864 # callbacks scheduled by callbacks run this time around --
1865 # they will be run the next time (after another I/O poll).
Victor Stinneracdb7822014-07-14 18:33:40 +02001866 # Use an idiom that is thread-safe without using locks.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001867 ntodo = len(self._ready)
1868 for i in range(ntodo):
1869 handle = self._ready.popleft()
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001870 if handle._cancelled:
1871 continue
1872 if self._debug:
Victor Stinner9b524d52015-01-26 11:05:12 +01001873 try:
1874 self._current_handle = handle
1875 t0 = self.time()
1876 handle._run()
1877 dt = self.time() - t0
1878 if dt >= self.slow_callback_duration:
1879 logger.warning('Executing %s took %.3f seconds',
1880 _format_handle(handle), dt)
1881 finally:
1882 self._current_handle = None
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001883 else:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001884 handle._run()
1885 handle = None # Needed to break cycles when an exception occurs.
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001886
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001887 def _set_coroutine_origin_tracking(self, enabled):
1888 if bool(enabled) == bool(self._coroutine_origin_tracking_enabled):
Yury Selivanove8944cb2015-05-12 11:43:04 -04001889 return
1890
Yury Selivanove8944cb2015-05-12 11:43:04 -04001891 if enabled:
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001892 self._coroutine_origin_tracking_saved_depth = (
1893 sys.get_coroutine_origin_tracking_depth())
1894 sys.set_coroutine_origin_tracking_depth(
1895 constants.DEBUG_STACK_DEPTH)
Yury Selivanove8944cb2015-05-12 11:43:04 -04001896 else:
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001897 sys.set_coroutine_origin_tracking_depth(
1898 self._coroutine_origin_tracking_saved_depth)
1899
1900 self._coroutine_origin_tracking_enabled = enabled
Yury Selivanove8944cb2015-05-12 11:43:04 -04001901
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001902 def get_debug(self):
1903 return self._debug
1904
1905 def set_debug(self, enabled):
1906 self._debug = enabled
Yury Selivanov1af2bf72015-05-11 22:27:25 -04001907
Yury Selivanove8944cb2015-05-12 11:43:04 -04001908 if self.is_running():
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001909 self.call_soon_threadsafe(self._set_coroutine_origin_tracking, enabled)