blob: 5597bcb7cdb0e9dfdfec8a1a21d6399d536eb31d [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
17import concurrent.futures
18import heapq
Victor Stinner0e6f52a2014-06-20 17:34:15 +020019import inspect
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 Selivanovf6d991d2016-09-15 13:10:51 -040030import weakref
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070031
Yury Selivanov2a8911c2015-08-04 15:56:33 -040032from . import compat
Victor Stinnerf951d282014-06-29 00:46:45 +020033from . import coroutines
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070034from . import events
35from . import futures
36from . import tasks
Victor Stinnerf951d282014-06-29 00:46:45 +020037from .coroutines import coroutine
Guido van Rossumfc29e0f2013-10-17 15:39:45 -070038from .log import logger
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070039
40
Victor Stinner8c1a4a22015-01-06 01:03:58 +010041__all__ = ['BaseEventLoop']
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070042
43
Yury Selivanov592ada92014-09-25 12:07:56 -040044# Minimum number of _scheduled timer handles before cleanup of
45# cancelled handles is performed.
46_MIN_SCHEDULED_TIMER_HANDLES = 100
47
48# Minimum fraction of _scheduled timer handles that are cancelled
49# before cleanup of cancelled handles is performed.
50_MIN_CANCELLED_TIMER_HANDLES_FRACTION = 0.5
Guido van Rossum27b7c7e2013-10-17 13:40:50 -070051
Victor Stinnerc94a93a2016-04-01 21:43:39 +020052# Exceptions which must not call the exception handler in fatal error
53# methods (_fatal_error())
54_FATAL_ERROR_IGNORE = (BrokenPipeError,
55 ConnectionResetError, ConnectionAbortedError)
56
57
Victor Stinner0e6f52a2014-06-20 17:34:15 +020058def _format_handle(handle):
59 cb = handle._callback
60 if inspect.ismethod(cb) and isinstance(cb.__self__, tasks.Task):
61 # format the task
62 return repr(cb.__self__)
63 else:
64 return str(handle)
65
66
Victor Stinneracdb7822014-07-14 18:33:40 +020067def _format_pipe(fd):
68 if fd == subprocess.PIPE:
69 return '<pipe>'
70 elif fd == subprocess.STDOUT:
71 return '<stdout>'
72 else:
73 return repr(fd)
74
75
Yury Selivanov5587d7c2016-09-15 15:45:07 -040076def _set_reuseport(sock):
77 if not hasattr(socket, 'SO_REUSEPORT'):
78 raise ValueError('reuse_port not supported by socket module')
79 else:
80 try:
81 sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEPORT, 1)
82 except OSError:
83 raise ValueError('reuse_port not supported by socket module, '
84 'SO_REUSEPORT defined but not implemented.')
85
86
Yury Selivanovd5c2a622015-12-16 19:31:17 -050087# Linux's sock.type is a bitmask that can include extra info about socket.
88_SOCKET_TYPE_MASK = 0
89if hasattr(socket, 'SOCK_NONBLOCK'):
90 _SOCKET_TYPE_MASK |= socket.SOCK_NONBLOCK
91if hasattr(socket, 'SOCK_CLOEXEC'):
92 _SOCKET_TYPE_MASK |= socket.SOCK_CLOEXEC
93
94
Yury Selivanovd5c2a622015-12-16 19:31:17 -050095def _ipaddr_info(host, port, family, type, proto):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -040096 # Try to skip getaddrinfo if "host" is already an IP. Users might have
97 # handled name resolution in their own code and pass in resolved IPs.
98 if not hasattr(socket, 'inet_pton'):
99 return
100
101 if proto not in {0, socket.IPPROTO_TCP, socket.IPPROTO_UDP} or \
102 host is None:
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500103 return None
104
105 type &= ~_SOCKET_TYPE_MASK
106 if type == socket.SOCK_STREAM:
107 proto = socket.IPPROTO_TCP
108 elif type == socket.SOCK_DGRAM:
109 proto = socket.IPPROTO_UDP
110 else:
111 return None
112
Yury Selivanova7146162016-06-02 16:51:07 -0400113 if port is None:
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400114 port = 0
Guido van Rossume3c65a72016-09-30 08:17:15 -0700115 elif isinstance(port, bytes) and port == b'':
116 port = 0
117 elif isinstance(port, str) and port == '':
118 port = 0
119 else:
120 # If port's a service name like "http", don't skip getaddrinfo.
121 try:
122 port = int(port)
123 except (TypeError, ValueError):
124 return None
Yury Selivanoveaaaee82016-05-20 17:44:19 -0400125
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400126 if family == socket.AF_UNSPEC:
127 afs = [socket.AF_INET, socket.AF_INET6]
128 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
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400150def _ensure_resolved(address, *, family=0, type=socket.SOCK_STREAM, proto=0,
151 flags=0, loop):
Yury Selivanovd5c2a622015-12-16 19:31:17 -0500152 host, port = address[:2]
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400153 info = _ipaddr_info(host, port, family, type, proto)
154 if info is not None:
155 # "host" is already a resolved IP.
156 fut = loop.create_future()
157 fut.set_result([info])
158 return fut
159 else:
160 return loop.getaddrinfo(host, port, family=family, type=type,
161 proto=proto, flags=flags)
Victor Stinner1b0580b2014-02-13 09:24:37 +0100162
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700163
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100164def _run_until_complete_cb(fut):
165 exc = fut._exception
166 if (isinstance(exc, BaseException)
167 and not isinstance(exc, Exception)):
168 # Issue #22429: run_forever() already finished, no need to
169 # stop it.
170 return
Guido van Rossum41f69f42015-11-19 13:28:47 -0800171 fut._loop.stop()
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100172
173
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700174class Server(events.AbstractServer):
175
176 def __init__(self, loop, sockets):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200177 self._loop = loop
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700178 self.sockets = sockets
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200179 self._active_count = 0
180 self._waiters = []
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700181
Victor Stinnere912e652014-07-12 03:11:53 +0200182 def __repr__(self):
183 return '<%s sockets=%r>' % (self.__class__.__name__, self.sockets)
184
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200185 def _attach(self):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700186 assert self.sockets is not None
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200187 self._active_count += 1
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700188
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200189 def _detach(self):
190 assert self._active_count > 0
191 self._active_count -= 1
192 if self._active_count == 0 and self.sockets is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700193 self._wakeup()
194
195 def close(self):
196 sockets = self.sockets
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200197 if sockets is None:
198 return
199 self.sockets = None
200 for sock in sockets:
201 self._loop._stop_serving(sock)
202 if self._active_count == 0:
203 self._wakeup()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700204
205 def _wakeup(self):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200206 waiters = self._waiters
207 self._waiters = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700208 for waiter in waiters:
209 if not waiter.done():
210 waiter.set_result(waiter)
211
Victor Stinnerf951d282014-06-29 00:46:45 +0200212 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700213 def wait_closed(self):
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200214 if self.sockets is None or self._waiters is None:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700215 return
Yury Selivanov7661db62016-05-16 15:38:39 -0400216 waiter = self._loop.create_future()
Victor Stinnerb28dbac2014-07-11 22:52:21 +0200217 self._waiters.append(waiter)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700218 yield from waiter
219
220
221class BaseEventLoop(events.AbstractEventLoop):
222
223 def __init__(self):
Yury Selivanov592ada92014-09-25 12:07:56 -0400224 self._timer_cancelled_count = 0
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200225 self._closed = False
Guido van Rossum41f69f42015-11-19 13:28:47 -0800226 self._stopping = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700227 self._ready = collections.deque()
228 self._scheduled = []
229 self._default_executor = None
230 self._internal_fds = 0
Victor Stinner956de692014-12-26 21:07:52 +0100231 # Identifier of the thread running the event loop, or None if the
232 # event loop is not running
Victor Stinnera87501f2015-02-05 11:45:33 +0100233 self._thread_id = None
Victor Stinnered1654f2014-02-10 23:42:32 +0100234 self._clock_resolution = time.get_clock_info('monotonic').resolution
Yury Selivanov569efa22014-02-18 18:02:19 -0500235 self._exception_handler = None
Yury Selivanov1af2bf72015-05-11 22:27:25 -0400236 self.set_debug((not sys.flags.ignore_environment
237 and bool(os.environ.get('PYTHONASYNCIODEBUG'))))
Victor Stinner0e6f52a2014-06-20 17:34:15 +0200238 # In debug mode, if the execution of a callback or a step of a task
239 # exceed this duration in seconds, the slow callback/task is logged.
240 self.slow_callback_duration = 0.1
Victor Stinner9b524d52015-01-26 11:05:12 +0100241 self._current_handle = None
Yury Selivanov740169c2015-05-11 14:23:38 -0400242 self._task_factory = None
Yury Selivanove8944cb2015-05-12 11:43:04 -0400243 self._coroutine_wrapper_set = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700244
Yury Selivanovf6d991d2016-09-15 13:10:51 -0400245 if hasattr(sys, 'get_asyncgen_hooks'):
246 # Python >= 3.6
247 # A weak set of all asynchronous generators that are
248 # being iterated by the loop.
249 self._asyncgens = weakref.WeakSet()
250 else:
251 self._asyncgens = None
252
253 # Set to True when `loop.shutdown_asyncgens` is called.
254 self._asyncgens_shutdown_called = False
255
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200256 def __repr__(self):
257 return ('<%s running=%s closed=%s debug=%s>'
258 % (self.__class__.__name__, self.is_running(),
259 self.is_closed(), self.get_debug()))
260
Yury Selivanov7661db62016-05-16 15:38:39 -0400261 def create_future(self):
262 """Create a Future object attached to the loop."""
263 return futures.Future(loop=self)
264
Victor Stinner896a25a2014-07-08 11:29:25 +0200265 def create_task(self, coro):
266 """Schedule a coroutine object.
267
Victor Stinneracdb7822014-07-14 18:33:40 +0200268 Return a task object.
269 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100270 self._check_closed()
Yury Selivanov740169c2015-05-11 14:23:38 -0400271 if self._task_factory is None:
272 task = tasks.Task(coro, loop=self)
273 if task._source_traceback:
274 del task._source_traceback[-1]
275 else:
276 task = self._task_factory(self, coro)
Victor Stinnerc39ba7d2014-07-11 00:21:27 +0200277 return task
Victor Stinner896a25a2014-07-08 11:29:25 +0200278
Yury Selivanov740169c2015-05-11 14:23:38 -0400279 def set_task_factory(self, factory):
280 """Set a task factory that will be used by loop.create_task().
281
282 If factory is None the default task factory will be set.
283
284 If factory is a callable, it should have a signature matching
285 '(loop, coro)', where 'loop' will be a reference to the active
286 event loop, 'coro' will be a coroutine object. The callable
287 must return a Future.
288 """
289 if factory is not None and not callable(factory):
290 raise TypeError('task factory must be a callable or None')
291 self._task_factory = factory
292
293 def get_task_factory(self):
294 """Return a task factory, or None if the default one is in use."""
295 return self._task_factory
296
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700297 def _make_socket_transport(self, sock, protocol, waiter=None, *,
298 extra=None, server=None):
299 """Create socket transport."""
300 raise NotImplementedError
301
Victor Stinner15cc6782015-01-09 00:09:10 +0100302 def _make_ssl_transport(self, rawsock, protocol, sslcontext, waiter=None,
303 *, server_side=False, server_hostname=None,
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700304 extra=None, server=None):
305 """Create SSL transport."""
306 raise NotImplementedError
307
308 def _make_datagram_transport(self, sock, protocol,
Victor Stinnerbfff45d2014-07-08 23:57:31 +0200309 address=None, waiter=None, extra=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700310 """Create datagram transport."""
311 raise NotImplementedError
312
313 def _make_read_pipe_transport(self, pipe, protocol, waiter=None,
314 extra=None):
315 """Create read pipe transport."""
316 raise NotImplementedError
317
318 def _make_write_pipe_transport(self, pipe, protocol, waiter=None,
319 extra=None):
320 """Create write pipe transport."""
321 raise NotImplementedError
322
Victor Stinnerf951d282014-06-29 00:46:45 +0200323 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700324 def _make_subprocess_transport(self, protocol, args, shell,
325 stdin, stdout, stderr, bufsize,
326 extra=None, **kwargs):
327 """Create subprocess transport."""
328 raise NotImplementedError
329
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700330 def _write_to_self(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200331 """Write a byte to self-pipe, to wake up the event loop.
332
333 This may be called from a different thread.
334
335 The subclass is responsible for implementing the self-pipe.
336 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700337 raise NotImplementedError
338
339 def _process_events(self, event_list):
340 """Process selector events."""
341 raise NotImplementedError
342
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200343 def _check_closed(self):
344 if self._closed:
345 raise RuntimeError('Event loop is closed')
346
Yury Selivanovf6d991d2016-09-15 13:10:51 -0400347 def _asyncgen_finalizer_hook(self, agen):
348 self._asyncgens.discard(agen)
349 if not self.is_closed():
350 self.create_task(agen.aclose())
Yury Selivanovc5420492016-11-03 15:35:23 -0700351 # Wake up the loop if the finalizer was called from
352 # a different thread.
353 self._write_to_self()
Yury Selivanovf6d991d2016-09-15 13:10:51 -0400354
355 def _asyncgen_firstiter_hook(self, agen):
356 if self._asyncgens_shutdown_called:
357 warnings.warn(
358 "asynchronous generator {!r} was scheduled after "
359 "loop.shutdown_asyncgens() call".format(agen),
360 ResourceWarning, source=self)
361
362 self._asyncgens.add(agen)
363
364 @coroutine
365 def shutdown_asyncgens(self):
366 """Shutdown all active asynchronous generators."""
367 self._asyncgens_shutdown_called = True
368
369 if self._asyncgens is None or not len(self._asyncgens):
370 # If Python version is <3.6 or we don't have any asynchronous
371 # generators alive.
372 return
373
374 closing_agens = list(self._asyncgens)
375 self._asyncgens.clear()
376
377 shutdown_coro = tasks.gather(
378 *[ag.aclose() for ag in closing_agens],
379 return_exceptions=True,
380 loop=self)
381
382 results = yield from shutdown_coro
383 for result, agen in zip(results, closing_agens):
384 if isinstance(result, Exception):
385 self.call_exception_handler({
386 'message': 'an error occurred during closing of '
387 'asynchronous generator {!r}'.format(agen),
388 'exception': result,
389 'asyncgen': agen
390 })
391
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700392 def run_forever(self):
393 """Run until stop() is called."""
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200394 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100395 if self.is_running():
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700396 raise RuntimeError('Event loop is running.')
Yury Selivanove8944cb2015-05-12 11:43:04 -0400397 self._set_coroutine_wrapper(self._debug)
Victor Stinnera87501f2015-02-05 11:45:33 +0100398 self._thread_id = threading.get_ident()
Yury Selivanovf6d991d2016-09-15 13:10:51 -0400399 if self._asyncgens is not None:
400 old_agen_hooks = sys.get_asyncgen_hooks()
401 sys.set_asyncgen_hooks(firstiter=self._asyncgen_firstiter_hook,
402 finalizer=self._asyncgen_finalizer_hook)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700403 try:
404 while True:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800405 self._run_once()
406 if self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700407 break
408 finally:
Guido van Rossum41f69f42015-11-19 13:28:47 -0800409 self._stopping = False
Victor Stinnera87501f2015-02-05 11:45:33 +0100410 self._thread_id = None
Yury Selivanove8944cb2015-05-12 11:43:04 -0400411 self._set_coroutine_wrapper(False)
Yury Selivanovf6d991d2016-09-15 13:10:51 -0400412 if self._asyncgens is not None:
413 sys.set_asyncgen_hooks(*old_agen_hooks)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700414
415 def run_until_complete(self, future):
416 """Run until the Future is done.
417
418 If the argument is a coroutine, it is wrapped in a Task.
419
Victor Stinneracdb7822014-07-14 18:33:40 +0200420 WARNING: It would be disastrous to call run_until_complete()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700421 with the same coroutine twice -- it would wrap it in two
422 different Tasks and that can't be good.
423
424 Return the Future's result, or raise its exception.
425 """
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200426 self._check_closed()
Victor Stinner98b63912014-06-30 14:51:04 +0200427
Guido van Rossum7b3b3dc2016-09-09 14:26:31 -0700428 new_task = not futures.isfuture(future)
Yury Selivanov59eb9a42015-05-11 14:48:38 -0400429 future = tasks.ensure_future(future, loop=self)
Victor Stinner98b63912014-06-30 14:51:04 +0200430 if new_task:
431 # An exception is raised if the future didn't complete, so there
432 # is no need to log the "destroy pending task" message
433 future._log_destroy_pending = False
434
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100435 future.add_done_callback(_run_until_complete_cb)
Victor Stinnerc8bd53f2014-10-11 14:30:18 +0200436 try:
437 self.run_forever()
438 except:
439 if new_task and future.done() and not future.cancelled():
440 # The coroutine raised a BaseException. Consume the exception
441 # to not log a warning, the caller doesn't have access to the
442 # local task.
443 future.exception()
444 raise
Victor Stinnerf3e2e092014-12-05 01:44:10 +0100445 future.remove_done_callback(_run_until_complete_cb)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700446 if not future.done():
447 raise RuntimeError('Event loop stopped before Future completed.')
448
449 return future.result()
450
451 def stop(self):
452 """Stop running the event loop.
453
Guido van Rossum41f69f42015-11-19 13:28:47 -0800454 Every callback already scheduled will still run. This simply informs
455 run_forever to stop looping after a complete iteration.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700456 """
Guido van Rossum41f69f42015-11-19 13:28:47 -0800457 self._stopping = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700458
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200459 def close(self):
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700460 """Close the event loop.
461
462 This clears the queues and shuts down the executor,
463 but does not wait for the executor to finish.
Victor Stinnerf328c7d2014-06-23 01:02:37 +0200464
465 The event loop must not be running.
Guido van Rossume3f52ef2013-11-01 14:19:04 -0700466 """
Victor Stinner956de692014-12-26 21:07:52 +0100467 if self.is_running():
Victor Stinneracdb7822014-07-14 18:33:40 +0200468 raise RuntimeError("Cannot close a running event loop")
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200469 if self._closed:
470 return
Victor Stinnere912e652014-07-12 03:11:53 +0200471 if self._debug:
472 logger.debug("Close %r", self)
Yury Selivanove8944cb2015-05-12 11:43:04 -0400473 self._closed = True
474 self._ready.clear()
475 self._scheduled.clear()
476 executor = self._default_executor
477 if executor is not None:
478 self._default_executor = None
479 executor.shutdown(wait=False)
Antoine Pitrou4ca73552013-10-20 00:54:10 +0200480
Victor Stinnerbb2fc5b2014-06-10 10:23:10 +0200481 def is_closed(self):
482 """Returns True if the event loop was closed."""
483 return self._closed
484
Victor Stinner978a9af2015-01-29 17:50:58 +0100485 # On Python 3.3 and older, objects with a destructor part of a reference
486 # cycle are never destroyed. It's not more the case on Python 3.4 thanks
487 # to the PEP 442.
Yury Selivanov2a8911c2015-08-04 15:56:33 -0400488 if compat.PY34:
Victor Stinner978a9af2015-01-29 17:50:58 +0100489 def __del__(self):
490 if not self.is_closed():
491 warnings.warn("unclosed event loop %r" % self, ResourceWarning)
492 if not self.is_running():
493 self.close()
494
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700495 def is_running(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200496 """Returns True if the event loop is running."""
Victor Stinnera87501f2015-02-05 11:45:33 +0100497 return (self._thread_id is not None)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700498
499 def time(self):
Victor Stinneracdb7822014-07-14 18:33:40 +0200500 """Return the time according to the event loop's clock.
501
502 This is a float expressed in seconds since an epoch, but the
503 epoch, precision, accuracy and drift are unspecified and may
504 differ per event loop.
505 """
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700506 return time.monotonic()
507
508 def call_later(self, delay, callback, *args):
509 """Arrange for a callback to be called at a given time.
510
511 Return a Handle: an opaque object with a cancel() method that
512 can be used to cancel the call.
513
514 The delay can be an int or float, expressed in seconds. It is
Victor Stinneracdb7822014-07-14 18:33:40 +0200515 always relative to the current time.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700516
517 Each callback will be called exactly once. If two callbacks
518 are scheduled for exactly the same time, it undefined which
519 will be called first.
520
521 Any positional arguments after the callback will be passed to
522 the callback when it is called.
523 """
Victor Stinner80f53aa2014-06-27 13:52:20 +0200524 timer = self.call_at(self.time() + delay, callback, *args)
525 if timer._source_traceback:
526 del timer._source_traceback[-1]
527 return timer
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700528
529 def call_at(self, when, callback, *args):
Victor Stinneracdb7822014-07-14 18:33:40 +0200530 """Like call_later(), but uses an absolute time.
531
532 Absolute time corresponds to the event loop's time() method.
533 """
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100534 self._check_closed()
Victor Stinner93569c22014-03-21 10:00:52 +0100535 if self._debug:
Victor Stinner956de692014-12-26 21:07:52 +0100536 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700537 self._check_callback(callback, 'call_at')
Yury Selivanov569efa22014-02-18 18:02:19 -0500538 timer = events.TimerHandle(when, callback, args, self)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200539 if timer._source_traceback:
540 del timer._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700541 heapq.heappush(self._scheduled, timer)
Yury Selivanov592ada92014-09-25 12:07:56 -0400542 timer._scheduled = True
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700543 return timer
544
545 def call_soon(self, callback, *args):
546 """Arrange for a callback to be called as soon as possible.
547
Victor Stinneracdb7822014-07-14 18:33:40 +0200548 This operates as a FIFO queue: callbacks are called in the
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700549 order in which they are registered. Each callback will be
550 called exactly once.
551
552 Any positional arguments after the callback will be passed to
553 the callback when it is called.
554 """
Yury Selivanov491a9122016-11-03 15:09:24 -0700555 self._check_closed()
Victor Stinner956de692014-12-26 21:07:52 +0100556 if self._debug:
557 self._check_thread()
Yury Selivanov491a9122016-11-03 15:09:24 -0700558 self._check_callback(callback, 'call_soon')
Victor Stinner956de692014-12-26 21:07:52 +0100559 handle = self._call_soon(callback, args)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200560 if handle._source_traceback:
561 del handle._source_traceback[-1]
562 return handle
Victor Stinner93569c22014-03-21 10:00:52 +0100563
Yury Selivanov491a9122016-11-03 15:09:24 -0700564 def _check_callback(self, callback, method):
565 if (coroutines.iscoroutine(callback) or
566 coroutines.iscoroutinefunction(callback)):
567 raise TypeError(
568 "coroutines cannot be used with {}()".format(method))
569 if not callable(callback):
570 raise TypeError(
571 'a callable object was expected by {}(), got {!r}'.format(
572 method, callback))
573
574
Victor Stinner956de692014-12-26 21:07:52 +0100575 def _call_soon(self, callback, args):
Yury Selivanov569efa22014-02-18 18:02:19 -0500576 handle = events.Handle(callback, args, self)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200577 if handle._source_traceback:
578 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700579 self._ready.append(handle)
580 return handle
581
Victor Stinner956de692014-12-26 21:07:52 +0100582 def _check_thread(self):
583 """Check that the current thread is the thread running the event loop.
Victor Stinner93569c22014-03-21 10:00:52 +0100584
Victor Stinneracdb7822014-07-14 18:33:40 +0200585 Non-thread-safe methods of this class make this assumption and will
Victor Stinner93569c22014-03-21 10:00:52 +0100586 likely behave incorrectly when the assumption is violated.
587
Victor Stinneracdb7822014-07-14 18:33:40 +0200588 Should only be called when (self._debug == True). The caller is
Victor Stinner93569c22014-03-21 10:00:52 +0100589 responsible for checking this condition for performance reasons.
590 """
Victor Stinnera87501f2015-02-05 11:45:33 +0100591 if self._thread_id is None:
Victor Stinner751c7c02014-06-23 15:14:13 +0200592 return
Victor Stinner956de692014-12-26 21:07:52 +0100593 thread_id = threading.get_ident()
Victor Stinnera87501f2015-02-05 11:45:33 +0100594 if thread_id != self._thread_id:
Victor Stinner93569c22014-03-21 10:00:52 +0100595 raise RuntimeError(
Victor Stinneracdb7822014-07-14 18:33:40 +0200596 "Non-thread-safe operation invoked on an event loop other "
Victor Stinner93569c22014-03-21 10:00:52 +0100597 "than the current one")
598
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700599 def call_soon_threadsafe(self, callback, *args):
Victor Stinneracdb7822014-07-14 18:33:40 +0200600 """Like call_soon(), but thread-safe."""
Yury Selivanov491a9122016-11-03 15:09:24 -0700601 self._check_closed()
602 if self._debug:
603 self._check_callback(callback, 'call_soon_threadsafe')
Victor Stinner956de692014-12-26 21:07:52 +0100604 handle = self._call_soon(callback, args)
Victor Stinner80f53aa2014-06-27 13:52:20 +0200605 if handle._source_traceback:
606 del handle._source_traceback[-1]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700607 self._write_to_self()
608 return handle
609
Yury Selivanov740169c2015-05-11 14:23:38 -0400610 def run_in_executor(self, executor, func, *args):
Victor Stinnere80bf0d2014-12-04 23:07:47 +0100611 self._check_closed()
Yury Selivanov491a9122016-11-03 15:09:24 -0700612 if self._debug:
613 self._check_callback(func, 'run_in_executor')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700614 if executor is None:
615 executor = self._default_executor
616 if executor is None:
Yury Selivanove8a60452016-10-21 17:40:42 -0400617 executor = concurrent.futures.ThreadPoolExecutor()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700618 self._default_executor = executor
Yury Selivanov740169c2015-05-11 14:23:38 -0400619 return futures.wrap_future(executor.submit(func, *args), loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700620
621 def set_default_executor(self, executor):
622 self._default_executor = executor
623
Victor Stinnere912e652014-07-12 03:11:53 +0200624 def _getaddrinfo_debug(self, host, port, family, type, proto, flags):
625 msg = ["%s:%r" % (host, port)]
626 if family:
627 msg.append('family=%r' % family)
628 if type:
629 msg.append('type=%r' % type)
630 if proto:
631 msg.append('proto=%r' % proto)
632 if flags:
633 msg.append('flags=%r' % flags)
634 msg = ', '.join(msg)
Victor Stinneracdb7822014-07-14 18:33:40 +0200635 logger.debug('Get address info %s', msg)
Victor Stinnere912e652014-07-12 03:11:53 +0200636
637 t0 = self.time()
638 addrinfo = socket.getaddrinfo(host, port, family, type, proto, flags)
639 dt = self.time() - t0
640
Victor Stinneracdb7822014-07-14 18:33:40 +0200641 msg = ('Getting address info %s took %.3f ms: %r'
Victor Stinnere912e652014-07-12 03:11:53 +0200642 % (msg, dt * 1e3, addrinfo))
643 if dt >= self.slow_callback_duration:
644 logger.info(msg)
645 else:
646 logger.debug(msg)
647 return addrinfo
648
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700649 def getaddrinfo(self, host, port, *,
650 family=0, type=0, proto=0, flags=0):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400651 if self._debug:
Victor Stinnere912e652014-07-12 03:11:53 +0200652 return self.run_in_executor(None, self._getaddrinfo_debug,
653 host, port, family, type, proto, flags)
654 else:
655 return self.run_in_executor(None, socket.getaddrinfo,
656 host, port, family, type, proto, flags)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700657
658 def getnameinfo(self, sockaddr, flags=0):
659 return self.run_in_executor(None, socket.getnameinfo, sockaddr, flags)
660
Victor Stinnerf951d282014-06-29 00:46:45 +0200661 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700662 def create_connection(self, protocol_factory, host=None, port=None, *,
663 ssl=None, family=0, proto=0, flags=0, sock=None,
Guido van Rossum21c85a72013-11-01 14:16:54 -0700664 local_addr=None, server_hostname=None):
Victor Stinnerd1432092014-06-19 17:11:49 +0200665 """Connect to a TCP server.
666
667 Create a streaming transport connection to a given Internet host and
668 port: socket family AF_INET or socket.AF_INET6 depending on host (or
669 family if specified), socket type SOCK_STREAM. protocol_factory must be
670 a callable returning a protocol instance.
671
672 This method is a coroutine which will try to establish the connection
673 in the background. When successful, the coroutine returns a
674 (transport, protocol) pair.
675 """
Guido van Rossum21c85a72013-11-01 14:16:54 -0700676 if server_hostname is not None and not ssl:
677 raise ValueError('server_hostname is only meaningful with ssl')
678
679 if server_hostname is None and ssl:
680 # Use host as default for server_hostname. It is an error
681 # if host is empty or not set, e.g. when an
682 # already-connected socket was passed or when only a port
683 # is given. To avoid this error, you can pass
684 # server_hostname='' -- this will bypass the hostname
685 # check. (This also means that if host is a numeric
686 # IP/IPv6 address, we will attempt to verify that exact
687 # address; this will probably fail, but it is possible to
688 # create a certificate for a specific IP address, so we
689 # don't judge it here.)
690 if not host:
691 raise ValueError('You must set server_hostname '
692 'when using ssl without a host')
693 server_hostname = host
Guido van Rossuma8d630a2013-11-01 14:20:55 -0700694
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700695 if host is not None or port is not None:
696 if sock is not None:
697 raise ValueError(
698 'host/port and sock can not be specified at the same time')
699
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400700 f1 = _ensure_resolved((host, port), family=family,
701 type=socket.SOCK_STREAM, proto=proto,
702 flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700703 fs = [f1]
704 if local_addr is not None:
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400705 f2 = _ensure_resolved(local_addr, family=family,
706 type=socket.SOCK_STREAM, proto=proto,
707 flags=flags, loop=self)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700708 fs.append(f2)
709 else:
710 f2 = None
711
712 yield from tasks.wait(fs, loop=self)
713
714 infos = f1.result()
715 if not infos:
716 raise OSError('getaddrinfo() returned empty list')
717 if f2 is not None:
718 laddr_infos = f2.result()
719 if not laddr_infos:
720 raise OSError('getaddrinfo() returned empty list')
721
722 exceptions = []
723 for family, type, proto, cname, address in infos:
724 try:
725 sock = socket.socket(family=family, type=type, proto=proto)
726 sock.setblocking(False)
727 if f2 is not None:
728 for _, _, _, _, laddr in laddr_infos:
729 try:
730 sock.bind(laddr)
731 break
732 except OSError as exc:
733 exc = OSError(
734 exc.errno, 'error while '
735 'attempting to bind on address '
736 '{!r}: {}'.format(
737 laddr, exc.strerror.lower()))
738 exceptions.append(exc)
739 else:
740 sock.close()
741 sock = None
742 continue
Victor Stinnere912e652014-07-12 03:11:53 +0200743 if self._debug:
744 logger.debug("connect %r to %r", sock, address)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700745 yield from self.sock_connect(sock, address)
746 except OSError as exc:
747 if sock is not None:
748 sock.close()
749 exceptions.append(exc)
Victor Stinner223a6242014-06-04 00:11:52 +0200750 except:
751 if sock is not None:
752 sock.close()
753 raise
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700754 else:
755 break
756 else:
757 if len(exceptions) == 1:
758 raise exceptions[0]
759 else:
760 # If they all have the same str(), raise one.
761 model = str(exceptions[0])
762 if all(str(exc) == model for exc in exceptions):
763 raise exceptions[0]
764 # Raise a combined exception so the user can see all
765 # the various error messages.
766 raise OSError('Multiple exceptions: {}'.format(
767 ', '.join(str(exc) for exc in exceptions)))
768
769 elif sock is None:
770 raise ValueError(
771 'host and port was not specified and no sock specified')
772
Yury Selivanovb057c522014-02-18 12:15:06 -0500773 transport, protocol = yield from self._create_connection_transport(
774 sock, protocol_factory, ssl, server_hostname)
Victor Stinnere912e652014-07-12 03:11:53 +0200775 if self._debug:
Victor Stinnerb2614752014-08-25 23:20:52 +0200776 # Get the socket from the transport because SSL transport closes
777 # the old socket and creates a new SSL socket
778 sock = transport.get_extra_info('socket')
Victor Stinneracdb7822014-07-14 18:33:40 +0200779 logger.debug("%r connected to %s:%r: (%r, %r)",
780 sock, host, port, transport, protocol)
Yury Selivanovb057c522014-02-18 12:15:06 -0500781 return transport, protocol
782
Victor Stinnerf951d282014-06-29 00:46:45 +0200783 @coroutine
Yury Selivanovb057c522014-02-18 12:15:06 -0500784 def _create_connection_transport(self, sock, protocol_factory, ssl,
Yury Selivanov252e9ed2016-07-12 18:23:10 -0400785 server_hostname, server_side=False):
786
787 sock.setblocking(False)
788
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700789 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -0400790 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700791 if ssl:
792 sslcontext = None if isinstance(ssl, bool) else ssl
793 transport = self._make_ssl_transport(
794 sock, protocol, sslcontext, waiter,
Yury Selivanov252e9ed2016-07-12 18:23:10 -0400795 server_side=server_side, server_hostname=server_hostname)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700796 else:
797 transport = self._make_socket_transport(sock, protocol, waiter)
798
Victor Stinner29ad0112015-01-15 00:04:21 +0100799 try:
800 yield from waiter
Victor Stinner0c2e4082015-01-22 00:17:41 +0100801 except:
Victor Stinner29ad0112015-01-15 00:04:21 +0100802 transport.close()
803 raise
804
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700805 return transport, protocol
806
Victor Stinnerf951d282014-06-29 00:46:45 +0200807 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700808 def create_datagram_endpoint(self, protocol_factory,
809 local_addr=None, remote_addr=None, *,
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700810 family=0, proto=0, flags=0,
811 reuse_address=None, reuse_port=None,
812 allow_broadcast=None, sock=None):
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700813 """Create datagram connection."""
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700814 if sock is not None:
815 if (local_addr or remote_addr or
816 family or proto or flags or
817 reuse_address or reuse_port or allow_broadcast):
818 # show the problematic kwargs in exception msg
819 opts = dict(local_addr=local_addr, remote_addr=remote_addr,
820 family=family, proto=proto, flags=flags,
821 reuse_address=reuse_address, reuse_port=reuse_port,
822 allow_broadcast=allow_broadcast)
823 problems = ', '.join(
824 '{}={}'.format(k, v) for k, v in opts.items() if v)
825 raise ValueError(
826 'socket modifier keyword arguments can not be used '
827 'when sock is specified. ({})'.format(problems))
828 sock.setblocking(False)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700829 r_addr = None
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700830 else:
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700831 if not (local_addr or remote_addr):
832 if family == 0:
833 raise ValueError('unexpected address family')
834 addr_pairs_info = (((family, proto), (None, None)),)
835 else:
836 # join address by (family, protocol)
837 addr_infos = collections.OrderedDict()
838 for idx, addr in ((0, local_addr), (1, remote_addr)):
839 if addr is not None:
840 assert isinstance(addr, tuple) and len(addr) == 2, (
841 '2-tuple is expected')
842
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400843 infos = yield from _ensure_resolved(
844 addr, family=family, type=socket.SOCK_DGRAM,
845 proto=proto, flags=flags, loop=self)
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700846 if not infos:
847 raise OSError('getaddrinfo() returned empty list')
848
849 for fam, _, pro, _, address in infos:
850 key = (fam, pro)
851 if key not in addr_infos:
852 addr_infos[key] = [None, None]
853 addr_infos[key][idx] = address
854
855 # each addr has to have info for each (family, proto) pair
856 addr_pairs_info = [
857 (key, addr_pair) for key, addr_pair in addr_infos.items()
858 if not ((local_addr and addr_pair[0] is None) or
859 (remote_addr and addr_pair[1] is None))]
860
861 if not addr_pairs_info:
862 raise ValueError('can not get address information')
863
864 exceptions = []
865
866 if reuse_address is None:
867 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
868
869 for ((family, proto),
870 (local_address, remote_address)) in addr_pairs_info:
871 sock = None
872 r_addr = None
873 try:
874 sock = socket.socket(
875 family=family, type=socket.SOCK_DGRAM, proto=proto)
876 if reuse_address:
877 sock.setsockopt(
878 socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
879 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -0400880 _set_reuseport(sock)
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700881 if allow_broadcast:
882 sock.setsockopt(
883 socket.SOL_SOCKET, socket.SO_BROADCAST, 1)
884 sock.setblocking(False)
885
886 if local_addr:
887 sock.bind(local_address)
888 if remote_addr:
889 yield from self.sock_connect(sock, remote_address)
890 r_addr = remote_address
891 except OSError as exc:
892 if sock is not None:
893 sock.close()
894 exceptions.append(exc)
895 except:
896 if sock is not None:
897 sock.close()
898 raise
899 else:
900 break
901 else:
902 raise exceptions[0]
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700903
904 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -0400905 waiter = self.create_future()
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700906 transport = self._make_datagram_transport(
907 sock, protocol, r_addr, waiter)
Victor Stinnere912e652014-07-12 03:11:53 +0200908 if self._debug:
909 if local_addr:
910 logger.info("Datagram endpoint local_addr=%r remote_addr=%r "
911 "created: (%r, %r)",
912 local_addr, remote_addr, transport, protocol)
913 else:
914 logger.debug("Datagram endpoint remote_addr=%r created: "
915 "(%r, %r)",
916 remote_addr, transport, protocol)
Victor Stinner2596dd02015-01-26 11:02:18 +0100917
918 try:
919 yield from waiter
920 except:
921 transport.close()
922 raise
923
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700924 return transport, protocol
925
Victor Stinnerf951d282014-06-29 00:46:45 +0200926 @coroutine
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200927 def _create_server_getaddrinfo(self, host, port, family, flags):
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400928 infos = yield from _ensure_resolved((host, port), family=family,
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200929 type=socket.SOCK_STREAM,
Yury Selivanovf1c6fa92016-06-08 12:33:31 -0400930 flags=flags, loop=self)
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200931 if not infos:
932 raise OSError('getaddrinfo({!r}) returned empty list'.format(host))
933 return infos
934
935 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700936 def create_server(self, protocol_factory, host=None, port=None,
937 *,
938 family=socket.AF_UNSPEC,
939 flags=socket.AI_PASSIVE,
940 sock=None,
941 backlog=100,
942 ssl=None,
Guido van Rossumb9bf9132015-10-05 09:15:28 -0700943 reuse_address=None,
944 reuse_port=None):
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200945 """Create a TCP server.
946
947 The host parameter can be a string, in that case the TCP server is bound
948 to host and port.
949
950 The host parameter can also be a sequence of strings and in that case
Yury Selivanove076ffb2016-03-02 11:17:01 -0500951 the TCP server is bound to all hosts of the sequence. If a host
952 appears multiple times (possibly indirectly e.g. when hostnames
953 resolve to the same IP address), the server is only bound once to that
954 host.
Victor Stinnerd1432092014-06-19 17:11:49 +0200955
Victor Stinneracdb7822014-07-14 18:33:40 +0200956 Return a Server object which can be used to stop the service.
Victor Stinnerd1432092014-06-19 17:11:49 +0200957
958 This method is a coroutine.
959 """
Guido van Rossum28dff0d2013-11-01 14:22:30 -0700960 if isinstance(ssl, bool):
961 raise TypeError('ssl argument must be an SSLContext or None')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700962 if host is not None or port is not None:
963 if sock is not None:
964 raise ValueError(
965 'host/port and sock can not be specified at the same time')
966
967 AF_INET6 = getattr(socket, 'AF_INET6', 0)
968 if reuse_address is None:
969 reuse_address = os.name == 'posix' and sys.platform != 'cygwin'
970 sockets = []
971 if host == '':
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200972 hosts = [None]
973 elif (isinstance(host, str) or
974 not isinstance(host, collections.Iterable)):
975 hosts = [host]
976 else:
977 hosts = host
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700978
Victor Stinner5e4a7d82015-09-21 18:33:43 +0200979 fs = [self._create_server_getaddrinfo(host, port, family=family,
980 flags=flags)
981 for host in hosts]
982 infos = yield from tasks.gather(*fs, loop=self)
Yury Selivanove076ffb2016-03-02 11:17:01 -0500983 infos = set(itertools.chain.from_iterable(infos))
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700984
985 completed = False
986 try:
987 for res in infos:
988 af, socktype, proto, canonname, sa = res
Guido van Rossum32e46852013-10-19 17:04:25 -0700989 try:
990 sock = socket.socket(af, socktype, proto)
991 except socket.error:
992 # Assume it's a bad family/type/protocol combination.
Victor Stinnerb2614752014-08-25 23:20:52 +0200993 if self._debug:
994 logger.warning('create_server() failed to create '
995 'socket.socket(%r, %r, %r)',
996 af, socktype, proto, exc_info=True)
Guido van Rossum32e46852013-10-19 17:04:25 -0700997 continue
Guido van Rossum27b7c7e2013-10-17 13:40:50 -0700998 sockets.append(sock)
999 if reuse_address:
Guido van Rossumb9bf9132015-10-05 09:15:28 -07001000 sock.setsockopt(
1001 socket.SOL_SOCKET, socket.SO_REUSEADDR, True)
1002 if reuse_port:
Yury Selivanov5587d7c2016-09-15 15:45:07 -04001003 _set_reuseport(sock)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001004 # Disable IPv4/IPv6 dual stack support (enabled by
1005 # default on Linux) which makes a single socket
1006 # listen on both address families.
1007 if af == AF_INET6 and hasattr(socket, 'IPPROTO_IPV6'):
1008 sock.setsockopt(socket.IPPROTO_IPV6,
1009 socket.IPV6_V6ONLY,
1010 True)
1011 try:
1012 sock.bind(sa)
1013 except OSError as err:
1014 raise OSError(err.errno, 'error while attempting '
1015 'to bind on address %r: %s'
1016 % (sa, err.strerror.lower()))
1017 completed = True
1018 finally:
1019 if not completed:
1020 for sock in sockets:
1021 sock.close()
1022 else:
1023 if sock is None:
Victor Stinneracdb7822014-07-14 18:33:40 +02001024 raise ValueError('Neither host/port nor sock were specified')
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001025 sockets = [sock]
1026
1027 server = Server(self, sockets)
1028 for sock in sockets:
1029 sock.listen(backlog)
1030 sock.setblocking(False)
Yury Selivanova1b0e7d2016-09-15 14:13:15 -04001031 self._start_serving(protocol_factory, sock, ssl, server, backlog)
Victor Stinnere912e652014-07-12 03:11:53 +02001032 if self._debug:
1033 logger.info("%r is serving", server)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001034 return server
1035
Victor Stinnerf951d282014-06-29 00:46:45 +02001036 @coroutine
Yury Selivanov252e9ed2016-07-12 18:23:10 -04001037 def connect_accepted_socket(self, protocol_factory, sock, *, ssl=None):
1038 """Handle an accepted connection.
1039
1040 This is used by servers that accept connections outside of
1041 asyncio but that use asyncio to handle connections.
1042
1043 This method is a coroutine. When completed, the coroutine
1044 returns a (transport, protocol) pair.
1045 """
1046 transport, protocol = yield from self._create_connection_transport(
1047 sock, protocol_factory, ssl, '', server_side=True)
1048 if self._debug:
1049 # Get the socket from the transport because SSL transport closes
1050 # the old socket and creates a new SSL socket
1051 sock = transport.get_extra_info('socket')
1052 logger.debug("%r handled: (%r, %r)", sock, transport, protocol)
1053 return transport, protocol
1054
1055 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001056 def connect_read_pipe(self, protocol_factory, pipe):
1057 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001058 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001059 transport = self._make_read_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001060
1061 try:
1062 yield from waiter
1063 except:
1064 transport.close()
1065 raise
1066
Victor Stinneracdb7822014-07-14 18:33:40 +02001067 if self._debug:
1068 logger.debug('Read pipe %r connected: (%r, %r)',
1069 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001070 return transport, protocol
1071
Victor Stinnerf951d282014-06-29 00:46:45 +02001072 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001073 def connect_write_pipe(self, protocol_factory, pipe):
1074 protocol = protocol_factory()
Yury Selivanov7661db62016-05-16 15:38:39 -04001075 waiter = self.create_future()
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001076 transport = self._make_write_pipe_transport(pipe, protocol, waiter)
Victor Stinner2596dd02015-01-26 11:02:18 +01001077
1078 try:
1079 yield from waiter
1080 except:
1081 transport.close()
1082 raise
1083
Victor Stinneracdb7822014-07-14 18:33:40 +02001084 if self._debug:
1085 logger.debug('Write pipe %r connected: (%r, %r)',
1086 pipe.fileno(), transport, protocol)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001087 return transport, protocol
1088
Victor Stinneracdb7822014-07-14 18:33:40 +02001089 def _log_subprocess(self, msg, stdin, stdout, stderr):
1090 info = [msg]
1091 if stdin is not None:
1092 info.append('stdin=%s' % _format_pipe(stdin))
1093 if stdout is not None and stderr == subprocess.STDOUT:
1094 info.append('stdout=stderr=%s' % _format_pipe(stdout))
1095 else:
1096 if stdout is not None:
1097 info.append('stdout=%s' % _format_pipe(stdout))
1098 if stderr is not None:
1099 info.append('stderr=%s' % _format_pipe(stderr))
1100 logger.debug(' '.join(info))
1101
Victor Stinnerf951d282014-06-29 00:46:45 +02001102 @coroutine
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001103 def subprocess_shell(self, protocol_factory, cmd, *, stdin=subprocess.PIPE,
1104 stdout=subprocess.PIPE, stderr=subprocess.PIPE,
1105 universal_newlines=False, shell=True, bufsize=0,
1106 **kwargs):
Victor Stinner20e07432014-02-11 11:44:56 +01001107 if not isinstance(cmd, (bytes, str)):
Victor Stinnere623a122014-01-29 14:35:15 -08001108 raise ValueError("cmd must be a string")
1109 if universal_newlines:
1110 raise ValueError("universal_newlines must be False")
1111 if not shell:
Victor Stinner323748e2014-01-31 12:28:30 +01001112 raise ValueError("shell must be True")
Victor Stinnere623a122014-01-29 14:35:15 -08001113 if bufsize != 0:
1114 raise ValueError("bufsize must be 0")
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001115 protocol = protocol_factory()
Victor Stinneracdb7822014-07-14 18:33:40 +02001116 if self._debug:
1117 # don't log parameters: they may contain sensitive information
1118 # (password) and may be too long
1119 debug_log = 'run shell command %r' % cmd
1120 self._log_subprocess(debug_log, stdin, stdout, stderr)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001121 transport = yield from self._make_subprocess_transport(
1122 protocol, cmd, True, stdin, stdout, stderr, bufsize, **kwargs)
Victor Stinneracdb7822014-07-14 18:33:40 +02001123 if self._debug:
Yury Selivanov4357cf62016-09-15 13:49:08 -04001124 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001125 return transport, protocol
1126
Victor Stinnerf951d282014-06-29 00:46:45 +02001127 @coroutine
Yury Selivanov57797522014-02-18 22:56:15 -05001128 def subprocess_exec(self, protocol_factory, program, *args,
1129 stdin=subprocess.PIPE, stdout=subprocess.PIPE,
1130 stderr=subprocess.PIPE, universal_newlines=False,
1131 shell=False, bufsize=0, **kwargs):
Victor Stinnere623a122014-01-29 14:35:15 -08001132 if universal_newlines:
1133 raise ValueError("universal_newlines must be False")
1134 if shell:
1135 raise ValueError("shell must be False")
1136 if bufsize != 0:
1137 raise ValueError("bufsize must be 0")
Victor Stinner20e07432014-02-11 11:44:56 +01001138 popen_args = (program,) + args
1139 for arg in popen_args:
1140 if not isinstance(arg, (str, bytes)):
1141 raise TypeError("program arguments must be "
1142 "a bytes or text string, not %s"
1143 % type(arg).__name__)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001144 protocol = protocol_factory()
Victor Stinneracdb7822014-07-14 18:33:40 +02001145 if self._debug:
1146 # don't log parameters: they may contain sensitive information
1147 # (password) and may be too long
1148 debug_log = 'execute program %r' % program
1149 self._log_subprocess(debug_log, stdin, stdout, stderr)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001150 transport = yield from self._make_subprocess_transport(
Yury Selivanov57797522014-02-18 22:56:15 -05001151 protocol, popen_args, False, stdin, stdout, stderr,
1152 bufsize, **kwargs)
Victor Stinneracdb7822014-07-14 18:33:40 +02001153 if self._debug:
Yury Selivanov4357cf62016-09-15 13:49:08 -04001154 logger.info('%s: %r', debug_log, transport)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001155 return transport, protocol
1156
Yury Selivanov7ed7ce62016-05-16 15:20:38 -04001157 def get_exception_handler(self):
1158 """Return an exception handler, or None if the default one is in use.
1159 """
1160 return self._exception_handler
1161
Yury Selivanov569efa22014-02-18 18:02:19 -05001162 def set_exception_handler(self, handler):
1163 """Set handler as the new event loop exception handler.
1164
1165 If handler is None, the default exception handler will
1166 be set.
1167
1168 If handler is a callable object, it should have a
Victor Stinneracdb7822014-07-14 18:33:40 +02001169 signature matching '(loop, context)', where 'loop'
Yury Selivanov569efa22014-02-18 18:02:19 -05001170 will be a reference to the active event loop, 'context'
1171 will be a dict object (see `call_exception_handler()`
1172 documentation for details about context).
1173 """
1174 if handler is not None and not callable(handler):
1175 raise TypeError('A callable object or None is expected, '
1176 'got {!r}'.format(handler))
1177 self._exception_handler = handler
1178
1179 def default_exception_handler(self, context):
1180 """Default exception handler.
1181
1182 This is called when an exception occurs and no exception
1183 handler is set, and can be called by a custom exception
1184 handler that wants to defer to the default behavior.
1185
Victor Stinneracdb7822014-07-14 18:33:40 +02001186 The context parameter has the same meaning as in
Yury Selivanov569efa22014-02-18 18:02:19 -05001187 `call_exception_handler()`.
1188 """
1189 message = context.get('message')
1190 if not message:
1191 message = 'Unhandled exception in event loop'
1192
1193 exception = context.get('exception')
1194 if exception is not None:
1195 exc_info = (type(exception), exception, exception.__traceback__)
1196 else:
1197 exc_info = False
1198
Victor Stinnerff018e42015-01-28 00:30:40 +01001199 if ('source_traceback' not in context
1200 and self._current_handle is not None
Victor Stinner9b524d52015-01-26 11:05:12 +01001201 and self._current_handle._source_traceback):
1202 context['handle_traceback'] = self._current_handle._source_traceback
1203
Yury Selivanov569efa22014-02-18 18:02:19 -05001204 log_lines = [message]
1205 for key in sorted(context):
1206 if key in {'message', 'exception'}:
1207 continue
Victor Stinner80f53aa2014-06-27 13:52:20 +02001208 value = context[key]
1209 if key == 'source_traceback':
1210 tb = ''.join(traceback.format_list(value))
1211 value = 'Object created at (most recent call last):\n'
1212 value += tb.rstrip()
Victor Stinner9b524d52015-01-26 11:05:12 +01001213 elif key == 'handle_traceback':
1214 tb = ''.join(traceback.format_list(value))
1215 value = 'Handle created at (most recent call last):\n'
1216 value += tb.rstrip()
Victor Stinner80f53aa2014-06-27 13:52:20 +02001217 else:
1218 value = repr(value)
1219 log_lines.append('{}: {}'.format(key, value))
Yury Selivanov569efa22014-02-18 18:02:19 -05001220
1221 logger.error('\n'.join(log_lines), exc_info=exc_info)
1222
1223 def call_exception_handler(self, context):
Victor Stinneracdb7822014-07-14 18:33:40 +02001224 """Call the current event loop's exception handler.
Yury Selivanov569efa22014-02-18 18:02:19 -05001225
Victor Stinneracdb7822014-07-14 18:33:40 +02001226 The context argument is a dict containing the following keys:
1227
Yury Selivanov569efa22014-02-18 18:02:19 -05001228 - 'message': Error message;
1229 - 'exception' (optional): Exception object;
1230 - 'future' (optional): Future instance;
1231 - 'handle' (optional): Handle instance;
1232 - 'protocol' (optional): Protocol instance;
1233 - 'transport' (optional): Transport instance;
Yury Selivanov4357cf62016-09-15 13:49:08 -04001234 - 'socket' (optional): Socket instance;
1235 - 'asyncgen' (optional): Asynchronous generator that caused
1236 the exception.
Yury Selivanov569efa22014-02-18 18:02:19 -05001237
Victor Stinneracdb7822014-07-14 18:33:40 +02001238 New keys maybe introduced in the future.
1239
1240 Note: do not overload this method in an event loop subclass.
1241 For custom exception handling, use the
Yury Selivanov569efa22014-02-18 18:02:19 -05001242 `set_exception_handler()` method.
1243 """
1244 if self._exception_handler is None:
1245 try:
1246 self.default_exception_handler(context)
1247 except Exception:
1248 # Second protection layer for unexpected errors
1249 # in the default implementation, as well as for subclassed
1250 # event loops with overloaded "default_exception_handler".
1251 logger.error('Exception in default exception handler',
1252 exc_info=True)
1253 else:
1254 try:
1255 self._exception_handler(self, context)
1256 except Exception as exc:
1257 # Exception in the user set custom exception handler.
1258 try:
1259 # Let's try default handler.
1260 self.default_exception_handler({
1261 'message': 'Unhandled error in exception handler',
1262 'exception': exc,
1263 'context': context,
1264 })
1265 except Exception:
Victor Stinneracdb7822014-07-14 18:33:40 +02001266 # Guard 'default_exception_handler' in case it is
Yury Selivanov569efa22014-02-18 18:02:19 -05001267 # overloaded.
1268 logger.error('Exception in default exception handler '
1269 'while handling an unexpected error '
1270 'in custom exception handler',
1271 exc_info=True)
1272
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001273 def _add_callback(self, handle):
Victor Stinneracdb7822014-07-14 18:33:40 +02001274 """Add a Handle to _scheduled (TimerHandle) or _ready."""
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001275 assert isinstance(handle, events.Handle), 'A Handle is required here'
1276 if handle._cancelled:
1277 return
Yury Selivanov592ada92014-09-25 12:07:56 -04001278 assert not isinstance(handle, events.TimerHandle)
1279 self._ready.append(handle)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001280
1281 def _add_callback_signalsafe(self, handle):
1282 """Like _add_callback() but called from a signal handler."""
1283 self._add_callback(handle)
1284 self._write_to_self()
1285
Yury Selivanov592ada92014-09-25 12:07:56 -04001286 def _timer_handle_cancelled(self, handle):
1287 """Notification that a TimerHandle has been cancelled."""
1288 if handle._scheduled:
1289 self._timer_cancelled_count += 1
1290
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001291 def _run_once(self):
1292 """Run one full iteration of the event loop.
1293
1294 This calls all currently ready callbacks, polls for I/O,
1295 schedules the resulting callbacks, and finally schedules
1296 'call_later' callbacks.
1297 """
Yury Selivanov592ada92014-09-25 12:07:56 -04001298
Yury Selivanov592ada92014-09-25 12:07:56 -04001299 sched_count = len(self._scheduled)
1300 if (sched_count > _MIN_SCHEDULED_TIMER_HANDLES and
1301 self._timer_cancelled_count / sched_count >
1302 _MIN_CANCELLED_TIMER_HANDLES_FRACTION):
Victor Stinner68da8fc2014-09-30 18:08:36 +02001303 # Remove delayed calls that were cancelled if their number
1304 # is too high
1305 new_scheduled = []
Yury Selivanov592ada92014-09-25 12:07:56 -04001306 for handle in self._scheduled:
1307 if handle._cancelled:
1308 handle._scheduled = False
Victor Stinner68da8fc2014-09-30 18:08:36 +02001309 else:
1310 new_scheduled.append(handle)
Yury Selivanov592ada92014-09-25 12:07:56 -04001311
Victor Stinner68da8fc2014-09-30 18:08:36 +02001312 heapq.heapify(new_scheduled)
1313 self._scheduled = new_scheduled
Yury Selivanov592ada92014-09-25 12:07:56 -04001314 self._timer_cancelled_count = 0
Yury Selivanov592ada92014-09-25 12:07:56 -04001315 else:
1316 # Remove delayed calls that were cancelled from head of queue.
1317 while self._scheduled and self._scheduled[0]._cancelled:
1318 self._timer_cancelled_count -= 1
1319 handle = heapq.heappop(self._scheduled)
1320 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001321
1322 timeout = None
Guido van Rossum41f69f42015-11-19 13:28:47 -08001323 if self._ready or self._stopping:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001324 timeout = 0
1325 elif self._scheduled:
1326 # Compute the desired timeout.
1327 when = self._scheduled[0]._when
Guido van Rossum3d1bc602014-05-10 15:47:15 -07001328 timeout = max(0, when - self.time())
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001329
Victor Stinner770e48d2014-07-11 11:58:33 +02001330 if self._debug and timeout != 0:
Victor Stinner22463aa2014-01-20 23:56:40 +01001331 t0 = self.time()
1332 event_list = self._selector.select(timeout)
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001333 dt = self.time() - t0
Victor Stinner770e48d2014-07-11 11:58:33 +02001334 if dt >= 1.0:
Victor Stinner22463aa2014-01-20 23:56:40 +01001335 level = logging.INFO
1336 else:
1337 level = logging.DEBUG
Victor Stinner770e48d2014-07-11 11:58:33 +02001338 nevent = len(event_list)
1339 if timeout is None:
1340 logger.log(level, 'poll took %.3f ms: %s events',
1341 dt * 1e3, nevent)
1342 elif nevent:
1343 logger.log(level,
1344 'poll %.3f ms took %.3f ms: %s events',
1345 timeout * 1e3, dt * 1e3, nevent)
1346 elif dt >= 1.0:
1347 logger.log(level,
1348 'poll %.3f ms took %.3f ms: timeout',
1349 timeout * 1e3, dt * 1e3)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001350 else:
Victor Stinner22463aa2014-01-20 23:56:40 +01001351 event_list = self._selector.select(timeout)
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001352 self._process_events(event_list)
1353
1354 # Handle 'later' callbacks that are ready.
Victor Stinnered1654f2014-02-10 23:42:32 +01001355 end_time = self.time() + self._clock_resolution
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001356 while self._scheduled:
1357 handle = self._scheduled[0]
Victor Stinnered1654f2014-02-10 23:42:32 +01001358 if handle._when >= end_time:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001359 break
1360 handle = heapq.heappop(self._scheduled)
Yury Selivanov592ada92014-09-25 12:07:56 -04001361 handle._scheduled = False
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001362 self._ready.append(handle)
1363
1364 # This is the only place where callbacks are actually *called*.
1365 # All other places just add them to ready.
1366 # Note: We run all currently scheduled callbacks, but not any
1367 # callbacks scheduled by callbacks run this time around --
1368 # they will be run the next time (after another I/O poll).
Victor Stinneracdb7822014-07-14 18:33:40 +02001369 # Use an idiom that is thread-safe without using locks.
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001370 ntodo = len(self._ready)
1371 for i in range(ntodo):
1372 handle = self._ready.popleft()
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001373 if handle._cancelled:
1374 continue
1375 if self._debug:
Victor Stinner9b524d52015-01-26 11:05:12 +01001376 try:
1377 self._current_handle = handle
1378 t0 = self.time()
1379 handle._run()
1380 dt = self.time() - t0
1381 if dt >= self.slow_callback_duration:
1382 logger.warning('Executing %s took %.3f seconds',
1383 _format_handle(handle), dt)
1384 finally:
1385 self._current_handle = None
Victor Stinner0e6f52a2014-06-20 17:34:15 +02001386 else:
Guido van Rossum27b7c7e2013-10-17 13:40:50 -07001387 handle._run()
1388 handle = None # Needed to break cycles when an exception occurs.
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001389
Yury Selivanove8944cb2015-05-12 11:43:04 -04001390 def _set_coroutine_wrapper(self, enabled):
1391 try:
1392 set_wrapper = sys.set_coroutine_wrapper
1393 get_wrapper = sys.get_coroutine_wrapper
1394 except AttributeError:
1395 return
1396
1397 enabled = bool(enabled)
Yury Selivanov996083d2015-08-04 15:37:24 -04001398 if self._coroutine_wrapper_set == enabled:
Yury Selivanove8944cb2015-05-12 11:43:04 -04001399 return
1400
1401 wrapper = coroutines.debug_wrapper
1402 current_wrapper = get_wrapper()
1403
1404 if enabled:
1405 if current_wrapper not in (None, wrapper):
1406 warnings.warn(
1407 "loop.set_debug(True): cannot set debug coroutine "
1408 "wrapper; another wrapper is already set %r" %
1409 current_wrapper, RuntimeWarning)
1410 else:
1411 set_wrapper(wrapper)
1412 self._coroutine_wrapper_set = True
1413 else:
1414 if current_wrapper not in (None, wrapper):
1415 warnings.warn(
1416 "loop.set_debug(False): cannot unset debug coroutine "
1417 "wrapper; another wrapper was set %r" %
1418 current_wrapper, RuntimeWarning)
1419 else:
1420 set_wrapper(None)
1421 self._coroutine_wrapper_set = False
1422
Victor Stinner0f3e6bc2014-02-19 23:15:02 +01001423 def get_debug(self):
1424 return self._debug
1425
1426 def set_debug(self, enabled):
1427 self._debug = enabled
Yury Selivanov1af2bf72015-05-11 22:27:25 -04001428
Yury Selivanove8944cb2015-05-12 11:43:04 -04001429 if self.is_running():
1430 self._set_coroutine_wrapper(enabled)