blob: a0243f5bac9a2c37945ef1ab25bf5cefa6f8ebf1 [file] [log] [blame]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001"""Base implementation of event loop.
2
3The event loop can be broken up into a multiplexer (the part
Victor Stinneracdb7822014-07-14 18:33:40 +02004responsible for notifying us of I/O events) and the event loop proper,
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07005which wraps a multiplexer with functionality for scheduling callbacks,
6immediately or at a given time in the future.
7
8Whenever a public API takes a callback, subsequent positional
9arguments will be passed to the callback if/when it is called. This
10avoids the proliferation of trivial lambdas implementing closures.
11Keyword arguments for the callback are not supported; this is a
12conscious design decision, leaving the door open for keyword arguments
13to modify the meaning of the API call itself.
14"""
15
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070016import collections
Serhiy Storchaka2e576f52017-04-24 09:05:00 +030017import collections.abc
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070018import concurrent.futures
19import heapq
Victor Stinner5e4a7d82015-09-21 18:33:43 +020020import itertools
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070021import logging
Victor Stinnerb75380f2014-06-30 14:39:11 +020022import os
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070023import socket
24import subprocess
Victor Stinner956de692014-12-26 21:07:52 +010025import threading
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070026import time
Victor Stinnerb75380f2014-06-30 14:39:11 +020027import traceback
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070028import sys
Victor Stinner978a9af2015-01-29 17:50:58 +010029import warnings
Yury Selivanoveb636452016-09-08 22:01:51 -070030import weakref
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070031
Yury Selivanovf111b3d2017-12-30 00:35:36 -050032try:
33 import ssl
34except ImportError: # pragma: no cover
35 ssl = None
36
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -080037from . import constants
Victor Stinnerf951d282014-06-29 00:46:45 +020038from . import coroutines
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070039from . import events
40from . import futures
Andrew Svetlov7c684072018-01-27 21:22:47 +020041from . import protocols
Yury Selivanovf111b3d2017-12-30 00:35:36 -050042from . import sslproto
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070043from . import tasks
Andrew Svetlov7c684072018-01-27 21:22:47 +020044from . import transports
Guido van Rossumfc29e0f2013-10-17 15:39:45 -070045from .log import logger
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070046
47
Yury Selivanov6370f342017-12-10 18:36:12 -050048__all__ = 'BaseEventLoop',
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070049
50
Yury Selivanov592ada92014-09-25 12:07:56 -040051# Minimum number of _scheduled timer handles before cleanup of
52# cancelled handles is performed.
53_MIN_SCHEDULED_TIMER_HANDLES = 100
54
55# Minimum fraction of _scheduled timer handles that are cancelled
56# before cleanup of cancelled handles is performed.
57_MIN_CANCELLED_TIMER_HANDLES_FRACTION = 0.5
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070058
Victor Stinnerc94a93a2016-04-01 21:43:39 +020059# Exceptions which must not call the exception handler in fatal error
60# methods (_fatal_error())
61_FATAL_ERROR_IGNORE = (BrokenPipeError,
62 ConnectionResetError, ConnectionAbortedError)
63
64
Victor Stinner0e6f52a2014-06-20 17:34:15 +020065def _format_handle(handle):
66 cb = handle._callback
Yury Selivanova0c1ba62016-10-28 12:52:37 -040067 if isinstance(getattr(cb, '__self__', None), tasks.Task):
Victor Stinner0e6f52a2014-06-20 17:34:15 +020068 # format the task
69 return repr(cb.__self__)
70 else:
71 return str(handle)
72
73
Victor Stinneracdb7822014-07-14 18:33:40 +020074def _format_pipe(fd):
75 if fd == subprocess.PIPE:
76 return '<pipe>'
77 elif fd == subprocess.STDOUT:
78 return '<stdout>'
79 else:
80 return repr(fd)
81
82
Yury Selivanov5587d7c2016-09-15 15:45:07 -040083def _set_reuseport(sock):
84 if not hasattr(socket, 'SO_REUSEPORT'):
85 raise ValueError('reuse_port not supported by socket module')
86 else:
87 try:
88 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
89 except OSError:
90 raise ValueError('reuse_port not supported by socket module, '
91 'SO_REUSEPORT defined but not implemented.')
92
93
Yury Selivanovd5c2a622015-12-16 19:31:17 -050094def _ipaddr_info(host, port, family, type, proto):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -040095 # Try to skip getaddrinfo if "host" is already an IP. Users might have
96 # handled name resolution in their own code and pass in resolved IPs.
97 if not hasattr(socket, 'inet_pton'):
98 return
99
100 if proto not in {0, socket.IPPROTO_TCP, socket.IPPROTO_UDP} or \
101 host is None:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500102 return None
103
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500104 if type == socket.SOCK_STREAM:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500105 proto = socket.IPPROTO_TCP
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500106 elif type == socket.SOCK_DGRAM:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500107 proto = socket.IPPROTO_UDP
108 else:
109 return None
110
Yury Selivanova7146162016-06-02 16:51:07 -0400111 if port is None:
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400112 port = 0
Guido van Rossume3c65a72016-09-30 08:17:15 -0700113 elif isinstance(port, bytes) and port == b'':
114 port = 0
115 elif isinstance(port, str) and port == '':
116 port = 0
117 else:
118 # If port's a service name like "http", don't skip getaddrinfo.
119 try:
120 port = int(port)
121 except (TypeError, ValueError):
122 return None
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400123
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400124 if family == socket.AF_UNSPEC:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500125 afs = [socket.AF_INET]
126 if hasattr(socket, 'AF_INET6'):
127 afs.append(socket.AF_INET6)
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400128 else:
129 afs = [family]
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500130
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400131 if isinstance(host, bytes):
132 host = host.decode('idna')
133 if '%' in host:
134 # Linux's inet_pton doesn't accept an IPv6 zone index after host,
135 # like '::1%lo0'.
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500136 return None
137
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400138 for af in afs:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500139 try:
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400140 socket.inet_pton(af, host)
141 # The host has already been resolved.
142 return af, type, proto, '', (host, port)
143 except OSError:
144 pass
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500145
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400146 # "host" is not an IP address.
147 return None
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500148
149
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100150def _run_until_complete_cb(fut):
Yury Selivanov36c2c042017-12-19 07:19:53 -0500151 if not fut.cancelled():
152 exc = fut.exception()
153 if isinstance(exc, BaseException) and not isinstance(exc, Exception):
154 # Issue #22429: run_forever() already finished, no need to
155 # stop it.
156 return
Yury Selivanovca9b36c2017-12-23 15:04:15 -0500157 futures._get_loop(fut).stop()
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100158
159
Andrew Svetlov7c684072018-01-27 21:22:47 +0200160class _SendfileFallbackProtocol(protocols.Protocol):
161 def __init__(self, transp):
162 if not isinstance(transp, transports._FlowControlMixin):
163 raise TypeError("transport should be _FlowControlMixin instance")
164 self._transport = transp
165 self._proto = transp.get_protocol()
166 self._should_resume_reading = transp.is_reading()
167 self._should_resume_writing = transp._protocol_paused
168 transp.pause_reading()
169 transp.set_protocol(self)
170 if self._should_resume_writing:
171 self._write_ready_fut = self._transport._loop.create_future()
172 else:
173 self._write_ready_fut = None
174
175 async def drain(self):
176 if self._transport.is_closing():
177 raise ConnectionError("Connection closed by peer")
178 fut = self._write_ready_fut
179 if fut is None:
180 return
181 await fut
182
183 def connection_made(self, transport):
184 raise RuntimeError("Invalid state: "
185 "connection should have been established already.")
186
187 def connection_lost(self, exc):
188 if self._write_ready_fut is not None:
189 # Never happens if peer disconnects after sending the whole content
190 # Thus disconnection is always an exception from user perspective
191 if exc is None:
192 self._write_ready_fut.set_exception(
193 ConnectionError("Connection is closed by peer"))
194 else:
195 self._write_ready_fut.set_exception(exc)
196 self._proto.connection_lost(exc)
197
198 def pause_writing(self):
199 if self._write_ready_fut is not None:
200 return
201 self._write_ready_fut = self._transport._loop.create_future()
202
203 def resume_writing(self):
204 if self._write_ready_fut is None:
205 return
206 self._write_ready_fut.set_result(False)
207 self._write_ready_fut = None
208
209 def data_received(self, data):
210 raise RuntimeError("Invalid state: reading should be paused")
211
212 def eof_received(self):
213 raise RuntimeError("Invalid state: reading should be paused")
214
215 async def restore(self):
216 self._transport.set_protocol(self._proto)
217 if self._should_resume_reading:
218 self._transport.resume_reading()
219 if self._write_ready_fut is not None:
220 # Cancel the future.
221 # Basically it has no effect because protocol is switched back,
222 # no code should wait for it anymore.
223 self._write_ready_fut.cancel()
224 if self._should_resume_writing:
225 self._proto.resume_writing()
226
227
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700228class Server(events.AbstractServer):
229
Yury Selivanovc9070d02018-01-25 18:08:09 -0500230 def __init__(self, loop, sockets, protocol_factory, ssl_context, backlog,
231 ssl_handshake_timeout):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200232 self._loop = loop
Yury Selivanovc9070d02018-01-25 18:08:09 -0500233 self._sockets = sockets
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200234 self._active_count = 0
235 self._waiters = []
Yury Selivanovc9070d02018-01-25 18:08:09 -0500236 self._protocol_factory = protocol_factory
237 self._backlog = backlog
238 self._ssl_context = ssl_context
239 self._ssl_handshake_timeout = ssl_handshake_timeout
240 self._serving = False
241 self._serving_forever_fut = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700242
Victor Stinnere912e652014-07-12 03:11:53 +0200243 def __repr__(self):
Yury Selivanov6370f342017-12-10 18:36:12 -0500244 return f'<{self.__class__.__name__} sockets={self.sockets!r}>'
Victor Stinnere912e652014-07-12 03:11:53 +0200245
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200246 def _attach(self):
Yury Selivanovc9070d02018-01-25 18:08:09 -0500247 assert self._sockets is not None
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200248 self._active_count += 1
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700249
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200250 def _detach(self):
251 assert self._active_count > 0
252 self._active_count -= 1
Yury Selivanovc9070d02018-01-25 18:08:09 -0500253 if self._active_count == 0 and self._sockets is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700254 self._wakeup()
255
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700256 def _wakeup(self):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200257 waiters = self._waiters
258 self._waiters = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700259 for waiter in waiters:
260 if not waiter.done():
261 waiter.set_result(waiter)
262
Yury Selivanovc9070d02018-01-25 18:08:09 -0500263 def _start_serving(self):
264 if self._serving:
265 return
266 self._serving = True
267 for sock in self._sockets:
268 sock.listen(self._backlog)
269 self._loop._start_serving(
270 self._protocol_factory, sock, self._ssl_context,
271 self, self._backlog, self._ssl_handshake_timeout)
272
273 def get_loop(self):
274 return self._loop
275
276 def is_serving(self):
277 return self._serving
278
279 @property
280 def sockets(self):
281 if self._sockets is None:
282 return []
283 return list(self._sockets)
284
285 def close(self):
286 sockets = self._sockets
287 if sockets is None:
288 return
289 self._sockets = None
290
291 for sock in sockets:
292 self._loop._stop_serving(sock)
293
294 self._serving = False
295
296 if (self._serving_forever_fut is not None and
297 not self._serving_forever_fut.done()):
298 self._serving_forever_fut.cancel()
299 self._serving_forever_fut = None
300
301 if self._active_count == 0:
302 self._wakeup()
303
304 async def start_serving(self):
305 self._start_serving()
Miss Islington (bot)bc3a0022018-05-28 11:50:45 -0700306 # Skip one loop iteration so that all 'loop.add_reader'
307 # go through.
308 await tasks.sleep(0, loop=self._loop)
Yury Selivanovc9070d02018-01-25 18:08:09 -0500309
310 async def serve_forever(self):
311 if self._serving_forever_fut is not None:
312 raise RuntimeError(
313 f'server {self!r} is already being awaited on serve_forever()')
314 if self._sockets is None:
315 raise RuntimeError(f'server {self!r} is closed')
316
317 self._start_serving()
318 self._serving_forever_fut = self._loop.create_future()
319
320 try:
321 await self._serving_forever_fut
322 except futures.CancelledError:
323 try:
324 self.close()
325 await self.wait_closed()
326 finally:
327 raise
328 finally:
329 self._serving_forever_fut = None
330
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200331 async def wait_closed(self):
Yury Selivanovc9070d02018-01-25 18:08:09 -0500332 if self._sockets is None or self._waiters is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700333 return
Yury Selivanov7661db62016-05-16 15:38:39 -0400334 waiter = self._loop.create_future()
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200335 self._waiters.append(waiter)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200336 await waiter
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700337
338
339class BaseEventLoop(events.AbstractEventLoop):
340
341 def __init__(self):
Yury Selivanov592ada92014-09-25 12:07:56 -0400342 self._timer_cancelled_count = 0
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200343 self._closed = False
Guido van Rossum41f69f42015-11-19 13:28:47 -0800344 self._stopping = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700345 self._ready = collections.deque()
346 self._scheduled = []
347 self._default_executor = None
348 self._internal_fds = 0
Victor Stinner956de692014-12-26 21:07:52 +0100349 # Identifier of the thread running the event loop, or None if the
350 # event loop is not running
Victor Stinnera87501f2015-02-05 11:45:33 +0100351 self._thread_id = None
Victor Stinnered1654f2014-02-10 23:42:32 +0100352 self._clock_resolution = time.get_clock_info('monotonic').resolution
Yury Selivanov569efa22014-02-18 18:02:19 -0500353 self._exception_handler = None
Victor Stinner44862df2017-11-20 07:14:07 -0800354 self.set_debug(coroutines._is_debug_mode())
Victor Stinner0e6f52a2014-06-20 17:34:15 +0200355 # In debug mode, if the execution of a callback or a step of a task
356 # exceed this duration in seconds, the slow callback/task is logged.
357 self.slow_callback_duration = 0.1
Victor Stinner9b524d52015-01-26 11:05:12 +0100358 self._current_handle = None
Yury Selivanov740169c2015-05-11 14:23:38 -0400359 self._task_factory = None
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800360 self._coroutine_origin_tracking_enabled = False
361 self._coroutine_origin_tracking_saved_depth = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700362
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500363 # A weak set of all asynchronous generators that are
364 # being iterated by the loop.
365 self._asyncgens = weakref.WeakSet()
Yury Selivanoveb636452016-09-08 22:01:51 -0700366 # Set to True when `loop.shutdown_asyncgens` is called.
367 self._asyncgens_shutdown_called = False
368
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200369 def __repr__(self):
Yury Selivanov6370f342017-12-10 18:36:12 -0500370 return (
371 f'<{self.__class__.__name__} running={self.is_running()} '
372 f'closed={self.is_closed()} debug={self.get_debug()}>'
373 )
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200374
Yury Selivanov7661db62016-05-16 15:38:39 -0400375 def create_future(self):
376 """Create a Future object attached to the loop."""
377 return futures.Future(loop=self)
378
Victor Stinner896a25a2014-07-08 11:29:25 +0200379 def create_task(self, coro):
380 """Schedule a coroutine object.
381
Victor Stinneracdb7822014-07-14 18:33:40 +0200382 Return a task object.
383 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100384 self._check_closed()
Yury Selivanov740169c2015-05-11 14:23:38 -0400385 if self._task_factory is None:
386 task = tasks.Task(coro, loop=self)
387 if task._source_traceback:
388 del task._source_traceback[-1]
389 else:
390 task = self._task_factory(self, coro)
Victor Stinnerc39ba7d2014-07-11 00:21:27 +0200391 return task
Victor Stinner896a25a2014-07-08 11:29:25 +0200392
Yury Selivanov740169c2015-05-11 14:23:38 -0400393 def set_task_factory(self, factory):
394 """Set a task factory that will be used by loop.create_task().
395
396 If factory is None the default task factory will be set.
397
398 If factory is a callable, it should have a signature matching
399 '(loop, coro)', where 'loop' will be a reference to the active
400 event loop, 'coro' will be a coroutine object. The callable
401 must return a Future.
402 """
403 if factory is not None and not callable(factory):
404 raise TypeError('task factory must be a callable or None')
405 self._task_factory = factory
406
407 def get_task_factory(self):
408 """Return a task factory, or None if the default one is in use."""
409 return self._task_factory
410
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700411 def _make_socket_transport(self, sock, protocol, waiter=None, *,
412 extra=None, server=None):
413 """Create socket transport."""
414 raise NotImplementedError
415
Neil Aspinallf7686c12017-12-19 19:45:42 +0000416 def _make_ssl_transport(
417 self, rawsock, protocol, sslcontext, waiter=None,
418 *, server_side=False, server_hostname=None,
419 extra=None, server=None,
Yury Selivanovf111b3d2017-12-30 00:35:36 -0500420 ssl_handshake_timeout=None,
421 call_connection_made=True):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700422 """Create SSL transport."""
423 raise NotImplementedError
424
425 def _make_datagram_transport(self, sock, protocol,
Victor Stinnerbfff45d2014-07-08 23:57:31 +0200426 address=None, waiter=None, extra=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700427 """Create datagram transport."""
428 raise NotImplementedError
429
430 def _make_read_pipe_transport(self, pipe, protocol, waiter=None,
431 extra=None):
432 """Create read pipe transport."""
433 raise NotImplementedError
434
435 def _make_write_pipe_transport(self, pipe, protocol, waiter=None,
436 extra=None):
437 """Create write pipe transport."""
438 raise NotImplementedError
439
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200440 async def _make_subprocess_transport(self, protocol, args, shell,
441 stdin, stdout, stderr, bufsize,
442 extra=None, **kwargs):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700443 """Create subprocess transport."""
444 raise NotImplementedError
445
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700446 def _write_to_self(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200447 """Write a byte to self-pipe, to wake up the event loop.
448
449 This may be called from a different thread.
450
451 The subclass is responsible for implementing the self-pipe.
452 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700453 raise NotImplementedError
454
455 def _process_events(self, event_list):
456 """Process selector events."""
457 raise NotImplementedError
458
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200459 def _check_closed(self):
460 if self._closed:
461 raise RuntimeError('Event loop is closed')
462
Yury Selivanoveb636452016-09-08 22:01:51 -0700463 def _asyncgen_finalizer_hook(self, agen):
464 self._asyncgens.discard(agen)
465 if not self.is_closed():
466 self.create_task(agen.aclose())
Yury Selivanoved054062016-10-21 17:13:40 -0400467 # Wake up the loop if the finalizer was called from
468 # a different thread.
469 self._write_to_self()
Yury Selivanoveb636452016-09-08 22:01:51 -0700470
471 def _asyncgen_firstiter_hook(self, agen):
472 if self._asyncgens_shutdown_called:
473 warnings.warn(
Yury Selivanov6370f342017-12-10 18:36:12 -0500474 f"asynchronous generator {agen!r} was scheduled after "
475 f"loop.shutdown_asyncgens() call",
Yury Selivanoveb636452016-09-08 22:01:51 -0700476 ResourceWarning, source=self)
477
478 self._asyncgens.add(agen)
479
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200480 async def shutdown_asyncgens(self):
Yury Selivanoveb636452016-09-08 22:01:51 -0700481 """Shutdown all active asynchronous generators."""
482 self._asyncgens_shutdown_called = True
483
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500484 if not len(self._asyncgens):
Yury Selivanov0a91d482016-09-15 13:24:03 -0400485 # If Python version is <3.6 or we don't have any asynchronous
486 # generators alive.
Yury Selivanoveb636452016-09-08 22:01:51 -0700487 return
488
489 closing_agens = list(self._asyncgens)
490 self._asyncgens.clear()
491
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200492 results = await tasks.gather(
Yury Selivanoveb636452016-09-08 22:01:51 -0700493 *[ag.aclose() for ag in closing_agens],
494 return_exceptions=True,
495 loop=self)
496
Yury Selivanoveb636452016-09-08 22:01:51 -0700497 for result, agen in zip(results, closing_agens):
498 if isinstance(result, Exception):
499 self.call_exception_handler({
Yury Selivanov6370f342017-12-10 18:36:12 -0500500 'message': f'an error occurred during closing of '
501 f'asynchronous generator {agen!r}',
Yury Selivanoveb636452016-09-08 22:01:51 -0700502 'exception': result,
503 'asyncgen': agen
504 })
505
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700506 def run_forever(self):
507 """Run until stop() is called."""
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200508 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100509 if self.is_running():
Yury Selivanov600a3492016-11-04 14:29:28 -0400510 raise RuntimeError('This event loop is already running')
511 if events._get_running_loop() is not None:
512 raise RuntimeError(
513 'Cannot run the event loop while another loop is running')
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800514 self._set_coroutine_origin_tracking(self._debug)
Victor Stinnera87501f2015-02-05 11:45:33 +0100515 self._thread_id = threading.get_ident()
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500516
517 old_agen_hooks = sys.get_asyncgen_hooks()
518 sys.set_asyncgen_hooks(firstiter=self._asyncgen_firstiter_hook,
519 finalizer=self._asyncgen_finalizer_hook)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700520 try:
Yury Selivanov600a3492016-11-04 14:29:28 -0400521 events._set_running_loop(self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700522 while True:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800523 self._run_once()
524 if self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700525 break
526 finally:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800527 self._stopping = False
Victor Stinnera87501f2015-02-05 11:45:33 +0100528 self._thread_id = None
Yury Selivanov600a3492016-11-04 14:29:28 -0400529 events._set_running_loop(None)
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -0800530 self._set_coroutine_origin_tracking(False)
Yury Selivanova4afcdf2018-01-21 14:56:59 -0500531 sys.set_asyncgen_hooks(*old_agen_hooks)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700532
533 def run_until_complete(self, future):
534 """Run until the Future is done.
535
536 If the argument is a coroutine, it is wrapped in a Task.
537
Victor Stinneracdb7822014-07-14 18:33:40 +0200538 WARNING: It would be disastrous to call run_until_complete()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700539 with the same coroutine twice -- it would wrap it in two
540 different Tasks and that can't be good.
541
542 Return the Future's result, or raise its exception.
543 """
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200544 self._check_closed()
Victor Stinner98b63912014-06-30 14:51:04 +0200545
Guido van Rossum7b3b3dc2016-09-09 14:26:31 -0700546 new_task = not futures.isfuture(future)
Yury Selivanov59eb9a42015-05-11 14:48:38 -0400547 future = tasks.ensure_future(future, loop=self)
Victor Stinner98b63912014-06-30 14:51:04 +0200548 if new_task:
549 # An exception is raised if the future didn't complete, so there
550 # is no need to log the "destroy pending task" message
551 future._log_destroy_pending = False
552
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100553 future.add_done_callback(_run_until_complete_cb)
Victor Stinnerc8bd53f2014-10-11 14:30:18 +0200554 try:
555 self.run_forever()
556 except:
557 if new_task and future.done() and not future.cancelled():
558 # The coroutine raised a BaseException. Consume the exception
559 # to not log a warning, the caller doesn't have access to the
560 # local task.
561 future.exception()
562 raise
jimmylai21b3e042017-05-22 22:32:46 -0700563 finally:
564 future.remove_done_callback(_run_until_complete_cb)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700565 if not future.done():
566 raise RuntimeError('Event loop stopped before Future completed.')
567
568 return future.result()
569
570 def stop(self):
571 """Stop running the event loop.
572
Guido van Rossum41f69f42015-11-19 13:28:47 -0800573 Every callback already scheduled will still run. This simply informs
574 run_forever to stop looping after a complete iteration.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700575 """
Guido van Rossum41f69f42015-11-19 13:28:47 -0800576 self._stopping = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700577
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200578 def close(self):
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700579 """Close the event loop.
580
581 This clears the queues and shuts down the executor,
582 but does not wait for the executor to finish.
Victor Stinnerf328c7d2014-06-23 01:02:37 +0200583
584 The event loop must not be running.
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700585 """
Victor Stinner956de692014-12-26 21:07:52 +0100586 if self.is_running():
Victor Stinneracdb7822014-07-14 18:33:40 +0200587 raise RuntimeError("Cannot close a running event loop")
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200588 if self._closed:
589 return
Victor Stinnere912e652014-07-12 03:11:53 +0200590 if self._debug:
591 logger.debug("Close %r", self)
Yury Selivanove8944cb2015-05-12 11:43:04 -0400592 self._closed = True
593 self._ready.clear()
594 self._scheduled.clear()
595 executor = self._default_executor
596 if executor is not None:
597 self._default_executor = None
598 executor.shutdown(wait=False)
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200599
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200600 def is_closed(self):
601 """Returns True if the event loop was closed."""
602 return self._closed
603
INADA Naoki3e2ad8e2017-04-25 10:57:18 +0900604 def __del__(self):
605 if not self.is_closed():
Yury Selivanov6370f342017-12-10 18:36:12 -0500606 warnings.warn(f"unclosed event loop {self!r}", ResourceWarning,
INADA Naoki3e2ad8e2017-04-25 10:57:18 +0900607 source=self)
608 if not self.is_running():
609 self.close()
Victor Stinner978a9af2015-01-29 17:50:58 +0100610
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700611 def is_running(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200612 """Returns True if the event loop is running."""
Victor Stinnera87501f2015-02-05 11:45:33 +0100613 return (self._thread_id is not None)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700614
615 def time(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200616 """Return the time according to the event loop's clock.
617
618 This is a float expressed in seconds since an epoch, but the
619 epoch, precision, accuracy and drift are unspecified and may
620 differ per event loop.
621 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700622 return time.monotonic()
623
Yury Selivanovf23746a2018-01-22 19:11:18 -0500624 def call_later(self, delay, callback, *args, context=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700625 """Arrange for a callback to be called at a given time.
626
627 Return a Handle: an opaque object with a cancel() method that
628 can be used to cancel the call.
629
630 The delay can be an int or float, expressed in seconds. It is
Victor Stinneracdb7822014-07-14 18:33:40 +0200631 always relative to the current time.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700632
633 Each callback will be called exactly once. If two callbacks
634 are scheduled for exactly the same time, it undefined which
635 will be called first.
636
637 Any positional arguments after the callback will be passed to
638 the callback when it is called.
639 """
Yury Selivanovf23746a2018-01-22 19:11:18 -0500640 timer = self.call_at(self.time() + delay, callback, *args,
641 context=context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200642 if timer._source_traceback:
643 del timer._source_traceback[-1]
644 return timer
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700645
Yury Selivanovf23746a2018-01-22 19:11:18 -0500646 def call_at(self, when, callback, *args, context=None):
Victor Stinneracdb7822014-07-14 18:33:40 +0200647 """Like call_later(), but uses an absolute time.
648
649 Absolute time corresponds to the event loop's time() method.
650 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100651 self._check_closed()
Victor Stinner93569c22014-03-21 10:00:52 +0100652 if self._debug:
Victor Stinner956de692014-12-26 21:07:52 +0100653 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700654 self._check_callback(callback, 'call_at')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500655 timer = events.TimerHandle(when, callback, args, self, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200656 if timer._source_traceback:
657 del timer._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700658 heapq.heappush(self._scheduled, timer)
Yury Selivanov592ada92014-09-25 12:07:56 -0400659 timer._scheduled = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700660 return timer
661
Yury Selivanovf23746a2018-01-22 19:11:18 -0500662 def call_soon(self, callback, *args, context=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700663 """Arrange for a callback to be called as soon as possible.
664
Victor Stinneracdb7822014-07-14 18:33:40 +0200665 This operates as a FIFO queue: callbacks are called in the
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700666 order in which they are registered. Each callback will be
667 called exactly once.
668
669 Any positional arguments after the callback will be passed to
670 the callback when it is called.
671 """
Yury Selivanov491a9122016-11-03 15:09:24 -0700672 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100673 if self._debug:
674 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700675 self._check_callback(callback, 'call_soon')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500676 handle = self._call_soon(callback, args, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200677 if handle._source_traceback:
678 del handle._source_traceback[-1]
679 return handle
Victor Stinner93569c22014-03-21 10:00:52 +0100680
Yury Selivanov491a9122016-11-03 15:09:24 -0700681 def _check_callback(self, callback, method):
682 if (coroutines.iscoroutine(callback) or
683 coroutines.iscoroutinefunction(callback)):
684 raise TypeError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500685 f"coroutines cannot be used with {method}()")
Yury Selivanov491a9122016-11-03 15:09:24 -0700686 if not callable(callback):
687 raise TypeError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500688 f'a callable object was expected by {method}(), '
689 f'got {callback!r}')
Yury Selivanov491a9122016-11-03 15:09:24 -0700690
Yury Selivanovf23746a2018-01-22 19:11:18 -0500691 def _call_soon(self, callback, args, context):
692 handle = events.Handle(callback, args, self, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200693 if handle._source_traceback:
694 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700695 self._ready.append(handle)
696 return handle
697
Victor Stinner956de692014-12-26 21:07:52 +0100698 def _check_thread(self):
699 """Check that the current thread is the thread running the event loop.
Victor Stinner93569c22014-03-21 10:00:52 +0100700
Victor Stinneracdb7822014-07-14 18:33:40 +0200701 Non-thread-safe methods of this class make this assumption and will
Victor Stinner93569c22014-03-21 10:00:52 +0100702 likely behave incorrectly when the assumption is violated.
703
Victor Stinneracdb7822014-07-14 18:33:40 +0200704 Should only be called when (self._debug == True). The caller is
Victor Stinner93569c22014-03-21 10:00:52 +0100705 responsible for checking this condition for performance reasons.
706 """
Victor Stinnera87501f2015-02-05 11:45:33 +0100707 if self._thread_id is None:
Victor Stinner751c7c02014-06-23 15:14:13 +0200708 return
Victor Stinner956de692014-12-26 21:07:52 +0100709 thread_id = threading.get_ident()
Victor Stinnera87501f2015-02-05 11:45:33 +0100710 if thread_id != self._thread_id:
Victor Stinner93569c22014-03-21 10:00:52 +0100711 raise RuntimeError(
Victor Stinneracdb7822014-07-14 18:33:40 +0200712 "Non-thread-safe operation invoked on an event loop other "
Victor Stinner93569c22014-03-21 10:00:52 +0100713 "than the current one")
714
Yury Selivanovf23746a2018-01-22 19:11:18 -0500715 def call_soon_threadsafe(self, callback, *args, context=None):
Victor Stinneracdb7822014-07-14 18:33:40 +0200716 """Like call_soon(), but thread-safe."""
Yury Selivanov491a9122016-11-03 15:09:24 -0700717 self._check_closed()
718 if self._debug:
719 self._check_callback(callback, 'call_soon_threadsafe')
Yury Selivanovf23746a2018-01-22 19:11:18 -0500720 handle = self._call_soon(callback, args, context)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200721 if handle._source_traceback:
722 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700723 self._write_to_self()
724 return handle
725
Yury Selivanovbec23722018-01-28 14:09:40 -0500726 def run_in_executor(self, executor, func, *args):
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100727 self._check_closed()
Yury Selivanov491a9122016-11-03 15:09:24 -0700728 if self._debug:
729 self._check_callback(func, 'run_in_executor')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700730 if executor is None:
731 executor = self._default_executor
732 if executor is None:
Yury Selivanove8a60452016-10-21 17:40:42 -0400733 executor = concurrent.futures.ThreadPoolExecutor()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700734 self._default_executor = executor
Yury Selivanovbec23722018-01-28 14:09:40 -0500735 return futures.wrap_future(
Yury Selivanov19a44f62017-12-14 20:53:26 -0500736 executor.submit(func, *args), loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700737
738 def set_default_executor(self, executor):
739 self._default_executor = executor
740
Victor Stinnere912e652014-07-12 03:11:53 +0200741 def _getaddrinfo_debug(self, host, port, family, type, proto, flags):
Yury Selivanov6370f342017-12-10 18:36:12 -0500742 msg = [f"{host}:{port!r}"]
Victor Stinnere912e652014-07-12 03:11:53 +0200743 if family:
Yury Selivanov19d0d542017-12-10 19:52:53 -0500744 msg.append(f'family={family!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200745 if type:
Yury Selivanov6370f342017-12-10 18:36:12 -0500746 msg.append(f'type={type!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200747 if proto:
Yury Selivanov6370f342017-12-10 18:36:12 -0500748 msg.append(f'proto={proto!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200749 if flags:
Yury Selivanov6370f342017-12-10 18:36:12 -0500750 msg.append(f'flags={flags!r}')
Victor Stinnere912e652014-07-12 03:11:53 +0200751 msg = ', '.join(msg)
Victor Stinneracdb7822014-07-14 18:33:40 +0200752 logger.debug('Get address info %s', msg)
Victor Stinnere912e652014-07-12 03:11:53 +0200753
754 t0 = self.time()
755 addrinfo = socket.getaddrinfo(host, port, family, type, proto, flags)
756 dt = self.time() - t0
757
Yury Selivanov6370f342017-12-10 18:36:12 -0500758 msg = f'Getting address info {msg} took {dt * 1e3:.3f}ms: {addrinfo!r}'
Victor Stinnere912e652014-07-12 03:11:53 +0200759 if dt >= self.slow_callback_duration:
760 logger.info(msg)
761 else:
762 logger.debug(msg)
763 return addrinfo
764
Yury Selivanov19a44f62017-12-14 20:53:26 -0500765 async def getaddrinfo(self, host, port, *,
766 family=0, type=0, proto=0, flags=0):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400767 if self._debug:
Yury Selivanov19a44f62017-12-14 20:53:26 -0500768 getaddr_func = self._getaddrinfo_debug
Victor Stinnere912e652014-07-12 03:11:53 +0200769 else:
Yury Selivanov19a44f62017-12-14 20:53:26 -0500770 getaddr_func = socket.getaddrinfo
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700771
Yury Selivanov19a44f62017-12-14 20:53:26 -0500772 return await self.run_in_executor(
773 None, getaddr_func, host, port, family, type, proto, flags)
774
775 async def getnameinfo(self, sockaddr, flags=0):
776 return await self.run_in_executor(
777 None, socket.getnameinfo, sockaddr, flags)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700778
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200779 async def sock_sendfile(self, sock, file, offset=0, count=None,
780 *, fallback=True):
781 if self._debug and sock.gettimeout() != 0:
782 raise ValueError("the socket must be non-blocking")
783 self._check_sendfile_params(sock, file, offset, count)
784 try:
785 return await self._sock_sendfile_native(sock, file,
786 offset, count)
Andrew Svetlov7464e872018-01-19 20:04:29 +0200787 except events.SendfileNotAvailableError as exc:
788 if not fallback:
789 raise
790 return await self._sock_sendfile_fallback(sock, file,
791 offset, count)
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200792
793 async def _sock_sendfile_native(self, sock, file, offset, count):
794 # NB: sendfile syscall is not supported for SSL sockets and
795 # non-mmap files even if sendfile is supported by OS
Andrew Svetlov7464e872018-01-19 20:04:29 +0200796 raise events.SendfileNotAvailableError(
Andrew Svetlov6b5a2792018-01-16 19:59:34 +0200797 f"syscall sendfile is not available for socket {sock!r} "
798 "and file {file!r} combination")
799
800 async def _sock_sendfile_fallback(self, sock, file, offset, count):
801 if offset:
802 file.seek(offset)
803 blocksize = min(count, 16384) if count else 16384
804 buf = bytearray(blocksize)
805 total_sent = 0
806 try:
807 while True:
808 if count:
809 blocksize = min(count - total_sent, blocksize)
810 if blocksize <= 0:
811 break
812 view = memoryview(buf)[:blocksize]
813 read = file.readinto(view)
814 if not read:
815 break # EOF
816 await self.sock_sendall(sock, view)
817 total_sent += read
818 return total_sent
819 finally:
820 if total_sent > 0 and hasattr(file, 'seek'):
821 file.seek(offset + total_sent)
822
823 def _check_sendfile_params(self, sock, file, offset, count):
824 if 'b' not in getattr(file, 'mode', 'b'):
825 raise ValueError("file should be opened in binary mode")
826 if not sock.type == socket.SOCK_STREAM:
827 raise ValueError("only SOCK_STREAM type sockets are supported")
828 if count is not None:
829 if not isinstance(count, int):
830 raise TypeError(
831 "count must be a positive integer (got {!r})".format(count))
832 if count <= 0:
833 raise ValueError(
834 "count must be a positive integer (got {!r})".format(count))
835 if not isinstance(offset, int):
836 raise TypeError(
837 "offset must be a non-negative integer (got {!r})".format(
838 offset))
839 if offset < 0:
840 raise ValueError(
841 "offset must be a non-negative integer (got {!r})".format(
842 offset))
843
Neil Aspinallf7686c12017-12-19 19:45:42 +0000844 async def create_connection(
845 self, protocol_factory, host=None, port=None,
846 *, ssl=None, family=0,
847 proto=0, flags=0, sock=None,
848 local_addr=None, server_hostname=None,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +0200849 ssl_handshake_timeout=None):
Victor Stinnerd1432092014-06-19 17:11:49 +0200850 """Connect to a TCP server.
851
852 Create a streaming transport connection to a given Internet host and
853 port: socket family AF_INET or socket.AF_INET6 depending on host (or
854 family if specified), socket type SOCK_STREAM. protocol_factory must be
855 a callable returning a protocol instance.
856
857 This method is a coroutine which will try to establish the connection
858 in the background. When successful, the coroutine returns a
859 (transport, protocol) pair.
860 """
Guido van Rossum21c85a72013-11-01 14:16:54 -0700861 if server_hostname is not None and not ssl:
862 raise ValueError('server_hostname is only meaningful with ssl')
863
864 if server_hostname is None and ssl:
865 # Use host as default for server_hostname. It is an error
866 # if host is empty or not set, e.g. when an
867 # already-connected socket was passed or when only a port
868 # is given. To avoid this error, you can pass
869 # server_hostname='' -- this will bypass the hostname
870 # check. (This also means that if host is a numeric
871 # IP/IPv6 address, we will attempt to verify that exact
872 # address; this will probably fail, but it is possible to
873 # create a certificate for a specific IP address, so we
874 # don't judge it here.)
875 if not host:
876 raise ValueError('You must set server_hostname '
877 'when using ssl without a host')
878 server_hostname = host
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700879
Andrew Svetlov51eb1c62017-12-20 20:24:43 +0200880 if ssl_handshake_timeout is not None and not ssl:
881 raise ValueError(
882 'ssl_handshake_timeout is only meaningful with ssl')
883
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700884 if host is not None or port is not None:
885 if sock is not None:
886 raise ValueError(
887 'host/port and sock can not be specified at the same time')
888
Yury Selivanov19a44f62017-12-14 20:53:26 -0500889 infos = await self._ensure_resolved(
890 (host, port), family=family,
891 type=socket.SOCK_STREAM, proto=proto, flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700892 if not infos:
893 raise OSError('getaddrinfo() returned empty list')
Yury Selivanov19a44f62017-12-14 20:53:26 -0500894
895 if local_addr is not None:
896 laddr_infos = await self._ensure_resolved(
897 local_addr, family=family,
898 type=socket.SOCK_STREAM, proto=proto,
899 flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700900 if not laddr_infos:
901 raise OSError('getaddrinfo() returned empty list')
902
903 exceptions = []
904 for family, type, proto, cname, address in infos:
905 try:
906 sock = socket.socket(family=family, type=type, proto=proto)
907 sock.setblocking(False)
Yury Selivanov19a44f62017-12-14 20:53:26 -0500908 if local_addr is not None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700909 for _, _, _, _, laddr in laddr_infos:
910 try:
911 sock.bind(laddr)
912 break
913 except OSError as exc:
Yury Selivanov6370f342017-12-10 18:36:12 -0500914 msg = (
915 f'error while attempting to bind on '
916 f'address {laddr!r}: '
917 f'{exc.strerror.lower()}'
918 )
919 exc = OSError(exc.errno, msg)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700920 exceptions.append(exc)
921 else:
922 sock.close()
923 sock = None
924 continue
Victor Stinnere912e652014-07-12 03:11:53 +0200925 if self._debug:
926 logger.debug("connect %r to %r", sock, address)
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200927 await self.sock_connect(sock, address)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700928 except OSError as exc:
929 if sock is not None:
930 sock.close()
931 exceptions.append(exc)
Victor Stinner223a6242014-06-04 00:11:52 +0200932 except:
933 if sock is not None:
934 sock.close()
935 raise
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700936 else:
937 break
938 else:
939 if len(exceptions) == 1:
940 raise exceptions[0]
941 else:
942 # If they all have the same str(), raise one.
943 model = str(exceptions[0])
944 if all(str(exc) == model for exc in exceptions):
945 raise exceptions[0]
946 # Raise a combined exception so the user can see all
947 # the various error messages.
948 raise OSError('Multiple exceptions: {}'.format(
949 ', '.join(str(exc) for exc in exceptions)))
950
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500951 else:
952 if sock is None:
953 raise ValueError(
954 'host and port was not specified and no sock specified')
Yury Selivanova7bd64c2017-12-19 06:44:37 -0500955 if sock.type != socket.SOCK_STREAM:
Yury Selivanovdab05842016-11-21 17:47:27 -0500956 # We allow AF_INET, AF_INET6, AF_UNIX as long as they
957 # are SOCK_STREAM.
958 # We support passing AF_UNIX sockets even though we have
959 # a dedicated API for that: create_unix_connection.
960 # Disallowing AF_UNIX in this method, breaks backwards
961 # compatibility.
Yury Selivanova1a8b7d2016-11-09 15:47:00 -0500962 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -0500963 f'A Stream Socket was expected, got {sock!r}')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700964
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200965 transport, protocol = await self._create_connection_transport(
Neil Aspinallf7686c12017-12-19 19:45:42 +0000966 sock, protocol_factory, ssl, server_hostname,
967 ssl_handshake_timeout=ssl_handshake_timeout)
Victor Stinnere912e652014-07-12 03:11:53 +0200968 if self._debug:
Victor Stinnerb2614752014-08-25 23:20:52 +0200969 # Get the socket from the transport because SSL transport closes
970 # the old socket and creates a new SSL socket
971 sock = transport.get_extra_info('socket')
Victor Stinneracdb7822014-07-14 18:33:40 +0200972 logger.debug("%r connected to %s:%r: (%r, %r)",
973 sock, host, port, transport, protocol)
Yury Selivanovb057c522014-02-18 12:15:06 -0500974 return transport, protocol
975
Neil Aspinallf7686c12017-12-19 19:45:42 +0000976 async def _create_connection_transport(
977 self, sock, protocol_factory, ssl,
978 server_hostname, server_side=False,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +0200979 ssl_handshake_timeout=None):
Yury Selivanov252e9ed2016-07-12 18:23:10 -0400980
981 sock.setblocking(False)
982
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700983 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -0400984 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700985 if ssl:
986 sslcontext = None if isinstance(ssl, bool) else ssl
987 transport = self._make_ssl_transport(
988 sock, protocol, sslcontext, waiter,
Neil Aspinallf7686c12017-12-19 19:45:42 +0000989 server_side=server_side, server_hostname=server_hostname,
990 ssl_handshake_timeout=ssl_handshake_timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700991 else:
992 transport = self._make_socket_transport(sock, protocol, waiter)
993
Victor Stinner29ad0112015-01-15 00:04:21 +0100994 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +0200995 await waiter
Victor Stinner0c2e4082015-01-22 00:17:41 +0100996 except:
Victor Stinner29ad0112015-01-15 00:04:21 +0100997 transport.close()
998 raise
999
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001000 return transport, protocol
1001
Andrew Svetlov7c684072018-01-27 21:22:47 +02001002 async def sendfile(self, transport, file, offset=0, count=None,
1003 *, fallback=True):
1004 """Send a file to transport.
1005
1006 Return the total number of bytes which were sent.
1007
1008 The method uses high-performance os.sendfile if available.
1009
1010 file must be a regular file object opened in binary mode.
1011
1012 offset tells from where to start reading the file. If specified,
1013 count is the total number of bytes to transmit as opposed to
1014 sending the file until EOF is reached. File position is updated on
1015 return or also in case of error in which case file.tell()
1016 can be used to figure out the number of bytes
1017 which were sent.
1018
1019 fallback set to True makes asyncio to manually read and send
1020 the file when the platform does not support the sendfile syscall
1021 (e.g. Windows or SSL socket on Unix).
1022
1023 Raise SendfileNotAvailableError if the system does not support
1024 sendfile syscall and fallback is False.
1025 """
1026 if transport.is_closing():
1027 raise RuntimeError("Transport is closing")
1028 mode = getattr(transport, '_sendfile_compatible',
1029 constants._SendfileMode.UNSUPPORTED)
1030 if mode is constants._SendfileMode.UNSUPPORTED:
1031 raise RuntimeError(
1032 f"sendfile is not supported for transport {transport!r}")
1033 if mode is constants._SendfileMode.TRY_NATIVE:
1034 try:
1035 return await self._sendfile_native(transport, file,
1036 offset, count)
1037 except events.SendfileNotAvailableError as exc:
1038 if not fallback:
1039 raise
Yury Selivanovb1a6ac42018-01-27 15:52:52 -05001040
1041 if not fallback:
1042 raise RuntimeError(
1043 f"fallback is disabled and native sendfile is not "
1044 f"supported for transport {transport!r}")
1045
Andrew Svetlov7c684072018-01-27 21:22:47 +02001046 return await self._sendfile_fallback(transport, file,
1047 offset, count)
1048
1049 async def _sendfile_native(self, transp, file, offset, count):
1050 raise events.SendfileNotAvailableError(
1051 "sendfile syscall is not supported")
1052
1053 async def _sendfile_fallback(self, transp, file, offset, count):
1054 if offset:
1055 file.seek(offset)
1056 blocksize = min(count, 16384) if count else 16384
1057 buf = bytearray(blocksize)
1058 total_sent = 0
1059 proto = _SendfileFallbackProtocol(transp)
1060 try:
1061 while True:
1062 if count:
1063 blocksize = min(count - total_sent, blocksize)
1064 if blocksize <= 0:
1065 return total_sent
1066 view = memoryview(buf)[:blocksize]
1067 read = file.readinto(view)
1068 if not read:
1069 return total_sent # EOF
1070 await proto.drain()
1071 transp.write(view)
1072 total_sent += read
1073 finally:
1074 if total_sent > 0 and hasattr(file, 'seek'):
1075 file.seek(offset + total_sent)
1076 await proto.restore()
1077
Yury Selivanovf111b3d2017-12-30 00:35:36 -05001078 async def start_tls(self, transport, protocol, sslcontext, *,
1079 server_side=False,
1080 server_hostname=None,
1081 ssl_handshake_timeout=None):
1082 """Upgrade transport to TLS.
1083
1084 Return a new transport that *protocol* should start using
1085 immediately.
1086 """
1087 if ssl is None:
1088 raise RuntimeError('Python ssl module is not available')
1089
1090 if not isinstance(sslcontext, ssl.SSLContext):
1091 raise TypeError(
1092 f'sslcontext is expected to be an instance of ssl.SSLContext, '
1093 f'got {sslcontext!r}')
1094
1095 if not getattr(transport, '_start_tls_compatible', False):
1096 raise TypeError(
1097 f'transport {self!r} is not supported by start_tls()')
1098
1099 waiter = self.create_future()
1100 ssl_protocol = sslproto.SSLProtocol(
1101 self, protocol, sslcontext, waiter,
1102 server_side, server_hostname,
1103 ssl_handshake_timeout=ssl_handshake_timeout,
1104 call_connection_made=False)
1105
1106 transport.set_protocol(ssl_protocol)
1107 self.call_soon(ssl_protocol.connection_made, transport)
1108 if not transport.is_reading():
1109 self.call_soon(transport.resume_reading)
1110
1111 await waiter
1112 return ssl_protocol._app_transport
1113
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001114 async def create_datagram_endpoint(self, protocol_factory,
1115 local_addr=None, remote_addr=None, *,
1116 family=0, proto=0, flags=0,
1117 reuse_address=None, reuse_port=None,
1118 allow_broadcast=None, sock=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001119 """Create datagram connection."""
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001120 if sock is not None:
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001121 if sock.type != socket.SOCK_DGRAM:
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001122 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001123 f'A UDP Socket was expected, got {sock!r}')
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001124 if (local_addr or remote_addr or
1125 family or proto or flags or
1126 reuse_address or reuse_port or allow_broadcast):
1127 # show the problematic kwargs in exception msg
1128 opts = dict(local_addr=local_addr, remote_addr=remote_addr,
1129 family=family, proto=proto, flags=flags,
1130 reuse_address=reuse_address, reuse_port=reuse_port,
1131 allow_broadcast=allow_broadcast)
Yury Selivanov6370f342017-12-10 18:36:12 -05001132 problems = ', '.join(f'{k}={v}' for k, v in opts.items() if v)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001133 raise ValueError(
Yury Selivanov6370f342017-12-10 18:36:12 -05001134 f'socket modifier keyword arguments can not be used '
1135 f'when sock is specified. ({problems})')
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001136 sock.setblocking(False)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001137 r_addr = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001138 else:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001139 if not (local_addr or remote_addr):
1140 if family == 0:
1141 raise ValueError('unexpected address family')
1142 addr_pairs_info = (((family, proto), (None, None)),)
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001143 elif hasattr(socket, 'AF_UNIX') and family == socket.AF_UNIX:
1144 for addr in (local_addr, remote_addr):
Victor Stinner28e61652017-11-28 00:34:08 +01001145 if addr is not None and not isinstance(addr, str):
Quentin Dawansfe4ea9c2017-10-30 14:43:02 +01001146 raise TypeError('string is expected')
1147 addr_pairs_info = (((family, proto),
1148 (local_addr, remote_addr)), )
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001149 else:
1150 # join address by (family, protocol)
1151 addr_infos = collections.OrderedDict()
1152 for idx, addr in ((0, local_addr), (1, remote_addr)):
1153 if addr is not None:
1154 assert isinstance(addr, tuple) and len(addr) == 2, (
1155 '2-tuple is expected')
1156
Yury Selivanov19a44f62017-12-14 20:53:26 -05001157 infos = await self._ensure_resolved(
Yury Selivanovf1c6fa92016-06-08 12:33:31 -04001158 addr, family=family, type=socket.SOCK_DGRAM,
1159 proto=proto, flags=flags, loop=self)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001160 if not infos:
1161 raise OSError('getaddrinfo() returned empty list')
1162
1163 for fam, _, pro, _, address in infos:
1164 key = (fam, pro)
1165 if key not in addr_infos:
1166 addr_infos[key] = [None, None]
1167 addr_infos[key][idx] = address
1168
1169 # each addr has to have info for each (family, proto) pair
1170 addr_pairs_info = [
1171 (key, addr_pair) for key, addr_pair in addr_infos.items()
1172 if not ((local_addr and addr_pair[0] is None) or
1173 (remote_addr and addr_pair[1] is None))]
1174
1175 if not addr_pairs_info:
1176 raise ValueError('can not get address information')
1177
1178 exceptions = []
1179
1180 if reuse_address is None:
1181 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
1182
1183 for ((family, proto),
1184 (local_address, remote_address)) in addr_pairs_info:
1185 sock = None
1186 r_addr = None
1187 try:
1188 sock = socket.socket(
1189 family=family, type=socket.SOCK_DGRAM, proto=proto)
1190 if reuse_address:
1191 sock.setsockopt(
1192 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
1193 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001194 _set_reuseport(sock)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001195 if allow_broadcast:
1196 sock.setsockopt(
1197 socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
1198 sock.setblocking(False)
1199
1200 if local_addr:
1201 sock.bind(local_address)
1202 if remote_addr:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001203 await self.sock_connect(sock, remote_address)
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001204 r_addr = remote_address
1205 except OSError as exc:
1206 if sock is not None:
1207 sock.close()
1208 exceptions.append(exc)
1209 except:
1210 if sock is not None:
1211 sock.close()
1212 raise
1213 else:
1214 break
1215 else:
1216 raise exceptions[0]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001217
1218 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001219 waiter = self.create_future()
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001220 transport = self._make_datagram_transport(
1221 sock, protocol, r_addr, waiter)
Victor Stinnere912e652014-07-12 03:11:53 +02001222 if self._debug:
1223 if local_addr:
1224 logger.info("Datagram endpoint local_addr=%r remote_addr=%r "
1225 "created: (%r, %r)",
1226 local_addr, remote_addr, transport, protocol)
1227 else:
1228 logger.debug("Datagram endpoint remote_addr=%r created: "
1229 "(%r, %r)",
1230 remote_addr, transport, protocol)
Victor Stinner2596dd02015-01-26 11:02:18 +01001231
1232 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001233 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001234 except:
1235 transport.close()
1236 raise
1237
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001238 return transport, protocol
1239
Yury Selivanov19a44f62017-12-14 20:53:26 -05001240 async def _ensure_resolved(self, address, *,
1241 family=0, type=socket.SOCK_STREAM,
1242 proto=0, flags=0, loop):
1243 host, port = address[:2]
1244 info = _ipaddr_info(host, port, family, type, proto)
1245 if info is not None:
1246 # "host" is already a resolved IP.
1247 return [info]
1248 else:
1249 return await loop.getaddrinfo(host, port, family=family, type=type,
1250 proto=proto, flags=flags)
1251
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001252 async def _create_server_getaddrinfo(self, host, port, family, flags):
Yury Selivanov19a44f62017-12-14 20:53:26 -05001253 infos = await self._ensure_resolved((host, port), family=family,
1254 type=socket.SOCK_STREAM,
1255 flags=flags, loop=self)
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001256 if not infos:
Yury Selivanov6370f342017-12-10 18:36:12 -05001257 raise OSError(f'getaddrinfo({host!r}) returned empty list')
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001258 return infos
1259
Neil Aspinallf7686c12017-12-19 19:45:42 +00001260 async def create_server(
1261 self, protocol_factory, host=None, port=None,
1262 *,
1263 family=socket.AF_UNSPEC,
1264 flags=socket.AI_PASSIVE,
1265 sock=None,
1266 backlog=100,
1267 ssl=None,
1268 reuse_address=None,
1269 reuse_port=None,
Yury Selivanovc9070d02018-01-25 18:08:09 -05001270 ssl_handshake_timeout=None,
1271 start_serving=True):
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001272 """Create a TCP server.
1273
Yury Selivanov6370f342017-12-10 18:36:12 -05001274 The host parameter can be a string, in that case the TCP server is
1275 bound to host and port.
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001276
1277 The host parameter can also be a sequence of strings and in that case
Yury Selivanove076ffb2016-03-02 11:17:01 -05001278 the TCP server is bound to all hosts of the sequence. If a host
1279 appears multiple times (possibly indirectly e.g. when hostnames
1280 resolve to the same IP address), the server is only bound once to that
1281 host.
Victor Stinnerd1432092014-06-19 17:11:49 +02001282
Victor Stinneracdb7822014-07-14 18:33:40 +02001283 Return a Server object which can be used to stop the service.
Victor Stinnerd1432092014-06-19 17:11:49 +02001284
1285 This method is a coroutine.
1286 """
Guido van Rossum28dff0d2013-11-01 14:22:30 -07001287 if isinstance(ssl, bool):
1288 raise TypeError('ssl argument must be an SSLContext or None')
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001289
1290 if ssl_handshake_timeout is not None and ssl is None:
1291 raise ValueError(
1292 'ssl_handshake_timeout is only meaningful with ssl')
1293
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001294 if host is not None or port is not None:
1295 if sock is not None:
1296 raise ValueError(
1297 'host/port and sock can not be specified at the same time')
1298
1299 AF_INET6 = getattr(socket, 'AF_INET6', 0)
1300 if reuse_address is None:
1301 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
1302 sockets = []
1303 if host == '':
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001304 hosts = [None]
1305 elif (isinstance(host, str) or
Serhiy Storchaka2e576f52017-04-24 09:05:00 +03001306 not isinstance(host, collections.abc.Iterable)):
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001307 hosts = [host]
1308 else:
1309 hosts = host
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001310
Victor Stinner5e4a7d82015-09-21 18:33:43 +02001311 fs = [self._create_server_getaddrinfo(host, port, family=family,
1312 flags=flags)
1313 for host in hosts]
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001314 infos = await tasks.gather(*fs, loop=self)
Yury Selivanove076ffb2016-03-02 11:17:01 -05001315 infos = set(itertools.chain.from_iterable(infos))
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001316
1317 completed = False
1318 try:
1319 for res in infos:
1320 af, socktype, proto, canonname, sa = res
Guido van Rossum32e46852013-10-19 17:04:25 -07001321 try:
1322 sock = socket.socket(af, socktype, proto)
1323 except socket.error:
1324 # Assume it's a bad family/type/protocol combination.
Victor Stinnerb2614752014-08-25 23:20:52 +02001325 if self._debug:
1326 logger.warning('create_server() failed to create '
1327 'socket.socket(%r, %r, %r)',
1328 af, socktype, proto, exc_info=True)
Guido van Rossum32e46852013-10-19 17:04:25 -07001329 continue
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001330 sockets.append(sock)
1331 if reuse_address:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001332 sock.setsockopt(
1333 socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
1334 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001335 _set_reuseport(sock)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001336 # Disable IPv4/IPv6 dual stack support (enabled by
1337 # default on Linux) which makes a single socket
1338 # listen on both address families.
1339 if af == AF_INET6 and hasattr(socket, 'IPPROTO_IPV6'):
1340 sock.setsockopt(socket.IPPROTO_IPV6,
1341 socket.IPV6_V6ONLY,
1342 True)
1343 try:
1344 sock.bind(sa)
1345 except OSError as err:
1346 raise OSError(err.errno, 'error while attempting '
1347 'to bind on address %r: %s'
Serhiy Storchaka5affd232017-04-05 09:37:24 +03001348 % (sa, err.strerror.lower())) from None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001349 completed = True
1350 finally:
1351 if not completed:
1352 for sock in sockets:
1353 sock.close()
1354 else:
1355 if sock is None:
Victor Stinneracdb7822014-07-14 18:33:40 +02001356 raise ValueError('Neither host/port nor sock were specified')
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001357 if sock.type != socket.SOCK_STREAM:
Yury Selivanov6370f342017-12-10 18:36:12 -05001358 raise ValueError(f'A Stream Socket was expected, got {sock!r}')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001359 sockets = [sock]
1360
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001361 for sock in sockets:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001362 sock.setblocking(False)
Yury Selivanovc9070d02018-01-25 18:08:09 -05001363
1364 server = Server(self, sockets, protocol_factory,
1365 ssl, backlog, ssl_handshake_timeout)
1366 if start_serving:
1367 server._start_serving()
Miss Islington (bot)bc3a0022018-05-28 11:50:45 -07001368 # Skip one loop iteration so that all 'loop.add_reader'
1369 # go through.
1370 await tasks.sleep(0, loop=self)
Yury Selivanovc9070d02018-01-25 18:08:09 -05001371
Victor Stinnere912e652014-07-12 03:11:53 +02001372 if self._debug:
1373 logger.info("%r is serving", server)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001374 return server
1375
Neil Aspinallf7686c12017-12-19 19:45:42 +00001376 async def connect_accepted_socket(
1377 self, protocol_factory, sock,
1378 *, ssl=None,
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001379 ssl_handshake_timeout=None):
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001380 """Handle an accepted connection.
1381
1382 This is used by servers that accept connections outside of
1383 asyncio but that use asyncio to handle connections.
1384
1385 This method is a coroutine. When completed, the coroutine
1386 returns a (transport, protocol) pair.
1387 """
Yury Selivanova7bd64c2017-12-19 06:44:37 -05001388 if sock.type != socket.SOCK_STREAM:
Yury Selivanov6370f342017-12-10 18:36:12 -05001389 raise ValueError(f'A Stream Socket was expected, got {sock!r}')
Yury Selivanova1a8b7d2016-11-09 15:47:00 -05001390
Andrew Svetlov51eb1c62017-12-20 20:24:43 +02001391 if ssl_handshake_timeout is not None and not ssl:
1392 raise ValueError(
1393 'ssl_handshake_timeout is only meaningful with ssl')
1394
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001395 transport, protocol = await self._create_connection_transport(
Neil Aspinallf7686c12017-12-19 19:45:42 +00001396 sock, protocol_factory, ssl, '', server_side=True,
1397 ssl_handshake_timeout=ssl_handshake_timeout)
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001398 if self._debug:
1399 # Get the socket from the transport because SSL transport closes
1400 # the old socket and creates a new SSL socket
1401 sock = transport.get_extra_info('socket')
1402 logger.debug("%r handled: (%r, %r)", sock, transport, protocol)
1403 return transport, protocol
1404
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001405 async def connect_read_pipe(self, protocol_factory, pipe):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001406 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001407 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001408 transport = self._make_read_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001409
1410 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001411 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001412 except:
1413 transport.close()
1414 raise
1415
Victor Stinneracdb7822014-07-14 18:33:40 +02001416 if self._debug:
1417 logger.debug('Read pipe %r connected: (%r, %r)',
1418 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001419 return transport, protocol
1420
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001421 async def connect_write_pipe(self, protocol_factory, pipe):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001422 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001423 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001424 transport = self._make_write_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001425
1426 try:
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001427 await waiter
Victor Stinner2596dd02015-01-26 11:02:18 +01001428 except:
1429 transport.close()
1430 raise
1431
Victor Stinneracdb7822014-07-14 18:33:40 +02001432 if self._debug:
1433 logger.debug('Write pipe %r connected: (%r, %r)',
1434 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001435 return transport, protocol
1436
Victor Stinneracdb7822014-07-14 18:33:40 +02001437 def _log_subprocess(self, msg, stdin, stdout, stderr):
1438 info = [msg]
1439 if stdin is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001440 info.append(f'stdin={_format_pipe(stdin)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001441 if stdout is not None and stderr == subprocess.STDOUT:
Yury Selivanov6370f342017-12-10 18:36:12 -05001442 info.append(f'stdout=stderr={_format_pipe(stdout)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001443 else:
1444 if stdout is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001445 info.append(f'stdout={_format_pipe(stdout)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001446 if stderr is not None:
Yury Selivanov6370f342017-12-10 18:36:12 -05001447 info.append(f'stderr={_format_pipe(stderr)}')
Victor Stinneracdb7822014-07-14 18:33:40 +02001448 logger.debug(' '.join(info))
1449
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001450 async def subprocess_shell(self, protocol_factory, cmd, *,
1451 stdin=subprocess.PIPE,
1452 stdout=subprocess.PIPE,
1453 stderr=subprocess.PIPE,
1454 universal_newlines=False,
1455 shell=True, bufsize=0,
1456 **kwargs):
Victor Stinner20e07432014-02-11 11:44:56 +01001457 if not isinstance(cmd, (bytes, str)):
Victor Stinnere623a122014-01-29 14:35:15 -08001458 raise ValueError("cmd must be a string")
1459 if universal_newlines:
1460 raise ValueError("universal_newlines must be False")
1461 if not shell:
Victor Stinner323748e2014-01-31 12:28:30 +01001462 raise ValueError("shell must be True")
Victor Stinnere623a122014-01-29 14:35:15 -08001463 if bufsize != 0:
1464 raise ValueError("bufsize must be 0")
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001465 protocol = protocol_factory()
Victor Stinneracdb7822014-07-14 18:33:40 +02001466 if self._debug:
1467 # don't log parameters: they may contain sensitive information
1468 # (password) and may be too long
1469 debug_log = 'run shell command %r' % cmd
1470 self._log_subprocess(debug_log, stdin, stdout, stderr)
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001471 transport = await self._make_subprocess_transport(
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001472 protocol, cmd, True, stdin, stdout, stderr, bufsize, **kwargs)
Victor Stinneracdb7822014-07-14 18:33:40 +02001473 if self._debug:
Vinay Sajipdd917f82016-08-31 08:22:29 +01001474 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001475 return transport, protocol
1476
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001477 async def subprocess_exec(self, protocol_factory, program, *args,
1478 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1479 stderr=subprocess.PIPE, universal_newlines=False,
1480 shell=False, bufsize=0, **kwargs):
Victor Stinnere623a122014-01-29 14:35:15 -08001481 if universal_newlines:
1482 raise ValueError("universal_newlines must be False")
1483 if shell:
1484 raise ValueError("shell must be False")
1485 if bufsize != 0:
1486 raise ValueError("bufsize must be 0")
Victor Stinner20e07432014-02-11 11:44:56 +01001487 popen_args = (program,) + args
1488 for arg in popen_args:
1489 if not isinstance(arg, (str, bytes)):
Yury Selivanov6370f342017-12-10 18:36:12 -05001490 raise TypeError(
1491 f"program arguments must be a bytes or text string, "
1492 f"not {type(arg).__name__}")
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001493 protocol = protocol_factory()
Victor Stinneracdb7822014-07-14 18:33:40 +02001494 if self._debug:
1495 # don't log parameters: they may contain sensitive information
1496 # (password) and may be too long
Yury Selivanov6370f342017-12-10 18:36:12 -05001497 debug_log = f'execute program {program!r}'
Victor Stinneracdb7822014-07-14 18:33:40 +02001498 self._log_subprocess(debug_log, stdin, stdout, stderr)
Andrew Svetlov5f841b52017-12-09 00:23:48 +02001499 transport = await self._make_subprocess_transport(
Yury Selivanov57797522014-02-18 22:56:15 -05001500 protocol, popen_args, False, stdin, stdout, stderr,
1501 bufsize, **kwargs)
Victor Stinneracdb7822014-07-14 18:33:40 +02001502 if self._debug:
Vinay Sajipdd917f82016-08-31 08:22:29 +01001503 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001504 return transport, protocol
1505
Yury Selivanov7ed7ce62016-05-16 15:20:38 -04001506 def get_exception_handler(self):
1507 """Return an exception handler, or None if the default one is in use.
1508 """
1509 return self._exception_handler
1510
Yury Selivanov569efa22014-02-18 18:02:19 -05001511 def set_exception_handler(self, handler):
1512 """Set handler as the new event loop exception handler.
1513
1514 If handler is None, the default exception handler will
1515 be set.
1516
1517 If handler is a callable object, it should have a
Victor Stinneracdb7822014-07-14 18:33:40 +02001518 signature matching '(loop, context)', where 'loop'
Yury Selivanov569efa22014-02-18 18:02:19 -05001519 will be a reference to the active event loop, 'context'
1520 will be a dict object (see `call_exception_handler()`
1521 documentation for details about context).
1522 """
1523 if handler is not None and not callable(handler):
Yury Selivanov6370f342017-12-10 18:36:12 -05001524 raise TypeError(f'A callable object or None is expected, '
1525 f'got {handler!r}')
Yury Selivanov569efa22014-02-18 18:02:19 -05001526 self._exception_handler = handler
1527
1528 def default_exception_handler(self, context):
1529 """Default exception handler.
1530
1531 This is called when an exception occurs and no exception
1532 handler is set, and can be called by a custom exception
1533 handler that wants to defer to the default behavior.
1534
Antoine Pitrou921e9432017-11-07 17:23:29 +01001535 This default handler logs the error message and other
1536 context-dependent information. In debug mode, a truncated
1537 stack trace is also appended showing where the given object
1538 (e.g. a handle or future or task) was created, if any.
1539
Victor Stinneracdb7822014-07-14 18:33:40 +02001540 The context parameter has the same meaning as in
Yury Selivanov569efa22014-02-18 18:02:19 -05001541 `call_exception_handler()`.
1542 """
1543 message = context.get('message')
1544 if not message:
1545 message = 'Unhandled exception in event loop'
1546
1547 exception = context.get('exception')
1548 if exception is not None:
1549 exc_info = (type(exception), exception, exception.__traceback__)
1550 else:
1551 exc_info = False
1552
Yury Selivanov6370f342017-12-10 18:36:12 -05001553 if ('source_traceback' not in context and
1554 self._current_handle is not None and
1555 self._current_handle._source_traceback):
1556 context['handle_traceback'] = \
1557 self._current_handle._source_traceback
Victor Stinner9b524d52015-01-26 11:05:12 +01001558
Yury Selivanov569efa22014-02-18 18:02:19 -05001559 log_lines = [message]
1560 for key in sorted(context):
1561 if key in {'message', 'exception'}:
1562 continue
Victor Stinner80f53aa2014-06-27 13:52:20 +02001563 value = context[key]
1564 if key == 'source_traceback':
1565 tb = ''.join(traceback.format_list(value))
1566 value = 'Object created at (most recent call last):\n'
1567 value += tb.rstrip()
Victor Stinner9b524d52015-01-26 11:05:12 +01001568 elif key == 'handle_traceback':
1569 tb = ''.join(traceback.format_list(value))
1570 value = 'Handle created at (most recent call last):\n'
1571 value += tb.rstrip()
Victor Stinner80f53aa2014-06-27 13:52:20 +02001572 else:
1573 value = repr(value)
Yury Selivanov6370f342017-12-10 18:36:12 -05001574 log_lines.append(f'{key}: {value}')
Yury Selivanov569efa22014-02-18 18:02:19 -05001575
1576 logger.error('\n'.join(log_lines), exc_info=exc_info)
1577
1578 def call_exception_handler(self, context):
Victor Stinneracdb7822014-07-14 18:33:40 +02001579 """Call the current event loop's exception handler.
Yury Selivanov569efa22014-02-18 18:02:19 -05001580
Victor Stinneracdb7822014-07-14 18:33:40 +02001581 The context argument is a dict containing the following keys:
1582
Yury Selivanov569efa22014-02-18 18:02:19 -05001583 - 'message': Error message;
1584 - 'exception' (optional): Exception object;
1585 - 'future' (optional): Future instance;
Yury Selivanova4afcdf2018-01-21 14:56:59 -05001586 - 'task' (optional): Task instance;
Yury Selivanov569efa22014-02-18 18:02:19 -05001587 - 'handle' (optional): Handle instance;
1588 - 'protocol' (optional): Protocol instance;
1589 - 'transport' (optional): Transport instance;
Yury Selivanoveb636452016-09-08 22:01:51 -07001590 - 'socket' (optional): Socket instance;
1591 - 'asyncgen' (optional): Asynchronous generator that caused
1592 the exception.
Yury Selivanov569efa22014-02-18 18:02:19 -05001593
Victor Stinneracdb7822014-07-14 18:33:40 +02001594 New keys maybe introduced in the future.
1595
1596 Note: do not overload this method in an event loop subclass.
1597 For custom exception handling, use the
Yury Selivanov569efa22014-02-18 18:02:19 -05001598 `set_exception_handler()` method.
1599 """
1600 if self._exception_handler is None:
1601 try:
1602 self.default_exception_handler(context)
1603 except Exception:
1604 # Second protection layer for unexpected errors
1605 # in the default implementation, as well as for subclassed
1606 # event loops with overloaded "default_exception_handler".
1607 logger.error('Exception in default exception handler',
1608 exc_info=True)
1609 else:
1610 try:
1611 self._exception_handler(self, context)
1612 except Exception as exc:
1613 # Exception in the user set custom exception handler.
1614 try:
1615 # Let's try default handler.
1616 self.default_exception_handler({
1617 'message': 'Unhandled error in exception handler',
1618 'exception': exc,
1619 'context': context,
1620 })
1621 except Exception:
Victor Stinneracdb7822014-07-14 18:33:40 +02001622 # Guard 'default_exception_handler' in case it is
Yury Selivanov569efa22014-02-18 18:02:19 -05001623 # overloaded.
1624 logger.error('Exception in default exception handler '
1625 'while handling an unexpected error '
1626 'in custom exception handler',
1627 exc_info=True)
1628
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001629 def _add_callback(self, handle):
Victor Stinneracdb7822014-07-14 18:33:40 +02001630 """Add a Handle to _scheduled (TimerHandle) or _ready."""
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001631 assert isinstance(handle, events.Handle), 'A Handle is required here'
1632 if handle._cancelled:
1633 return
Yury Selivanov592ada92014-09-25 12:07:56 -04001634 assert not isinstance(handle, events.TimerHandle)
1635 self._ready.append(handle)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001636
1637 def _add_callback_signalsafe(self, handle):
1638 """Like _add_callback() but called from a signal handler."""
1639 self._add_callback(handle)
1640 self._write_to_self()
1641
Yury Selivanov592ada92014-09-25 12:07:56 -04001642 def _timer_handle_cancelled(self, handle):
1643 """Notification that a TimerHandle has been cancelled."""
1644 if handle._scheduled:
1645 self._timer_cancelled_count += 1
1646
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001647 def _run_once(self):
1648 """Run one full iteration of the event loop.
1649
1650 This calls all currently ready callbacks, polls for I/O,
1651 schedules the resulting callbacks, and finally schedules
1652 'call_later' callbacks.
1653 """
Yury Selivanov592ada92014-09-25 12:07:56 -04001654
Yury Selivanov592ada92014-09-25 12:07:56 -04001655 sched_count = len(self._scheduled)
1656 if (sched_count > _MIN_SCHEDULED_TIMER_HANDLES and
1657 self._timer_cancelled_count / sched_count >
1658 _MIN_CANCELLED_TIMER_HANDLES_FRACTION):
Victor Stinner68da8fc2014-09-30 18:08:36 +02001659 # Remove delayed calls that were cancelled if their number
1660 # is too high
1661 new_scheduled = []
Yury Selivanov592ada92014-09-25 12:07:56 -04001662 for handle in self._scheduled:
1663 if handle._cancelled:
1664 handle._scheduled = False
Victor Stinner68da8fc2014-09-30 18:08:36 +02001665 else:
1666 new_scheduled.append(handle)
Yury Selivanov592ada92014-09-25 12:07:56 -04001667
Victor Stinner68da8fc2014-09-30 18:08:36 +02001668 heapq.heapify(new_scheduled)
1669 self._scheduled = new_scheduled
Yury Selivanov592ada92014-09-25 12:07:56 -04001670 self._timer_cancelled_count = 0
Yury Selivanov592ada92014-09-25 12:07:56 -04001671 else:
1672 # Remove delayed calls that were cancelled from head of queue.
1673 while self._scheduled and self._scheduled[0]._cancelled:
1674 self._timer_cancelled_count -= 1
1675 handle = heapq.heappop(self._scheduled)
1676 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001677
1678 timeout = None
Guido van Rossum41f69f42015-11-19 13:28:47 -08001679 if self._ready or self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001680 timeout = 0
1681 elif self._scheduled:
1682 # Compute the desired timeout.
1683 when = self._scheduled[0]._when
Guido van Rossum3d1bc602014-05-10 15:47:15 -07001684 timeout = max(0, when - self.time())
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001685
Victor Stinner770e48d2014-07-11 11:58:33 +02001686 if self._debug and timeout != 0:
Victor Stinner22463aa2014-01-20 23:56:40 +01001687 t0 = self.time()
1688 event_list = self._selector.select(timeout)
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001689 dt = self.time() - t0
Victor Stinner770e48d2014-07-11 11:58:33 +02001690 if dt >= 1.0:
Victor Stinner22463aa2014-01-20 23:56:40 +01001691 level = logging.INFO
1692 else:
1693 level = logging.DEBUG
Victor Stinner770e48d2014-07-11 11:58:33 +02001694 nevent = len(event_list)
1695 if timeout is None:
1696 logger.log(level, 'poll took %.3f ms: %s events',
1697 dt * 1e3, nevent)
1698 elif nevent:
1699 logger.log(level,
1700 'poll %.3f ms took %.3f ms: %s events',
1701 timeout * 1e3, dt * 1e3, nevent)
1702 elif dt >= 1.0:
1703 logger.log(level,
1704 'poll %.3f ms took %.3f ms: timeout',
1705 timeout * 1e3, dt * 1e3)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001706 else:
Victor Stinner22463aa2014-01-20 23:56:40 +01001707 event_list = self._selector.select(timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001708 self._process_events(event_list)
1709
1710 # Handle 'later' callbacks that are ready.
Victor Stinnered1654f2014-02-10 23:42:32 +01001711 end_time = self.time() + self._clock_resolution
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001712 while self._scheduled:
1713 handle = self._scheduled[0]
Victor Stinnered1654f2014-02-10 23:42:32 +01001714 if handle._when >= end_time:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001715 break
1716 handle = heapq.heappop(self._scheduled)
Yury Selivanov592ada92014-09-25 12:07:56 -04001717 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001718 self._ready.append(handle)
1719
1720 # This is the only place where callbacks are actually *called*.
1721 # All other places just add them to ready.
1722 # Note: We run all currently scheduled callbacks, but not any
1723 # callbacks scheduled by callbacks run this time around --
1724 # they will be run the next time (after another I/O poll).
Victor Stinneracdb7822014-07-14 18:33:40 +02001725 # Use an idiom that is thread-safe without using locks.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001726 ntodo = len(self._ready)
1727 for i in range(ntodo):
1728 handle = self._ready.popleft()
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001729 if handle._cancelled:
1730 continue
1731 if self._debug:
Victor Stinner9b524d52015-01-26 11:05:12 +01001732 try:
1733 self._current_handle = handle
1734 t0 = self.time()
1735 handle._run()
1736 dt = self.time() - t0
1737 if dt >= self.slow_callback_duration:
1738 logger.warning('Executing %s took %.3f seconds',
1739 _format_handle(handle), dt)
1740 finally:
1741 self._current_handle = None
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001742 else:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001743 handle._run()
1744 handle = None # Needed to break cycles when an exception occurs.
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001745
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001746 def _set_coroutine_origin_tracking(self, enabled):
1747 if bool(enabled) == bool(self._coroutine_origin_tracking_enabled):
Yury Selivanove8944cb2015-05-12 11:43:04 -04001748 return
1749
Yury Selivanove8944cb2015-05-12 11:43:04 -04001750 if enabled:
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001751 self._coroutine_origin_tracking_saved_depth = (
1752 sys.get_coroutine_origin_tracking_depth())
1753 sys.set_coroutine_origin_tracking_depth(
1754 constants.DEBUG_STACK_DEPTH)
Yury Selivanove8944cb2015-05-12 11:43:04 -04001755 else:
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001756 sys.set_coroutine_origin_tracking_depth(
1757 self._coroutine_origin_tracking_saved_depth)
1758
1759 self._coroutine_origin_tracking_enabled = enabled
Yury Selivanove8944cb2015-05-12 11:43:04 -04001760
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001761 def get_debug(self):
1762 return self._debug
1763
1764 def set_debug(self, enabled):
1765 self._debug = enabled
Yury Selivanov1af2bf72015-05-11 22:27:25 -04001766
Yury Selivanove8944cb2015-05-12 11:43:04 -04001767 if self.is_running():
Nathaniel J. Smithfc2f4072018-01-21 06:44:07 -08001768 self.call_soon_threadsafe(self._set_coroutine_origin_tracking, enabled)