j f? @ s? d Z 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 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_future 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/python34/lib64/python3.4/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 sC | j } | d k r? d | _ t j | j | | j | _ n 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 rT d j t j | j } | d 7} | d | j 7} n | d j | j j 7} | j j i | d 6 n 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)zloopzsource_tracebackzexcztb) r
r r r
__slots__r r r r( r r r r r ! s 0 r 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 n 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 n 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 sa | d k r t j | _ n | | _ g | _ | j j r] t j t j d | _ n d S)zInitialize the future.
The optional event_loop argument allows to explicitly set the event
loop object used by the future. If it's not provided, the future uses
the default event loop.
Nr )
r Zget_event_loopr
_callbacksZ get_debugr
extract_stacksys _getframer )r r r r r r s zFuture.__init__c C s | j } t | } | s$ d } n d d } | d k rO | | d } nq | d k r d j | | d | | d } n< | d k r d j | | d | d | | d
} n 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 cbsizer/ r r r Z__format_callbacks s ) zFuture.__format_callbacksc C s | j j g } | j t k rw | j d k rL | j d j | j qw t j | j } | j d j | n | j r | j | j
n | j r | j d } | j d | d | d f n | S)Nzexception={!r}z result={}r zcreated at %s:%sr r1 ) _statelower _FINISHED
_exceptionappendr3 reprlibrepr_resultr* _Future__format_callbacksr )r inforesultZframer r r
_repr_info s
"zFuture._repr_infoc C s) | j } d | j j d j | f S)Nz<%s %s> )rA r r
r" )r r? r r r __repr__ s zFuture.__repr__c C sh | j s
d S| j } i d | j j d 6| d 6| d 6} | j rT | j | d : s z/Future.remove_done_callback..N)r* r2 )r rO Zfiltered_callbacksZ
removed_countr )rO r remove_done_callback5 s
zFuture.remove_done_callbackc C sM | j t k r- t d j | j | n | | _ 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)r6 rG r r3 r= r8 rI )r r@ r r r
set_resultB s
zFuture.set_resultc C s | j t k r- t d j | j | n t | t rH | } n | | _ t | _ | j t j
ry 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}TN)r6 rG r r3
isinstancetyper9 r8 rI r PY34rE r rN r rK r )r rD r r r
set_exceptionN s
zFuture.set_exceptionc c s' | j s d | _ | Vn | j S)NT)rM _blockingr@ )r r r r __iter__c s zFuture.__iter__)!r
r r r
rG r6 r= r9 r r rZ rE rN r r> rA rC r rX r( rJ rI rL rM r@ rD rP rT rU rY r[ ZPY35Z __await__r r r r r q s8
c C s! | j r d S| j | d S)z?Helper setting the result only if the future was not cancelled.N)rL rU )Zfutr@ r r r _set_result_unless_cancelledn s r\ c C sn | j r | j n | j s) d S| j } | d k rQ | j | n | j } | j | d S)z8Copy state from a future to a concurrent.futures.Future.N)rL rJ Z set_running_or_notify_cancelrD rY r@ rU )
concurrentsourcerD r@ r r r _set_concurrent_future_stateu s
r_ 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)rL rJ rD rY r@ rU )r^ destrD r@ r r r _copy_future_state s
ra c s t t t j j f s* t d n t t t j j f sT t d n t t rl j n d t 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 s0 t | t r t | | n
t | | d S)N)rV r ra r_ )r otherr r r
_set_state s z!_chain_future.._set_statec sH | j rD d k s$ k r1 j qD j j n d S)N)rL rJ call_soon_threadsafe) destination) dest_loopr^ source_loopr r _call_check_cancel s
z)_chain_future.._call_check_cancelc s? d k s k r( | n j | d S)N)rd )r^ )rc rf re rg r r _call_set_state s z&_chain_future.._call_set_state)rV r r] futures TypeErrorr rP )r^ re rh ri r )rc rf re r^ rg r
_chain_future s
rl r c C s3 t | t r | St d | } t | | | S)z&Wrap concurrent.futures.Future object.r )rV r rl )r r Z
new_futurer r r r s
) r
__all__Zconcurrent.futures._baser] Zloggingr; r, r r r r rG rH r8 rj Z_baseErrorr r DEBUGZ STACK_DEBUGr r r r\ r_ ra rl r r r r r s2
P %