U lu fr @sdZddlZddlmZddlZddlZddlZddlmZddl Z ddl m Z m Z m Z m Z mZe dZGdddeZejZejefZe ed d d ZGd d d ejZeZe e e dddZeZddddddZdeddddZdeddddZ de e e!e ee ej"fddddZ#e j$de dgdfdd d!d"Z%e j$de dgdfdd d#d"Z%de d$dd d%d"Z%dS)&aUtilities for working with ``Future`` objects. Tornado previously provided its own ``Future`` class, but now uses `asyncio.Future`. This module contains utility functions for working with `asyncio.Future` in a way that is backwards-compatible with Tornado's old ``Future`` implementation. While this module is an important part of Tornado's internal implementation, applications rarely need to interact with it directly. N)futures)app_log)AnyCallableOptionalTupleUnion_Tc@s eZdZdS)ReturnValueIgnoredErrorN)__name__ __module__ __qualname__rr6/tmp/pip-unpacked-wheel-bmg6zs32/tornado/concurrent.pyr *sr )xreturncCs t|tSN) isinstanceFUTURES)rrrr is_future4src@sZeZdZedefeeddddZejdkrDde e d d d d Z nde d d dd Z d S) DummyExecutor.futures.Future[_T])fnargskwargsrcOsDt}zt||||Wn"tk r>t|tYnX|Sr)rFuture"future_set_result_unless_cancelled Exceptionfuture_set_exc_infosysexc_info)selfrrrfuturerrrsubmit9s zDummyExecutor.submit) TFN)waitcancel_futuresrcCsdSrr)r!r&r'rrrshutdownEszDummyExecutor.shutdown)r&rcCsdSrr)r!r&rrrr(Js)TF)T) r r r rr rr#r version_infoboolr(rrrrr8s  r)rrrcsbttdtfdfdd }|r,r,tdt|dkrD||dSt|dkr^tdt||S) aEDecorator to run a synchronous method asynchronously on an executor. Returns a future. The executor to be used is determined by the ``executor`` attributes of ``self``. To use a different attribute name, pass a keyword argument to the decorator:: @run_on_executor(executor='_thread_pool') def foo(self): pass This decorator should not be confused with the similarly-named `.IOLoop.run_in_executor`. In general, using ``run_in_executor`` when *calling* a blocking method is recommended instead of using this decorator when *defining* a method. If compatibility with older versions of Tornado is required, consider defining an executor and using ``executor.submit()`` at the call site. .. versionchanged:: 4.2 Added keyword arguments to use alternative attributes. .. versionchanged:: 5.0 Always uses the current IOLoop instead of ``self.io_loop``. .. versionchanged:: 5.1 Returns a `.Future` compatible with ``await`` instead of a `concurrent.futures.Future`. .. deprecated:: 5.1 The ``callback`` argument is deprecated and will be removed in 6.0. The decorator itself is discouraged in new code but will not be removed in 6.0. .. versionchanged:: 6.0 The ``callback`` argument was removed. .)rrcs4ddtttttdfdd }|S)Nexecutor)r!rrrcs.t}t|j|f||}t|||Sr)rgetattrr# chain_future)r!rrZ async_futureZ conc_futurer+rrrwrapper~s zCrun_on_executor..run_on_executor_decorator..wrapper)get functoolswrapsrr)rr/rr.rrun_on_executor_decorator{s z2run_on_executor..run_on_executor_decoratorz*cannot combine positional and keyword argsrzexpected 1 argument, got %d)rr ValueErrorlen)rrr4rr3rrun_on_executorQs*    r8 Future[_T])abrcsJdddfdd }t|tr*t||nddlm}|||dS)ajChain two futures together so that when one completes, so does the other. The result (success or failure) of ``a`` will be copied to ``b``, unless ``b`` has already been completed or cancelled by the time ``a`` finishes. .. versionchanged:: 5.0 Now accepts both Tornado/asyncio `Future` objects and `concurrent.futures.Future`. r9N)r:rcs`r dSt|dr2|dk r2t|n*|}|dk rN|n|dS)Nr )donehasattrr r exception set_exception set_resultresult)r:Za_excr;rrcopys zchain_future..copyr)IOLoop)rrfuture_add_done_callbackZtornado.iolooprDcurrentZ add_future)r:r;rCrDrrBrr-s    r-z%Union[futures.Future[_T], Future[_T]])r"valuercCs|s||dS)zSet the given ``value`` as the `Future`'s result, if not cancelled. Avoids ``asyncio.InvalidStateError`` when calling ``set_result()`` on a cancelled `asyncio.Future`. .. versionadded:: 5.0 N) cancelledr@)r"rGrrrrs r)r"excrcCs&|s||ntjd|ddS)aSet the given ``exc`` as the `Future`'s exception. If the Future is already canceled, logs the exception instead. If this logging is not desired, the caller should explicitly check the state of the Future and call ``Future.set_exception`` instead of this wrapper. Avoids ``asyncio.InvalidStateError`` when calling ``set_exception()`` on a cancelled `asyncio.Future`. .. versionadded:: 6.0 z$Exception after Future was cancelled)r N)rHr?rerror)r"rIrrr%future_set_exception_unless_cancelleds rK)r"r rcCs&|ddkrtdt||ddS)aSet the given ``exc_info`` as the `Future`'s exception. Understands both `asyncio.Future` and the extensions in older versions of Tornado to enable better tracebacks on Python 2. .. versionadded:: 5.0 .. versionchanged:: 6.0 If the future is already cancelled, this function is a no-op. (previously ``asyncio.InvalidStateError`` would be raised) r5Nz,future_set_exc_info called with no exception)rrK)r"r rrrrs rr)r"callbackrcCsdSrrr"rLrrrrEsrEcCsdSrrrMrrrrEs).NcCs |r||n ||dS)aLArrange to call ``callback`` when ``future`` is complete. ``callback`` is invoked with one argument, the ``future``. If ``future`` is already done, ``callback`` is invoked immediately. This may differ from the behavior of ``Future.add_done_callback``, which makes no such guarantee. .. versionadded:: 5.0 N)r<Zadd_done_callbackrMrrrrEs  )&__doc__ZasyncioZ concurrentrr1rtypesZ tornado.logrtypingrrrrrTypeVarr rr rrr*rZExecutorrZdummy_executorr8objectZ _NO_RESULTr-r BaseExceptionrKtype TracebackTyperoverloadrErrrrs\     ?#