YfD @ sN d Z d d d d d d g Z d d l Z d d l Z d d l Z d d l Z d d l Z d d
l m Z d d l m
Z
d Z d
Z d Z
e j j j Z e j j Z e j j Z e j d Z Gd d d e Z Gd d d Z d d Z Gd d d Z d d Z d d Z d d Z d d Z d d d d Z d S) z.A Future class similar to the one in PEP 3148.CancelledError TimeoutErrorInvalidStateErrorFuture wrap_futureisfuture N )compat)eventsZPENDINGZ CANCELLEDZFINISHEDc @ s e Z d Z d Z d S)r z+The operation is not allowed in this state.N)__name__
__module__ __qualname____doc__ r r 4/opt/alt/python35/lib64/python3.5/asyncio/futures.pyr s c @ sL e Z d Z d Z d Z d d Z d d Z d
d Z d d
Z d S)_TracebackLoggera
Helper to log a traceback upon destruction if not cleared.
This solves a nasty problem with Futures and Tasks that have an
exception set: if nobody asks for the exception, the exception is
never logged. This violates the Zen of Python: 'Errors should
never pass silently. Unless explicitly silenced.'
However, we don't want to log the exception as soon as
set_exception() is called: if the calling code is written
properly, it will get the exception and handle it properly. But
we *do* want to log it if result() or exception() was never called
-- otherwise developers waste a lot of time wondering why their
buggy code fails silently.
An earlier attempt added a __del__() method to the Future class
itself, but this backfired because the presence of __del__()
prevents garbage collection from breaking cycles. A way out of
this catch-22 is to avoid having a __del__() method on the Future
class itself, but instead to have a reference to a helper object
with a __del__() method that logs the traceback, where we ensure
that the helper object doesn't participate in cycles, and only the
Future has a reference to it.
The helper object is added when set_exception() is called. When
the Future is collected, and the helper is present, the helper
object is also collected, and its __del__() method will log the
traceback. When the Future's result() or exception() method is
called (and a helper object is present), it removes the helper
object, after calling its clear() method to prevent it from
logging.
One downside is that we do a fair amount of work to extract the
traceback from the exception, even when it is never logged. It
would seem cheaper to just store the exception object, but that
references the traceback, which references stack frames, which may
reference the Future, which references the _TracebackLogger, and
then the _TracebackLogger would be included in a cycle, which is
what we're trying to avoid! As an optimization, we don't
immediately format the exception; we only do the work when
activate() is called, which call is delayed until after all the
Future's callbacks have run. Since usually a Future has at least
one callback (typically set by 'yield from') and usually that
callback extracts the callback, thereby removing the need to
format the exception.
PS. I don't claim credit for this solution. I first heard of it
in a discussion about closing files when they are collected.
loopsource_tracebackexctbc C s. | j | _ | j | _ | | _ d | _ d S)N)_loopr _source_tracebackr r r )selffuturer r r r __init__U s z_TracebackLogger.__init__c C s@ | j } | d k r< d | _ t j | j | | j | _ d S)N)r tracebackformat_exception __class__
__traceback__r )r r r r r activate[ s
z_TracebackLogger.activatec C s d | _ d | _ d S)N)r r )r r r r clearb s z_TracebackLogger.clearc C s | j r d } | j rQ d j t j | j } | d 7} | d | j 7} | d j | j j 7} | j j d | i d S)Nz*Future/Task exception was never retrieved
z0Future/Task created at (most recent call last):
z%s
message)r r joinr format_listrstripr call_exception_handler)r msgsrcr r r __del__f s
z_TracebackLogger.__del__N)r r r r ) r r r
r __slots__r r r r) r r r r r ! s 0 r c C s t | j d o | j d k S)zCheck for a Future.
This returns True when obj is a Future instance or is advertising
itself as duck-type compatible by setting _asyncio_future_blocking.
See comment in Future for more details.
_asyncio_future_blockingN)hasattrr r+ )objr r r r q s c @ s$ e Z d Z d Z e Z d Z d Z d Z d Z d Z
d Z d Z d d d d Z
d d Z d d
Z d d Z e j r d
d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d d Z d! d" Z d# d$ Z e j r e Z d S)%r a This class is *almost* compatible with concurrent.futures.Future.
Differences:
- result() and exception() do not take a timeout argument and
raise an exception when the future isn't done yet.
- Callbacks registered with add_done_callback() are always called
via the event loop's call_soon_threadsafe().
- This class is not compatible with the wait() and as_completed()
methods in the concurrent.futures package.
(In Python 3.4 or later we may be able to unify the implementations.)
NFr c C s^ | d k r t j | _ n | | _ g | _ | j j rZ t j t j d | _ d S)zInitialize the future.
The optional event_loop argument allows explicitly setting the event
loop object used by the future. If it's not provided, the future uses
the default event loop.
Nr )
r
get_event_loopr
_callbacksZ get_debugr
extract_stacksys _getframer )r r r r r r s zFuture.__init__c C s | j } t | } | s! d } d d } | d k rL | | d } nn | d k r d j | | d | | d } n9 | d k r d j | | d | d | | d
} d | S) Nr! c S s t j | f S)N)r
Z_format_callback_source)callbackr r r format_cb s z,Future.__format_callbacks..format_cbr r z{}, {}z{}, <{} more>, {}zcb=[%s])r/ lenformat)r cbsizer4 r r r Z__format_callbacks s ) zFuture.__format_callbacksc C s | j j g } | j t k rt | j d k rL | j d j | j n( t j | j } | j d j | | j r | j | j
| j r | j d } | j d | d | d f | S)Nzexception={!r}z result={}r zcreated at %s:%sr r6 ) _statelower _FINISHED
_exceptionappendr8 reprlibrepr_resultr/ _Future__format_callbacksr )r inforesultframer r r
_repr_info s
zFuture._repr_infoc C s) | j } d | j j d j | f S)Nz<%s %s> )rG r r r# )r rD r r r __repr__ s zFuture.__repr__c C sb | j s
d S| j } d d | j j d | d | i } | j rN | j | d <| j j | d S)Nr" z %s exception was never retrieved exceptionr r )_log_tracebackr> r r r r r& )r r contextr r r r) s
zFuture.__del__c C s3 d | _ | j t k r d St | _ | j d S)zCancel the future and schedule callbacks.
If the future is already done or cancelled, return False. Otherwise,
change the future's state to cancelled, schedule the callbacks and
return True.
FT)rK r; _PENDING
_CANCELLED_schedule_callbacks)r r r r cancel s
z
Future.cancelc C sX | j d d } | s d Sg | j d d rB )r r r r rE s
z
Future.resultc C se | j t k r t | j t k r0 t d d | _ | j d k r^ | j j d | _ | j S)a& Return the exception that was set on this future.
The exception (or None if no exception was set) is returned only if
the future is done. If the future has been cancelled, raises
CancelledError. If the future isn't done yet, raises
InvalidStateError.
zException is not set.FN) r; rN r r= r rK rT r r> )r r r r rJ ) s
zFuture.exceptionc C s9 | j t k r% | j j | | n | j j | d S)zAdd a callback to be run when the future becomes done.
The callback is called with a single argument - the future object. If
the future is already done when this is called, the callback is
scheduled with call_soon.
N)r; rM r rQ r/ r? )r fnr r r add_done_callback; s zFuture.add_done_callbackc sR f d d | j D } t | j t | } | rN | | j d d <| S)z}Remove all instances of a callback from the "call when done" list.
Returns the number of callbacks removed.
c s" g | ] } | k r | q Sr r ).0f)rU r r
N s z/Future.remove_done_callback..N)r/ r7 )r rU Zfiltered_callbacksZ
removed_countr )rU r remove_done_callbackI s
zFuture.remove_done_callbackc C sJ | j t k r* t d j | j | | | _ t | _ | j d S)zMark the future done and set its result.
If the future is already done when this method is called, raises
InvalidStateError.
z{}: {!r}N)r; rM r r8 rB r= rO )r rE r r r
set_resultV s
zFuture.set_resultc C s | j t k r* t d j | j | t | t rB | } t | t k r` t d | | _ t | _ | j
t j r d | _
n( t | | | _ | j j | j j d S)zMark the future done and set an exception.
If the future is already done when this method is called, raises
InvalidStateError.
z{}: {!r}zPStopIteration interacts badly with generators and cannot be raised into a FutureTN)r; rM r r8
isinstancetype
StopIteration TypeErrorr> r= rO r PY34rK r rT r rQ r )r rJ r r r
set_exceptionb s
zFuture.set_exceptionc c s$ | j s d | _ | V| j S)NT)rS r+ rE )r r r r __iter__z s zFuture.__iter__)!r r r
r rM r; rB r> r r r+ rK rT r rC rG rI r r` r) rP rO rR rS rE rJ rV rZ r[ ra rb ZPY35 __await__r r r r r | s8
c C s! | j r d S| j | d S)z?Helper setting the result only if the future was not cancelled.N)rR r[ )ZfutrE r r r _set_result_unless_cancelled s rd c C sk | j r | j | j s& d S| j } | d k rN | j | n | j } | j | d S)z8Copy state from a future to a concurrent.futures.Future.N)rR rP Z set_running_or_notify_cancelrJ ra rE r[ )
concurrentsourcerJ rE r r r _set_concurrent_future_state s
rg c C sn | j r d S| j r) | j nA | j } | d k rQ | j | n | j } | j | d S)zqInternal helper to copy state from another Future.
The other Future may be a concurrent.futures.Future.
N)rR rP rJ ra rE r[ )rf destrJ rE r r r _copy_future_state s
ri c s t r/ t t j j r/ t d t r^ t t j j r^ t d t rs j n d t r j n d d d f d d } f d d } j | j | d S)
a Chain two futures so that when one completes, so does the other.
The result (or exception) of source will be copied to destination.
If destination is cancelled, source gets cancelled too.
Compatible with both asyncio.Future and concurrent.futures.Future.
z(A future is required for source argumentz-A future is required for destination argumentNc S s- t | r t | | n
t | | d S)N)r ri rg )r otherr r r
_set_state s z!_chain_future.._set_statec sE | j rA d k s$ k r1 j n j j d S)N)rR rP call_soon_threadsafe) destination) dest_looprf source_loopr r _call_check_cancel s
z)_chain_future.._call_check_cancelc s? d k s k r( | n j | d S)N)rl )rf )rk rn rm ro r r _call_set_state s z&_chain_future.._call_set_state)r r\ re futuresr r_ r rV )rf rm rp rq r )rk rn rm rf ro r
_chain_future s
rs r c C sE t | r | S| d k r( t j } | j } t | | | S)z&Wrap concurrent.futures.Future object.N)r r
r. Z
create_futurers )r r Z
new_futurer r r r s
) r __all__Zconcurrent.futures._basere Zloggingr@ r1 r r! r r
rM rN r= rr Z_baseErrorr r DEBUGZ STACK_DEBUGr r r r rd rg ri rs r r r r r s6
P
'