Edit File: futures.cpython-36.pyc
3 \ > � @ s d Z ddddddgZddlZddlZddlZddlZd d lmZ d d lm Z d d lm Z ej Z ej Z ej Z ejZejZejZejZejd ZG d d� d�ZG dd� d�ZeZdd� Zdd� Zdd� Zdd� Zdd�dd�Zy ddl Z W n e k r� Y n X e j ZZ dS )z.A Future class similar to the one in PEP 3148.�CancelledError� TimeoutError�InvalidStateError�Future� wrap_future�isfuture� N� )� base_futures)�compat)�eventsc @ s4 e Zd ZdZdZdd� Zdd � Zd d � Zd d � ZdS )�_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. �loop�source_traceback�exc�tbc C s |j | _|j| _|| _d | _d S )N)�_loopr �_source_tracebackr r r )�self�futurer � r �'/usr/lib64/python3.6/asyncio/futures.py�__init__R s z_TracebackLogger.__init__c C s, | j }|d k r(d | _ tj|j||j�| _d S )N)r � traceback�format_exception� __class__� __traceback__r )r r r r r �activateX s z_TracebackLogger.activatec C s d | _ d | _d S )N)r r )r r r r �clear_ s z_TracebackLogger.clearc C sb | j r^d}| jr:djtj| j��}|d7 }|d|j� 7 }|dj| j �j� 7 }| jjd|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_list�rstripr �call_exception_handler)r �msg�srcr r r �__del__c s z_TracebackLogger.__del__N)r r r r ) �__name__� __module__� __qualname__�__doc__� __slots__r r r r& r r r r r s 0r c @ s� e Zd ZdZeZdZdZdZdZ dZ dZ dd�dd�Z e jZdd� ZejrRd d � Zd d � Zd d� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd� Zdd � Z d d � Z d d � Z ej r�e Z dS )!r a, This class is *almost* compatible with concurrent.futures.Future. Differences: - This class is not thread-safe. - 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(). - 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.) NF)r c C s@ |dkrt j� | _n|| _g | _| jj� r<t jtjd��| _dS )z�Initialize 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_debug� extract_stack�sys� _getframer )r r r r r r � s zFuture.__init__c C s d| j jdj| j� �f S )Nz<%s %s>� )r r' r � _repr_info)r r r r �__repr__� s zFuture.__repr__c C sD | j s d S | j}d| jj || d�}| jr4| j|d< | jj|� d S )Nz %s exception was never retrieved)r � exceptionr r )�_log_traceback� _exceptionr r' r r r# )r r �contextr r r r& � s zFuture.__del__c C s& d| _ | jtkrdS t| _| j� dS )z�Cancel 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)r5 �_state�_PENDING� _CANCELLED�_schedule_callbacks)r r r r �cancel� s z Future.cancelc C sD | j dd� }|sdS g | j dd�< x|D ]}| jj|| � q*W dS )z�Internal: Ask the event loop to call all callbacks. The callbacks are scheduled to be called as soon as possible. Also clears the callback list. N)r- r � call_soon)r Z callbacks�callbackr r r r; � s zFuture._schedule_callbacksc C s | j tkS )z(Return True if the future was cancelled.)r8 r: )r r r r � cancelled� s zFuture.cancelledc C s | j tkS )z�Return True if the future is done. Done means either that a result / exception are available, or that the future was cancelled. )r8 r9 )r r r r �done� s z Future.donec C s< | j tkrt�| j tkr td��d| _| jdk r6| j�| jS )a Return the result this future represents. If the future has been cancelled, raises CancelledError. If the future's result isn't yet available, raises InvalidStateError. If the future is done and has an exception set, this exception is raised. zResult is not ready.FN)r8 r: r � _FINISHEDr r5 r6 �_result)r r r r �result� s z Future.resultc C s, | j tkrt�| j tkr td��d| _| jS )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.F)r8 r: r rA r r5 r6 )r r r r r4 � s zFuture.exceptionc C s* | j tkr| jj|| � n | jj|� dS )z�Add 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)r8 r9 r r= r- �append)r �fnr r r �add_done_callback s zFuture.add_done_callbackc s< � fdd�| j D �}t| j �t|� }|r8|| j dd�< |S )z}Remove all instances of a callback from the "call when done" list. Returns the number of callbacks removed. c s g | ]}|� kr|�qS r r )�.0�f)rE r r � <listcomp> s z/Future.remove_done_callback.<locals>.<listcomp>N)r- �len)r rE Zfiltered_callbacksZ removed_countr )rE r �remove_done_callback s zFuture.remove_done_callbackc C s4 | j tkr tdj| j | ���|| _t| _ | j� dS )z�Mark the future done and set its result. If the future is already done when this method is called, raises InvalidStateError. z{}: {!r}N)r8 r9 r �formatrB rA r; )r rC r r r � set_result s zFuture.set_resultc C s� | j tkr tdj| j | ���t|t�r,|� }t|�tkr@td��|| _t | _ | j � t j rbd| _ n t| |�| _| jj| jj� dS )z�Mark 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)r8 r9 r rL � isinstance�type� StopIteration� TypeErrorr6 rA r; r �PY34r5 r Z _tb_loggerr r= r )r r4 r r r � set_exception, s zFuture.set_exceptionc c s, | j � sd| _| V | j � s$td��| j� S )NTz"yield from wasn't used with future)r@ �_asyncio_future_blocking�AssertionErrorrC )r r r r �__iter__D s zFuture.__iter__)!r' r( r) r* r9 r8 rB r6 r r rT r5 r r Z_future_repr_infor2 r3 r rR r& r< r; r? r@ rC r4 rF rK rM rS rV ZPY35� __await__r r r r r n s4 c C s | j � r dS | j|� dS )z?Helper setting the result only if the future was not cancelled.N)r? rM )ZfutrC r r r � _set_result_unless_cancelledS s rX c C sZ |j � s t�|j� r | j� | j� s(dS |j� }|dk rD| j|� n|j� }| j|� dS )z8Copy state from a future to a concurrent.futures.Future.N) r@ rU r? r< Z set_running_or_notify_cancelr4 rS rC rM )� concurrent�sourcer4 rC r r r � _set_concurrent_future_stateZ s r[ c C sj | j � s t�|j� rdS |j � s&t�| j� r8|j� n.| j� }|dk rT|j|� n| j� }|j|� dS )zqInternal helper to copy state from another Future. The other Future may be a concurrent.futures.Future. N)r@ rU r? r< r4 rS rC rM )rZ �destr4 rC r r r �_copy_future_statei s r] c s� t �� r"t�tjj� r"td��t �� rDt�tjj� rDtd��t ��rR�jnd�t ��rd�jnd�dd� � ���fdd�}� ���fdd �}�j|� �j|� dS ) 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 | �rt|| � n t| |� d S )N)r r] r[ )r �otherr r r � _set_state� s z!_chain_future.<locals>._set_statec s2 | j � r.�d ks�� kr"�j� n �j�j� d S )N)r? r< �call_soon_threadsafe)� destination)� dest_looprZ � source_loopr r �_call_check_cancel� s z)_chain_future.<locals>._call_check_cancelc sJ �j � r �d k r �j� r d S �d ks,��kr8� �| � n�j� �| � d S )N)r? Z is_closedr` )rZ )r_ rb ra rc r r �_call_set_state� s z&_chain_future.<locals>._call_set_state)r rN rY �futuresr rQ r rF )rZ ra rd re r )r_ rb ra rZ rc r � _chain_future} s rg )r c C sN t | �r | S t| tjj�s(tdj| ���|dkr8tj� }|j � }t | |� |S )z&Wrap concurrent.futures.Future object.z/concurrent.futures.Future is expected, got {!r}N) r rN rY rf r rU rL r r, Z create_futurerg )r r Z new_futurer r r r � s ) r* �__all__Zconcurrent.futuresrY Zloggingr/ r r r r r r r r r r9 r: rA �DEBUGZ STACK_DEBUGr r Z _PyFuturerX r[ r] rg r Z_asyncio� ImportErrorZ_CFuturer r r r �<module> s> P c*