B he@sHdZddlZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl mZmZmZmZmZddlmZddlmZmZmZddlZddlmZmZmZmZmZmZm Z m!Z!ej"rddlm#Z#m$Z$ddl%m&Z&ne'Z&Gd d d e&Z(ed Z)ed e(d Z*GdddeZ+Gddde'Z,Gddde'Z-dS)aAn I/O event loop for non-blocking sockets. In Tornado 6.0, `.IOLoop` is a wrapper around the `asyncio` event loop, with a slightly different interface for historical reasons. Applications can use either the `.IOLoop` interface or the underlying `asyncio` event loop directly (unless compatibility with older versions of Tornado is desired, in which case `.IOLoop` must be used). Typical applications will use a single `IOLoop` object, accessed via `IOLoop.current` class method. The `IOLoop.start` method (or equivalently, `asyncio.AbstractEventLoop.run_forever`) should usually be called at the end of the ``main()`` function. Atypical applications may use more than one `IOLoop`, such as one `IOLoop` per thread, or per `unittest` case. N)Future is_future chain_futurefuture_set_exc_infofuture_add_done_callback)app_log) Configurable TimeoutError import_object)UnionAnyTypeOptionalCallableTypeVarTuple Awaitable)DictList)Protocolc@s(eZdZedddZddddZdS) _Selectable)returncCsdS)N)selfrrKC:\Users\sanjo\AppData\Local\Qlobot\Launcher\ext_packages\tornado\ioloop.pyfilenoCsz_Selectable.filenoNcCsdS)Nr)rrrrcloseFsz_Selectable.close)__name__ __module__ __qualname__intrrrrrrrBsr_T_S)boundcseZdZdZdZdZdZdZeZ e de ddfd d Z e dd d d Zdd ddZe dd ddZeje dd ddZeje dieeddddZe djeeddddZdd ddZe dd ddZdd ddZe eed ddZe eed d d!Zdkedd"d#d$Zdledd&d'd(Zejee eegdfedd)d*d+Z!eje"e e"egdfedd)d,d+Z!e#ee$fe d-edd)d.d+Z!e#ee$fedd/d0d1Z%e#ee$fdd2d3d4Z&dd d5d6Z'dd d7d8Z(dd d9d:Z)dme e*e d;dd?Z,e#e*e-j.fe d-e e e/d@dAdBZ0e*e d-e e e/dCdDdEZ1e*e d-e e e/dFdGdHZ2e/ddIdJdKZ3e e e ddLdMdNZ4e e e ddLdOdPZ5e e e ddLdQdRZ6dSe dTgdfddUdVdWZ7ee8j9j:e dXe;fe ee ge fdd_d`daZ?e@ddbdcddZAe#ee$feBee#ee$ffd2dedfZCe#ee$fdd2dgdhZDZES)nIOLoopa An I/O event loop. As of Tornado 6.0, `IOLoop` is a wrapper around the `asyncio` event loop. Example usage for a simple TCP server: .. testcode:: import errno import functools import socket import tornado.ioloop from tornado.iostream import IOStream async def handle_connection(connection, address): stream = IOStream(connection) message = await stream.read_until_close() print("message from client:", message.decode().strip()) def connection_ready(sock, fd, events): while True: try: connection, address = sock.accept() except socket.error as e: if e.args[0] not in (errno.EWOULDBLOCK, errno.EAGAIN): raise return connection.setblocking(0) io_loop = tornado.ioloop.IOLoop.current() io_loop.spawn_callback(handle_connection, connection, address) if __name__ == '__main__': sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM, 0) sock.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) sock.setblocking(0) sock.bind(("", 8888)) sock.listen(128) io_loop = tornado.ioloop.IOLoop.current() callback = functools.partial(connection_ready, sock) io_loop.add_handler(sock.fileno(), callback, io_loop.READ) io_loop.start() .. testoutput:: :hide: By default, a newly-constructed `IOLoop` becomes the thread's current `IOLoop`, unless there already is a current `IOLoop`. This behavior can be controlled with the ``make_current`` argument to the `IOLoop` constructor: if ``make_current=True``, the new `IOLoop` will always try to become current and it raises an error if there is already a current instance. If ``make_current=False``, the new `IOLoop` will not try to become current. In general, an `IOLoop` cannot survive a fork or be shared across processes in any way. When multiple processes are being used, each process should create its own `IOLoop`, which also implies that any objects which depend on the `IOLoop` (such as `.AsyncHTTPClient`) must also be created in the child processes. As a guideline, anything that starts processes (including the `tornado.process` and `multiprocessing` modules) should do so as early as possible, ideally the first thing the application does after loading its configuration in ``main()``. .. versionchanged:: 4.2 Added the ``make_current`` keyword argument to the `IOLoop` constructor. .. versionchanged:: 5.0 Uses the `asyncio` event loop by default. The ``IOLoop.configure`` method cannot be used on Python 3 except to redundantly specify the `asyncio` event loop. rz$Union[None, str, Type[Configurable]]N)implkwargsrc sZtdk rBddlm}t|tr&t|}t|trBt||sBtdt t |j |f|dS)Nr)BaseAsyncIOLoopz5only AsyncIOLoop is allowed when asyncio is available) asynciotornado.platform.asyncior* isinstancestrr type issubclass RuntimeErrorsuperr$ configure)clsr(r)r*) __class__rrr3s  zIOLoop.configure)rcCstS)aKDeprecated alias for `IOLoop.current()`. .. versionchanged:: 5.0 Previously, this method returned a global singleton `IOLoop`, in contrast with the per-thread `IOLoop` returned by `current()`. In nearly all cases the two were the same (when they differed, it was generally used from non-Tornado threads to communicate back to the main thread's `IOLoop`). This distinction is not present in `asyncio`, so in order to facilitate integration with that package `instance()` was changed to be an alias to `current()`. Applications using the cross-thread communications aspect of `instance()` should instead set their own global variable to point to the `IOLoop` they want to use. .. deprecated:: 5.0 )r$currentrrrrinstanceszIOLoop.instancecCs |dS)a`Deprecated alias for `make_current()`. .. versionchanged:: 5.0 Previously, this method would set this `IOLoop` as the global singleton used by `IOLoop.instance()`. Now that `instance()` is an alias for `current()`, `install()` is an alias for `make_current()`. .. deprecated:: 5.0 N) make_current)rrrrinstalls zIOLoop.installcCs tdS)akDeprecated alias for `clear_current()`. .. versionchanged:: 5.0 Previously, this method would clear the `IOLoop` used as the global singleton by `IOLoop.instance()`. Now that `instance()` is an alias for `current()`, `clear_instance()` is an alias for `clear_current()`. .. deprecated:: 5.0 N)r$ clear_currentrrrrclear_instanceszIOLoop.clear_instancecCsdS)Nrrrrrr6szIOLoop.currentT)r7rcCsdS)Nr)r7rrrr6sc Csty t}Wn"ttfk r.|s(dSYnXy tj|Stk rn|rfddlm}|dd}nd}YnX|S)aReturns the current thread's `IOLoop`. If an `IOLoop` is currently running or has been marked as current by `make_current`, returns that instance. If there is no current `IOLoop` and ``instance`` is true, creates one. .. versionchanged:: 4.1 Added ``instance`` argument to control the fallback to `IOLoop.instance()`. .. versionchanged:: 5.0 On Python 3, control of the current `IOLoop` is delegated to `asyncio`, with this and other methods as pass-through accessors. The ``instance`` argument now controls whether an `IOLoop` is created automatically when there is none, instead of whether we fall back to `IOLoop.instance()` (which is now an alias for this method). ``instance=False`` is deprecated, since even if we do not create an `IOLoop`, this method may initialize the asyncio loop. Nr)AsyncIOMainLoopT)r8) r+get_event_loopr1AssertionErrorr$_ioloop_for_asyncioKeyErrorr,r<)r7loopr<r6rrrr6s     cCs tdS)a<Makes this the `IOLoop` for the current thread. An `IOLoop` automatically becomes current for its thread when it is started, but it is sometimes useful to call `make_current` explicitly before starting the `IOLoop`, so that code run at startup time can find the right instance. .. versionchanged:: 4.1 An `IOLoop` created while there is no current `IOLoop` will automatically become current. .. versionchanged:: 5.0 This method also sets the current `asyncio` event loop. N)NotImplementedError)rrrrr8szIOLoop.make_currentcCs0tjdd}|dk r|tdkr,dtj_dS)zClears the `IOLoop` for the current thread. Intended primarily for use by test frameworks in between tests. .. versionchanged:: 5.0 This method also clears the current `asyncio` event loop. F)r7N)r$r6_clear_current_hookr+_currentr7)oldrrrr:,s zIOLoop.clear_currentcCsdS)zInstance method called when an IOLoop ceases to be current. May be overridden by subclasses as a counterpart to make_current. Nr)rrrrrC;szIOLoop._clear_current_hookcCstS)N)r$)r4rrrconfigurable_baseBszIOLoop.configurable_basecCsddlm}|S)Nr) AsyncIOLoop)r,rG)r4rGrrrconfigurable_defaultFs zIOLoop.configurable_default)r8rcCsV|dkr"tjdddkrR|n0|rRtjdd}|dk rJ||k rJtd|dS)NF)r7zcurrent IOLoop already exists)r$r6r8r1)rr8r6rrr initializeLs  zIOLoop.initializeF)all_fdsrcCs tdS)aCloses the `IOLoop`, freeing any resources used. If ``all_fds`` is true, all file descriptors registered on the IOLoop will be closed (not just the ones created by the `IOLoop` itself). Many applications will only use a single `IOLoop` that runs for the entire lifetime of the process. In that case closing the `IOLoop` is not necessary since everything will be cleaned up when the process exits. `IOLoop.close` is provided mainly for scenarios such as unit tests, which create and destroy a large number of ``IOLoops``. An `IOLoop` must be completely stopped before it can be closed. This means that `IOLoop.stop()` must be called *and* `IOLoop.start()` must be allowed to return before attempting to call `IOLoop.close()`. Therefore the call to `close` will usually appear just after the call to `start` rather than near the call to `stop`. .. versionchanged:: 3.1 If the `IOLoop` implementation supports non-integer objects for "file descriptors", those objects will have their ``close`` method when ``all_fds`` is true. N)rB)rrJrrrrWsz IOLoop.close)fdhandlereventsrcCsdS)Nr)rrKrLrMrrr add_handlerrszIOLoop.add_handlercCsdS)Nr)rrKrLrMrrrrNxs).NcCs tdS)a+Registers the given handler to receive the given events for ``fd``. The ``fd`` argument may either be an integer file descriptor or a file-like object with a ``fileno()`` and ``close()`` method. The ``events`` argument is a bitwise or of the constants ``IOLoop.READ``, ``IOLoop.WRITE``, and ``IOLoop.ERROR``. When an event occurs, ``handler(fd, events)`` will be run. .. versionchanged:: 4.0 Added the ability to pass file-like objects in addition to raw file descriptors. N)rB)rrKrLrMrrrrN~s)rKrMrcCs tdS)zChanges the events we listen for ``fd``. .. versionchanged:: 4.0 Added the ability to pass file-like objects in addition to raw file descriptors. N)rB)rrKrMrrrupdate_handlerszIOLoop.update_handler)rKrcCs tdS)zStop listening for events on ``fd``. .. versionchanged:: 4.0 Added the ability to pass file-like objects in addition to raw file descriptors. N)rB)rrKrrrremove_handlerszIOLoop.remove_handlercCs tdS)zStarts the I/O loop. The loop will run until one of the callbacks calls `stop()`, which will make the loop stop after the current event iteration completes. N)rB)rrrrstartsz IOLoop.startcCs0ttjtdjtdjgs,tdS)aThe IOLoop catches and logs exceptions, so it's important that log output be visible. However, python's default behavior for non-root loggers (prior to python 3.2) is to print an unhelpful "no handlers could be found" message rather than the actual log entry, so we must explicitly configure logging if we've made it this far without anything. This method should be called from start() in subclasses. tornadoztornado.applicationN)anylogging getLoggerhandlers basicConfig)rrrr_setup_loggings  zIOLoop._setup_loggingcCs tdS)aStop the I/O loop. If the event loop is not currently running, the next call to `start()` will return immediately. Note that even after `stop` has been called, the `IOLoop` is not completely stopped until `IOLoop.start` has also returned. Some work that was scheduled before the call to `stop` may still be run before the `IOLoop` shuts down. N)rB)rrrrstops z IOLoop.stop)functimeoutrcsdgddfdd }||dk rVddfdd }||}|dk rp|ddk stdsdstd|d S) a>Starts the `IOLoop`, runs the given function, and stops the loop. The function must return either an awaitable object or ``None``. If the function returns an awaitable object, the `IOLoop` will run until the awaitable is resolved (and `run_sync()` will return the awaitable's result). If it raises an exception, the `IOLoop` will stop and the exception will be re-raised to the caller. The keyword-only argument ``timeout`` may be used to set a maximum duration for the function. If the timeout expires, a `tornado.util.TimeoutError` is raised. This method is useful to allow asynchronous calls in a ``main()`` function:: async def main(): # do stuff... if __name__ == '__main__': IOLoop.current().run_sync(main) .. versionchanged:: 4.3 Returning a non-``None``, non-awaitable value is now an error. .. versionchanged:: 5.0 If a timeout occurs, the ``func`` coroutine will be cancelled. N)rcsy&}|dk r$ddlm}||}Wn0tk rVt}|d<t|tYn,Xt|rj|d<nt}|d<||ddk st  dfdddS)Nr)convert_yieldedcsS)N)rY)future)rrrz.IOLoop.run_sync..run..) Z tornado.genr\ Exceptionrrsysexc_infor set_resultr> add_future)resultr\fut)rZ future_cellrrrruns     zIOLoop.run_sync..runcs(ddk stds$dS)Nr)r>cancelrYr)rgrrrtimeout_callbacks z)IOLoop.run_sync..timeout_callbackrz$Operation timed out after %s seconds) add_callback add_timeouttimerQremove_timeoutr> cancelleddoner re)rrZr[rhrjtimeout_handler)rZrgrrrun_syncs    zIOLoop.run_synccCstS)aReturns the current time according to the `IOLoop`'s clock. The return value is a floating-point number relative to an unspecified time in the past. Historically, the IOLoop could be customized to use e.g. `time.monotonic` instead of `time.time`, but this is not currently supported and so this method is equivalent to `time.time`. )rm)rrrrrms z IOLoop.time)deadlinecallbackargsr)rcOs\t|tjr |j||f||St|tjrL|j|||f||Std|dS)aRuns the ``callback`` at the time ``deadline`` from the I/O loop. Returns an opaque handle that may be passed to `remove_timeout` to cancel. ``deadline`` may be a number denoting a time (on the same scale as `IOLoop.time`, normally `time.time`), or a `datetime.timedelta` object for a deadline relative to the current time. Since Tornado 4.0, `call_later` is a more convenient alternative for the relative case since it does not require a timedelta object. Note that it is not safe to call `add_timeout` from other threads. Instead, you must use `add_callback` to transfer control to the `IOLoop`'s thread, and then call `add_timeout` from there. Subclasses of IOLoop must implement either `add_timeout` or `call_at`; the default implementations of each will call the other. `call_at` is usually easier to implement, but subclasses that wish to maintain compatibility with Tornado versions prior to 4.0 must use `add_timeout` instead. .. versionchanged:: 4.0 Now passes through ``*args`` and ``**kwargs`` to the callback. zUnsupported deadline %rN) r-numbersRealcall_atdatetime timedeltarm total_seconds TypeError)rrsrtrur)rrrrl$s  zIOLoop.add_timeout)delayrtrur)rcOs|j|||f||S)aRuns the ``callback`` after ``delay`` seconds have passed. Returns an opaque handle that may be passed to `remove_timeout` to cancel. Note that unlike the `asyncio` method of the same name, the returned object does not have a ``cancel()`` method. See `add_timeout` for comments on thread-safety and subclassing. .. versionadded:: 4.0 )rxrm)rr}rtrur)rrr call_laterMs zIOLoop.call_later)whenrtrur)rcOs|j||f||S)aRuns the ``callback`` at the absolute time designated by ``when``. ``when`` must be a number using the same reference point as `IOLoop.time`. Returns an opaque handle that may be passed to `remove_timeout` to cancel. Note that unlike the `asyncio` method of the same name, the returned object does not have a ``cancel()`` method. See `add_timeout` for comments on thread-safety and subclassing. .. versionadded:: 4.0 )rl)rrrtrur)rrrrx\szIOLoop.call_at)r[rcCs tdS)zCancels a pending timeout. The argument is a handle as returned by `add_timeout`. It is safe to call `remove_timeout` even if the callback has already been run. N)rB)rr[rrrrnnszIOLoop.remove_timeout)rtrur)rcOs tdS)a3Calls the given callback on the next I/O loop iteration. It is safe to call this method from any thread at any time, except from a signal handler. Note that this is the **only** method in `IOLoop` that makes this thread-safety guarantee; all other interaction with the `IOLoop` must be done from that `IOLoop`'s thread. `add_callback()` may be used to transfer control from other threads to the `IOLoop`'s thread. To add a callback from a signal handler, see `add_callback_from_signal`. N)rB)rrtrur)rrrrkws zIOLoop.add_callbackcOs tdS)zCalls the given callback on the next I/O loop iteration. Safe for use from a Python signal handler; should not be used otherwise. N)rB)rrtrur)rrradd_callback_from_signalszIOLoop.add_callback_from_signalcOs|j|f||dS)zCalls the given callback on the next IOLoop iteration. As of Tornado 6.0, this method is equivalent to `add_callback`. .. versionadded:: 4.0 N)rk)rrtrur)rrrspawn_callbackszIOLoop.spawn_callbackz0Union[Future[_T], concurrent.futures.Future[_T]]z Future[_T])r]rtrcsHttr"fddn"ts.ttfdddS)aASchedules a callback on the ``IOLoop`` when the given `.Future` is finished. The callback is invoked with one argument, the `.Future`. This method only accepts `.Future` objects and not other awaitables (unlike most of Tornado where the two are interchangeable). cstS)N) _run_callback functoolspartial)f)rtr]rrrr^r_z#IOLoop.add_future..cs S)N)rk)r)rtr]rrrr^r_N)r-radd_done_callbackrr>r)rr]rtr)rtr]rrrds   zIOLoop.add_future.)executorrZrurcsh|dkr:t|ds4ddlm}tjj|dd|_|j}|j|f|}t| |fddS) zRuns a function in a ``concurrent.futures.Executor``. If ``executor`` is ``None``, the IO loop's default executor will be used. Use `functools.partial` to pass keyword arguments to ``func``. .. versionadded:: 5.0 N _executorr) cpu_count)Z max_workerscs t|S)N)r)r)t_futurerrr^r_z(IOLoop.run_in_executor..) hasattrZtornado.processr concurrentfuturesThreadPoolExecutorrsubmitrrd)rrrZrurZc_futurer)rrrun_in_executors   zIOLoop.run_in_executor)rrcCs ||_dS)zfSets the default executor to use with :meth:`run_in_executor`. .. versionadded:: 5.0 N)r)rrrrrset_default_executorszIOLoop.set_default_executor)rtrcCsyR|}|dk rPddlm}y||}Wn|jk r@YnX|||jWn8tjk rhYn$tk rt j d|ddYnXdS)zRuns a callback with error handling. .. versionchanged:: 6.0 CancelledErrors are no longer logged. Nr)genzException in callback %rT)rb) rRrr\ BadYieldErrorrd_discard_future_resultr+CancelledErrorr`rerror)rrtretrrrrrs zIOLoop._run_callback)r]rcCs |dS)z;Avoid unhandled-exception warnings from spawned coroutines.N)re)rr]rrrrszIOLoop._discard_future_resultcCst|tr||fS||fS)N)r-r r)rrKrrrsplit_fds zIOLoop.split_fdcCs<y"t|trt|n|Wntk r6YnXdS)N)r-r osrOSError)rrKrrrclose_fds    zIOLoop.close_fd)T)T)N)F)N)Frrr__doc__NONEZREADZWRITEERRORdictr? classmethodr r3 staticmethodr7r9r;typingoverloadr6boolrr8r:rCr rrFrHrIrr rrNr"r rrOrPrQrXrYfloatrrrmryrzobjectrlr~rxrnrkrrrdrrExecutorr!rrrrrrrrr __classcell__rr)r5rr$NsM %    J $     !   r$c@sVeZdZdZdddgZeegdfeddddZde d d d Z de d d d Z dS)_Timeoutz2An IOLoop timeout, a UNIX timestamp and a callbackrsrt tdeadlineN)rsrtio_looprcCs8t|tjstd|||_||_|t|jf|_dS)NzUnsupported deadline %r) r-rvrwr|rsrtnextZ_timeout_counterr)rrsrtrrrr__init__2s   z_Timeout.__init__)otherrcCs |j|jkS)N)r)rrrrr__lt__Bsz_Timeout.__lt__cCs |j|jkS)N)r)rrrrr__le__Esz_Timeout.__le__) rrrr __slots__rrr$rrrrrrrrr,s  rc@seZdZdZdegdfeeddddZdddd Zddd d Ze dd d Z ddddZ ddddZ eddddZ dS)PeriodicCallbacka?Schedules the given callback to be called periodically. The callback is called every ``callback_time`` milliseconds. Note that the timeout is given in milliseconds, while most other time-related functions in Tornado use seconds. If ``jitter`` is specified, each callback time will be randomly selected within a window of ``jitter * callback_time`` milliseconds. Jitter can be used to reduce alignment of events with similar periods. A jitter of 0.1 means allowing a 10% variation in callback time. The window is centered on ``callback_time`` so the total number of calls within a given interval should not be significantly affected by adding jitter. If the callback runs for longer than ``callback_time`` milliseconds, subsequent invocations will be skipped to get back on schedule. `start` must be called after the `PeriodicCallback` is created. .. versionchanged:: 5.0 The ``io_loop`` argument (deprecated since version 4.1) has been removed. .. versionchanged:: 5.1 The ``jitter`` argument is added. rN)rt callback_timejitterrcCs2||_|dkrtd||_||_d|_d|_dS)Nrz4Periodic callback must have a positive callback_timeF)rt ValueErrorrr_running_timeout)rrtrrrrrrdszPeriodicCallback.__init__)rcCs(t|_d|_|j|_|dS)zStarts the timer.TN)r$r6rrrm _next_timeout_schedule_next)rrrrrQos  zPeriodicCallback.startcCs(d|_|jdk r$|j|jd|_dS)zStops the timer.FN)rrrrn)rrrrrYys zPeriodicCallback.stopcCs|jS)zfReturns ``True`` if this `.PeriodicCallback` has been started. .. versionadded:: 4.1 )r)rrrr is_runningszPeriodicCallback.is_runningcCsN|js dSz4y|Stk r:tjd|jddYnXWd|XdS)NzException in callback %rT)rb)rrtr`rrr)rrrr_runszPeriodicCallback._runcCs.|jr*||j|j|j|j|_dS)N)r _update_nextrrmrlrrr)rrrrrszPeriodicCallback._schedule_next) current_timercCsn|jd}|jr*|d|jtd9}|j|kr\|jt||j|d|7_n|j|7_dS)Ng@@r%g?)rrrandomrmathfloor)rrZcallback_time_secrrrrs   zPeriodicCallback._update_next)r)rrrrrrrrQrYrrrrrrrrrrIs   r).rr+concurrent.futuresrryrrTrvrrarmrrtornado.concurrentrrrrr tornado.logr tornado.utilrr r rr r r rrrrr TYPE_CHECKINGrrZtyping_extensionsrrrr!r"r$rrrrrrs> ( c