Current File : //lib/python3/dist-packages/twisted/internet/__pycache__/defer.cpython-312.pyc
�
Ϫ�f� � �0 � U d Z ddlmZ ddlZddlZddlZddlmZmZ ddl m
Z
m Z m Z ddl
mZmZ ddlmZ ddlmZ dd lmZmZ dd
lmZmZm Z m Z dd l m Z m Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1 ddl2Z2dd l3m4Z4 dd
l m5Z5m6Z6m7Z7m8Z8 ddl9m:Z:m;Z; ddl<m=Z= ddl>m?Z? ddl@mAZAmBZBmCZC ddlDmEZEmFZF ddlGmHZHmIZI e=� ZJ e.d� ZK e7d� ZLeAxr ej� dk ZN G d� deO� ZP G d� deO� ZQ G d� d eO� ZR G d � d eS� ZTdqd �ZUdrd �ZVdsdtd!�ZW dud"�ZXe1 dvd#�� ZYe1 dwd$�� ZYe1 dxd%�� ZY dyd&�ZY eE e4d'd(d)d� d*�+� dzd,�� ZZd{d-�Z[d|d.�Z\d}d/�Z]d~d0�Z^dd1�Z_ G d2� d3e� Z`e`j� Zae`j� Zbe"d4ecf Zde"d4ecf Zee,ecd4f Zfe(egecf Zhe,e,e/ede6e`j� f efehf e,e/eeede6e`j� f efehf f Zi e i � Zjd5ekd6< e.d7� Zl e.d8� Zm G d9� d:� Zn G d;� d<e!el � Zo d�d=�ZpeC G d>� d?eO� � Zqe,elerf Zse,etelf Zue'euel Zve r>e1 d� d�dA�� Zwe1 d� d�dB�� Zw d� d�dC�ZwewZx G dD� dEeoeve � Zx d� d�dF�Zy d� d�dG�Zz G dH� dIeO� Z{d�dJ�Z|dKZ}d@Z~ G dL� dM� Ze$ecddf Z� d�dN�Z� eE e4d'dOdd� dP� d�dQ�� Z� G dR� dSe�� Z�d�dT�Z� e2�j dK�U� G dV� dWe%el � � Z� d�dX�Z�eI d�dY�� Z� d�dZ�Z� d�d[�Z� d�d\�Z� G d]� d^eO� Z� d�d_�Z� G d`� dae� Z� G db� dce�� Z� G dd� dee�� Z� G df� dgeO� Z� G dh� dieO� Z� G dj� dke%eK � Z� G dl� dmeO� Z� G dn� doe?�j, � Z�g dp�Z�y)�zU
Support for results that aren't immediately available.
Maintainer: Glyph Lefkowitz
� )� annotationsN)�ABC�abstractmethod)�AbstractEventLoop�Future� iscoroutine)�Context� copy_context)�Enum��wraps)�exc_info�implementation)�
CoroutineType�
GeneratorType�MappingProxyType�
TracebackType)�
TYPE_CHECKING�Any� Awaitable�Callable� Coroutine� Generator�Generic�Iterable�List�Mapping�NoReturn�Optional�Sequence�Tuple�Type�TypeVar�Union�cast�overload)�Version)� Concatenate�Literal� ParamSpec�Self)� IDelayedCall� IReactorTime)�Logger)�lockfile)�_PYPY�cmp�
comparable)�
deprecated�warnAboutFunction)�Failure� _extraneous�_T�_P)� � � c � � e Zd ZdZy)�AlreadyCalledErrorz�
This error is raised when one of L{Deferred.callback} or L{Deferred.errback}
is called after one of the two had already been called.
N��__name__�
__module__� __qualname__�__doc__� � �8/usr/lib/python3/dist-packages/twisted/internet/defer.pyr= r= A � � �rD r= c � � e Zd ZdZy)�CancelledErrorzJ
This error is raised by default when a L{Deferred} is cancelled.
Nr> rC rD rE rH rH H � � �rD rH c � � e Zd ZdZy)� TimeoutErrorzG
This error is raised by default when a L{Deferred} times out.
Nr> rC rD rE rK rK N rI rD rK c � � e Zd ZdZy)�NotACoroutineErrorzb
This error is raised when a coroutine is expected and something else is
encountered.
Nr> rC rD rE rM rM T rF rD rM c �2 � t j d| � | S )a-
Log and return failure.
This method can be used as an errback that passes the failure on to the
next errback unmodified. Note that if this is the last errback, and the
deferred gets garbage collected after being this errback has been called,
the clean up code logs it again.
� )�log�failure)�errs rE �logErrorrS [ s � � �K�K��C�� �JrD c �< � t � }|j | � |S )a
Return a L{Deferred} that has already had C{.callback(result)} called.
This is useful when you're writing synchronous code to an
asynchronous interface: i.e., some code is calling you expecting a
L{Deferred} result, but you don't actually need to do anything
asynchronous. Just return C{defer.succeed(theResult)}.
See L{fail} for a version of this function that uses a failing
L{Deferred} rather than a successful one.
@param result: The result to give to the Deferred's 'callback'
method.
)�Deferred�callback��result�ds rE �succeedrZ h s � � �j�A��J�J�v�� �HrD c �< � t � }|j | � |S )a2
Return a L{Deferred} that has already had C{.errback(result)} called.
See L{succeed}'s docstring for rationale.
@param result: The same argument that L{Deferred.errback} takes.
@raise NoCurrentExceptionError: If C{result} is L{None} but there is no
current exception state.
)rU �errbackrW s rE �failr] | s � � �z�A��I�I�f�� �HrD c �\ � | |i |��}t |� S # t $ r
t � cY S w xY w)a
Create a L{Deferred} from a callable and arguments.
Call the given function with the given arguments. Return a L{Deferred}
which has been fired with its callback as the result of that invocation
or its C{errback} with a L{Failure} for the exception thrown.
)rZ �
BaseExceptionr] )�callable�args�kwargsrX s rE �executerc � s: � � ��4�*�6�*�� �v�� �� � ��v�
��s � �+�+c � � y �NrC ��fra rb s rE �
maybeDeferredrh � � � � rD c � � y re rC rf s rE rh rh � s � � rD c � � y re rC rf s rE rh rh � ri rD c �8 � | |i |��}t |t � r|S t |t � r t |� S t
|� t u rt j |� S |}t |� S # t $ r& t t t j �� � cY S w xY w)a6
Invoke a function that may or may not return a L{Deferred} or coroutine.
Call the given function with the given arguments. Then:
- If the returned object is a L{Deferred}, return it.
- If the returned object is a L{Failure}, wrap it with L{fail} and
return it.
- If the returned object is a L{types.CoroutineType}, wrap it with
L{Deferred.fromCoroutine} and return it.
- Otherwise, wrap it in L{succeed} and return it.
- If an exception is raised, convert it to a L{Failure}, wrap it in
L{fail}, and then return it.
@param f: The callable to invoke
@param args: The arguments to pass to C{f}
@param kwargs: The keyword arguments to pass to C{f}
@return: The result of the function call, wrapped in a L{Deferred} if
necessary.
�� captureVars)
r_ r] r5 rU �debug�
isinstance�typer �
fromCoroutinerZ )rg ra rb rX �returneds rE rh rh � s� � �<9��D�#�F�#�� �&�(�#��
� �F�G� $��F�|��
�f� � � &�$ �%�%�f�-�-� ���x� � ��9 � 9��G����7�8�8�9�s �A* �*,B�B�Twisted� � z*twisted.internet.defer.Deferred.addTimeout)� replacementc �J � | j t t d� � � y )NzCallback timed out)r\ r5 rK )�deferreds rE �timeoutrz � s � �
���W�\�*>� ?�@�ArD c � � | S re rC ��args rE �passthrur~ � � � � �JrD c � � | S re rC r| s rE � _failthrur� r rD c �, � t | � t _ y)z�
Enable or disable L{Deferred} debugging.
When debugging is on, the call stacks from creation and invocation are
recorded, and added to any L{AlreadyCalledError}s we raise.
N)�boolrU ro )�ons rE � setDebuggingr� s � � �"�X�H�NrD c �" � t j S )z=
Determine whether L{Deferred} debugging is enabled.
)rU ro rC rD rE � getDebuggingr� s � � �>�>�rD c �h � t | t � r!| j t � t |d� �| S )a�
A default translation function that translates L{Failure}s that are
L{CancelledError}s to L{TimeoutError}s.
@param value: Anything
@param timeout: The timeout
@raise TimeoutError: If C{value} is a L{Failure} that is a L{CancelledError}.
@raise Exception: If C{value} is a L{Failure} that is not a L{CancelledError},
it is re-raised.
@since: 16.5
rU )rp r5 �traprH rK )�valuerz s rE �_cancelledToTimedOutErrorr� s, � � �%��!�
�
�
�>�"��7�J�/�/� �LrD c �, � e Zd ZdZ e� Z e� Zy)� _Sentinela�
@cvar _NO_RESULT:
The result used to represent the fact that there is no result.
B{Never ever ever use this as an actual result for a Deferred}.
You have been warned.
@cvar _CONTINUE:
A marker left in L{Deferred.callback}s to indicate a Deferred chain.
Always accompanied by a Deferred instance in the args tuple pointing at
the Deferred which is chained to the Deferred which has this marker.
N)r? r@ rA rB �object�
_NO_RESULT� _CONTINUErC rD rE r� r� ) s � � � ��J���IrD r� .�_CallbackKeywordArguments� _NONE_KWARGS� _SelfResultT� _NextResultTc �L � e Zd ZU dZdZded< dZded< dZded< d
d�Zd d �Z y) � DebugInfoz
Deferred debug helper.
NzOptional[Failure]�
failResultzOptional[List[str]]�creator�invokerc �R � d}| j �F|dz
}|dj | j � j � j dd� z
}|dz
}| j �F|dz
}|dj | j � j � j dd� z
}|dz
}|S )NrO z C: Deferred was created:
C:�
z
C:z I: First Invoker was:
I:z
I:)r� �join�rstrip�replacer� )�self�infos rE �_getDebugTracebacksz DebugInfo._getDebugTracebacksd s� � ��� �<�<� #� �4� 4�D� �B�G�G�D�L�L�)�0�0�2�:�:�4��I� I�D� �D�L�D� �<�<� #� �1� 1�D� �B�G�G�D�L�L�)�0�0�2�:�:�4��I� I�D� �D�L�D�� rD c � � | j �Qt j dd�� | j � }|rd}nd}t j || j |�� yy)z�
Print tracebacks and die.
If the *last* (and I do mean *last*) callback leaves me in an error
state, print a traceback (if said errback is a L{Failure}).
Nz Unhandled error in Deferred:T)�isErrorz(debug: {debugInfo})rO )� debugInfo)r� rP �criticalr� rQ )r� r� �formats rE �__del__zDebugInfo.__del__p sW � � �?�?� &�
�L�L�7��L� F� �0�0�2�I��/���� �K�K�����9�K� E� 'rD ��return�str�r� �None)
r? r@ rA rB r� �__annotations__r� r� r� r� rC rD rE r� r� [ s5 � �� %)�J�!�(�#'�G�
�'�#'�G�
�'�
�FrD r� c � � e Zd ZU dZdZdZdZded< dZdZ dZ
dZ ded< d0 d1d �Z dd
e
d
e
f d2d �Ze d3d �� Ze d4d
�� Ze d5d�� Ze d6d�� Ze d7d�� Ze d8d�� Zd9d�Ze d:d�� Ze d;d�� Ze d<d�� Zd=d�Ze d>d�� Ze d?d�� Ze d@d�� Ze dAd�� Ze dBd�� Ze dCd �� Ze dDd �� Zd9d �Z d0 dEd �ZdFd �ZdGd!�Zd0dHd"�ZdId#�ZdId$�ZdId%�ZdJd&�ZdKd'�ZdId(�Z dLd)�Z e Z dMd*�Z e d0dNd+�� Z!dOd,�Z"e!Z#dPd-�Z$e%dQd.�� Z&e% dRd/�� Z'y)SrU a
This is a callback which will be put off until later.
Why do we want this? Well, in cases where a function in a threaded
program would block until it gets a result, for Twisted it should
not block. Instead, it should return a L{Deferred}.
This can be implemented for protocols that run over the network by
writing an asynchronous protocol for L{twisted.internet}. For methods
that come from outside packages that are not under our control, we use
threads (see for example L{twisted.enterprise.adbapi}).
For more information about Deferreds, see doc/core/howto/defer.html or
U{http://twistedmatrix.com/documents/current/core/howto/defer.html}
When creating a Deferred, you may provide a canceller function, which
will be called by d.cancel() to let you do any clean-up necessary if the
user decides not to wait for the deferred to complete.
@ivar called: A flag which is C{False} until either C{callback} or
C{errback} is called and afterwards always C{True}.
@ivar paused: A counter of how many unmatched C{pause} calls have been made
on this instance.
@ivar _suppressAlreadyCalled: A flag used by the cancellation mechanism
which is C{True} if the Deferred has no canceller and has been
cancelled, C{False} otherwise. If C{True}, it can be expected that
C{callback} or C{errback} will eventually be called and the result
should be silently discarded.
@ivar _runningCallbacks: A flag which is C{True} while this instance is
executing its callback chain, used to stop recursive execution of
L{_runCallbacks}
@ivar _chainedTo: If this L{Deferred} is waiting for the result of another
L{Deferred}, this is a reference to the other Deferred. Otherwise,
L{None}.
Fr NzOptional[DebugInfo]�
_debugInfoz'Optional[Deferred[Any]]'�
_chainedToc � � g | _ || _ | j r6t � | _ t j � dd | j _ yy)aH
Initialize a L{Deferred}.
@param canceller: a callable used to stop the pending operation
scheduled by this L{Deferred} when L{Deferred.cancel} is invoked.
The canceller will be passed the deferred whose cancellation is
requested (i.e., C{self}).
If a canceller is not given, or does not invoke its argument's
C{callback} or C{errback} method, L{Deferred.cancel} will
invoke L{Deferred.errback} with a L{CancelledError}.
Note that if a canceller is not given, C{callback} or
C{errback} may still be invoked exactly once, even though
defer.py will have already invoked C{errback}, as described
above. This allows clients of code which returns a L{Deferred}
to cancel it without requiring the L{Deferred} instantiator to
provide any specific implementation support for cancellation.
New in 10.1.
@type canceller: a 1-argument callable which takes a L{Deferred}. The
return result is ignored.
N���)� callbacks�
_cancellerro r� r� � traceback� format_stackr� �r� � cancellers rE �__init__zDeferred.__init__� sC � �4 02���#��� �:�:� '�k�D�O�&/�&<�&<�&>�s��&C�D�O�O� #� rD rC c �� � |�t }|�d}|�i }|�d}|�i }t |� sJ �t |� sJ �| j j |||f|||ff� | j r| j � | S )a�
Add a pair of callbacks (success and error) to this L{Deferred}.
These will be executed when the 'master' callback is run.
@note: The signature of this function was designed many years before
PEP 612; ParamSpec provides no mechanism to annotate parameters
like C{callbackArgs}; this is therefore inherently less type-safe
than calling C{addCallback} and C{addErrback} separately.
@return: C{self}.
rC )r� r` r� �append�called�
_runCallbacks)r� rV r\ � callbackArgs�callbackKeywords� errbackArgs�errbackKeywordss rE � addCallbackszDeferred.addCallbacks� s� � �L �?� �G� � � �L� � #� !� � � � �K� � "� �O���!�!�!��� � � � ��� � ��<�)9�:��+��7�
�
� �;�;� � � � � � rD c � � y re rC �r� rV ra rb s rE � addCallbackzDeferred.addCallback* � � � rD c � � y re rC r� s rE r� zDeferred.addCallback3 � � � rD c � � y re rC r� s rE r� zDeferred.addCallback? r� rD c � � y re rC r� s rE r� zDeferred.addCallbackH r� rD c � � y re rC r� s rE r� zDeferred.addCallbackQ r� rD c � � y re rC r� s rE r� zDeferred.addCallback] r� rD c �* � | j |||�� S )z^
Convenience method for adding just a callback.
See L{addCallbacks}.
)r� r� �r� r� s rE r� zDeferred.addCallbackf s � � � � ���v� �V�VrD c � � y re rC �r� r\ ra rb s rE �
addErrbackzDeferred.addErrbackq r� rD c � � y re rC r� s rE r� zDeferred.addErrbackz r� rD c � � y re rC r� s rE r� zDeferred.addErrback� r� rD c �4 � | j t |||�� S )z^
Convenience method for adding just an errback.
See L{addCallbacks}.
)r� r� )r� r~ r� s rE r� zDeferred.addErrback� s% � � � � � �g�4�� !�
�
rD c � � y re rC r� s rE �addBothzDeferred.addBoth� r� rD c � � y re rC r� s rE r� zDeferred.addBoth� r� rD c � � y re rC r� s rE r� zDeferred.addBoth� � � � rD c � � y re rC r� s rE r� zDeferred.addBoth� r� rD c � � y re rC r� s rE r� zDeferred.addBoth� r� rD c � � y re rC r� s rE r� zDeferred.addBoth� r� rD c � � y re rC r� s rE r� zDeferred.addBoth� r� rD c �0 � | j ||||||�� S )z�
Convenience method for adding a single callable as both a callback
and an errback.
See L{addCallbacks}.
)r� r� r� r� r� r� s rE r� zDeferred.addBoth� s. � � � � � � � � � #� "�
!�
�
rD c � � ���� � dg� d� � fd� }|j �|� � d�� �fd� }d�fd� }� j |� }|j |� S )a�
Time out this L{Deferred} by scheduling it to be cancelled after
C{timeout} seconds.
The timeout encompasses all the callbacks and errbacks added to this
L{defer.Deferred} before the call to L{addTimeout}, and none added
after the call.
If this L{Deferred} gets timed out, it errbacks with a L{TimeoutError},
unless a cancelable function was passed to its initialization or unless
a different C{onTimeoutCancel} callable is provided.
@param timeout: number of seconds to wait before timing out this
L{Deferred}
@param clock: The object which will be used to schedule the timeout.
@param onTimeoutCancel: A callable which is called immediately after
this L{Deferred} times out, and not if this L{Deferred} is
otherwise cancelled before the timeout. It takes an arbitrary
value, which is the value of this L{Deferred} at that exact point
in time (probably a L{CancelledError} L{Failure}), and the
C{timeout}. The default callable (if C{None} is provided) will
translate a L{CancelledError} L{Failure} into a L{TimeoutError}.
@return: C{self}.
@since: 16.5
Fc �0 �� d�d< � j � y )NTr ��cancel)r� �timedOuts ��rE � timeItOutz&Deferred.addTimeout.<locals>.timeItOut s �� � �H�Q�K� �K�K�MrD c �8 �� �d r�xs t } || �� S | S )Nr )r� )rX �toCall�onTimeoutCancelr� rz s ���rE �convertCancelledz-Deferred.addTimeout.<locals>.convertCancelled" s) �� �
��{�(�E�,E�� �f�g�.�.��MrD c �H �� �j � r�j � | S re )�activer� )rX � delayedCalls �rE �
cancelTimeoutz*Deferred.addTimeout.<locals>.cancelTimeout, s �� ��!�!�#��"�"�$��MrD r� )rX � Union[_SelfResultT, Failure]r� z*Union[_SelfResultT, _NextResultT, Failure])rX r7 r� r7 )� callLaterr� )
r� rz �clockr� r� r� r� � convertedr� r� s
`` ` @@rE �
addTimeoutzDeferred.addTimeout� sg �� �N �7�� � �o�o�g�y�9� � �0� �
7� � � BF� � � �B
� � � � � �/�/rD c �\ � | |_ | j |j |j � S )a�
Chain another L{Deferred} to this L{Deferred}.
This method adds callbacks to this L{Deferred} to call C{d}'s callback
or errback, as appropriate. It is merely a shorthand way of performing
the following::
d1.addCallbacks(d2.callback, d2.errback)
When you chain a deferred C{d2} to another deferred C{d1} with
C{d1.chainDeferred(d2)}, you are making C{d2} participate in the
callback chain of C{d1}.
Thus any event that fires C{d1} will also fire C{d2}.
However, the converse is B{not} true; if C{d2} is fired, C{d1} will not
be affected.
Note that unlike the case where chaining is caused by a L{Deferred}
being returned from a callback, it is possible to cause the call
stack size limit to be exceeded by chaining many L{Deferred}s
together with C{chainDeferred}.
@return: C{self}.
)r� r� rV r\ �r� rY s rE �
chainDeferredzDeferred.chainDeferred: s& � �0 �� �� � ����Q�Y�Y�7�7rD c �J � t |t � rJ �| j |� y)a7
Run all success callbacks that have been added to this L{Deferred}.
Each callback will have its result passed as the first argument to
the next; this way, the callbacks act as a 'processing chain'. If
the success-callback returns a L{Failure} or raises an L{Exception},
processing will continue on the *error* callback chain. If a
callback (or errback) returns another L{Deferred}, this L{Deferred}
will be chained to it (and further callbacks will not run until that
L{Deferred} has a result).
An instance of L{Deferred} may only have either L{callback} or
L{errback} called on it, and only once.
@param result: The object which will be passed to the first callback
added to this L{Deferred} (via L{addCallback}), unless C{result} is
a L{Failure}, in which case the behavior is the same as calling
C{errback(result)}.
@raise AlreadyCalledError: If L{callback} or L{errback} has already been
called on this L{Deferred}.
N)rp rU �_startRunCallbacks)r� rX s rE rV zDeferred.callbackU s" � �. �f�h�/�/�/� � � ��'rD c � � |�t | j �� }nt |t � s t |� }| j |� y)a�
Run all error callbacks that have been added to this L{Deferred}.
Each callback will have its result passed as the first
argument to the next; this way, the callbacks act as a
'processing chain'. Also, if the error-callback returns a non-Failure
or doesn't raise an L{Exception}, processing will continue on the
*success*-callback chain.
If the argument that's passed to me is not a L{Failure} instance,
it will be embedded in one. If no argument is passed, a
L{Failure} instance will be created based on the current
traceback stack.
Passing a string as `fail' is deprecated, and will be punished with
a warning message.
An instance of L{Deferred} may only have either L{callback} or
L{errback} called on it, and only once.
@param fail: The L{Failure} object which will be passed to the first
errback added to this L{Deferred} (via L{addErrback}).
Alternatively, a L{Exception} instance from which a L{Failure} will
be constructed (with no traceback) or L{None} to create a L{Failure}
instance from the current exception state (with a traceback).
@raise AlreadyCalledError: If L{callback} or L{errback} has already been
called on this L{Deferred}.
@raise NoCurrentExceptionError: If C{fail} is L{None} but there is
no current exception state.
Nrm )r5 ro rp r� )r� r] s rE r\ zDeferred.errbacko s9 � �@ �<��t�z�z�2�D��D�'�*��4�=�D� � � ��%rD c �, � | j dz | _ y)zP
Stop processing on a L{Deferred} until L{unpause}() is called.
rv N)�paused�r� s rE �pausezDeferred.pause� s � � �k�k�A�o�� rD c � � | j dz
| _ | j ry| j r| j � yy)zI
Process all callbacks made since L{pause}() was called.
rv N)r� r� r� r� s rE �unpausezDeferred.unpause� s5 � � �k�k�A�o�� � �;�;� � �;�;� � � � � rD c �" � | j sN| j }|r || � nd| _ | j s#| j t t � � � yyt
| j t � r| j j � yy)a�
Cancel this L{Deferred}.
If the L{Deferred} has not yet had its C{errback} or C{callback} method
invoked, call the canceller function provided to the constructor. If
that function does not invoke C{callback} or C{errback}, or if no
canceller function was provided, errback with L{CancelledError}.
If this L{Deferred} is waiting on another L{Deferred}, forward the
cancellation to the other L{Deferred}.
TN)
r� r� �_suppressAlreadyCalledr\ r5 rH rp rX rU r� r� s rE r� zDeferred.cancel� so � � �{�{� ���I���$�� /3��+��;�;� � � �W�^�%5� 6�7� � �� � �X�
.� �K�K� � � � /rD c �� � | j ri| j rd| _ y | j rC| j �t � | _ d| j j � z }t
|� �t �| j rA| j �t � | _ t j � d d | j _ d| _ d | _
|| _ | j � y )NFr� ���T)
r� r� ro r� r� r� r= r� r� r� r� rX r� )r� rX �extras rE r� zDeferred._startRunCallbacks� s� � � �;�;��*�*�.3��+���z�z��?�?�*�&/�k�D�O� �t��� B� B� D�D��(��/�/�$� $� �:�:����&�"+�+���&/�&<�&<�&>�s��&C�D�O�O� #��� � ��� �� � ��� rD c �b � t j | ft ft j | ft ffS )zT
Build a tuple of callback and errback with L{_Sentinel._CONTINUE}.
)r� r� r� r� s rE �
_continuationzDeferred._continuation� s2 � �
�
�
�4�'�<� 8�
�
�
�4�'�<� 8�
�
rD c �b � | j ry| g}|�r�|d }|j ryd}d|_ |j �r |j j d� }t |j t � s
|d \ }}}n |d \ }}}|t u ryt t t |d � }|j |_ d|_ |j �d|j _
|xj dz c_ |j |� d}�nV d|_ ||j g|��i |��|_ |j |u r t |d� d|_ t |j t � r�t! |j dt" � } | t" u s&t | t � s|j j rU|j% � |j |_ |j j j |j' � � nXd|j _ |j j �d|j j _
| |_ |j r�� |r�t |j t � rQ|j j- � |j �t/ � |_ |j |j _
n |j �d|j _
|j � |r���yy# d|_ w xY w# t( $ r t | j* � � |_ Y ��w xY w)
a�
Run the chain of callbacks once a result is available.
This consists of a simple loop over all of the callbacks, calling each
with the current result and making the current result equal to the
return value (or raised exception) of that call.
If L{_runningCallbacks} is true, this loop won't run at all, since
it is already running above us on the call stack. If C{self.paused} is
true, the loop also won't run, because that's what it means to be
paused.
The loop will terminate before processing all of the callbacks if a
L{Deferred} without a result is encountered.
If a L{Deferred} I{with} a result is encountered, that result is taken
and the loop proceeds.
@note: The implementation is complicated slightly by the fact that
chaining (associating two L{Deferred}s with each other such that one
will wait for the result of the other, as happens when a Deferred is
returned from a callback on another L{Deferred}) is supported
iteratively rather than recursively, to avoid running out of stack
frames when processing long chains.
Nr� Tr rv Fz|Callback returned the Deferred it was attached to; this breaks the callback chain and will raise an exception in the future.rX rm )�_runningCallbacksr� r� r� �poprp rX r5 r� r% rU r� r� r� r� r4 �getattrr� r� r r_ ro � cleanFailurer� )
r� �chain�current�finished�itemrV ra rb �chainee� resultResults
rE r� zDeferred._runCallbacks� s� � �4 � !� !� � '+�V����B�i�G��~�~� ��H�!%�G� ��#�#� �(�(�,�,�Q�/��!�'�.�.�'�:�-1�!�W�*�H�d�F� .2�!�W�*�H�d�F� �y�(� #�8�F�#3�T�!�W� =�G�%,�^�^�G�N�%)�G�N� �)�)�5�8<��*�*�5��N�N�a�'�N��L�L��)� %�H��4:�04�G�-�:� *2� #�N�N�*�-1�*�5;�*��� #�>�>�W�4� -� (�!;� � 5:��1� "�'�.�.�(�;� (/�w�~�~�x��'T� � (�J� 6� )�,�� A� &�~�~� 4� 4� $�M�M�O�18� � �G� .�
$�N�N� 4� 4� ;� ;�G�<Q�<Q�<S� T� !� 59�G�N�N� 1� &�~�~� 8� 8� D�GK���� 9� 9� D�-9�G�N�] �#�#�` �
�g�n�n�g�6� �N�N�/�/�1� �)�)�1�-6�[��*�4;�N�N�G�&�&�1� �)�)�5�8<��*�*�5� � � � �_ ��v 5:��1��$� E� &-����%D�G�N�E�s* �L �5K; �L �; L�L �$L.�-L.c �� � | j j }t | dt � }t | � }| j
�dt | j
� d��}n|t u rd}nd|��}d|� d|d�|� d�S ) zE
Return a string representation of this L{Deferred}.
rX z waiting on Deferred at 0x�xrO z current result: �<z at 0x�>)� __class__r? r r� �idr� )r� �cnamerX �myIDs rE �__str__zDeferred.__str__y s� � � ���'�'����x��4���$�x�� �?�?� &�1�"�T�_�_�2E�a�1H�I�F�
�z�
!��F�(��
�3�F��5�'���Q�x��x�q�1�1rD c � � | S re rC r� s rE �__iter__zDeferred.__iter__� s � �� rD c � � | j r| S t | dt � }|t u r| S t |t � r<| j
�J �d | j
_ ||j _ |j �t |� �)NrX )
r� r r� rp r5 r� r� r� � __failure__�
StopIteration)r� r� rX s rE �sendz
Deferred.send� sr � � �;�;��K���x��4�� �Z� ��K� �f�g� &� �?�?�.� .�.�)-�D�O�O� &�'-�F�L�L� $��,�,� � ��'� 'rD c �" � | j � S re )r r� s rE � __await__zDeferred.__await__� s � ��}�}�� rD c � � �� |j � �d� fd� }d�fd� }d�fd� }� j ||� �j |� �S )a
Adapt this L{Deferred} into a L{Future} which is bound to C{loop}.
@note: converting a L{Deferred} to an L{Future} consumes both
its result and its errors, so this method implicitly converts
C{self} into a L{Deferred} firing with L{None}, regardless of what
its result previously would have been.
@since: Twisted 17.5.0
@param loop: The L{asyncio} event loop to bind the L{Future} to.
@return: A L{Future} which will fire when the L{Deferred} fires.
c �H �� | j � r�j � y y re )� cancelledr� )� futureAgainr� s �rE � checkCancelz&Deferred.asFuture.<locals>.checkCancel� s �� ��$�$�&�� � �
� 'rD c �^ �� �j � s �j | j � y y re )r# �
set_exceptionr� )rQ �futures �rE � maybeFailz$Deferred.asFuture.<locals>.maybeFail� s& �� ��#�#�%��$�$�W�]�]�3� &rD c �J �� �j � s�j | � y y re )r# �
set_result)rX r( s �rE � maybeSucceedz'Deferred.asFuture.<locals>.maybeSucceed� s" �� ��#�#�%��!�!�&�)� &rD )r$ �'Future[_SelfResultT]'r� r� )rQ r5 r� r� �rX r� r� r� )�
create_futurer� �add_done_callback)r� �loopr% r) r, r( s ` @rE �asFuturezDeferred.asFuture� sG �� � �#�#�%�� � 4� *�
���,� �2�� � ��-��
rD c � ���� d�fd� }t � �d��fd� } | |� }|� d��fd� }|j |� �j |� |S )a�
Adapt a L{Future} to a L{Deferred}.
@note: This creates a L{Deferred} from a L{Future}, I{not} from
a C{coroutine}; in other words, you will need to call
L{asyncio.ensure_future}, L{asyncio.loop.create_task} or create an
L{asyncio.Task} yourself to get from a C{coroutine} to a
L{Future} if what you have is an awaitable coroutine and
not a L{Future}. (The length of this list of techniques is
exactly why we have left it to the caller!)
@since: Twisted 17.5.0
@param future: The L{Future} to adapt.
@return: A L{Deferred} which will fire when the L{Future} fires.
c �| �� | j � }�j |� y # t $ r
t � }Y �'w xY wre )rX r_ r5 rV )rX � extracted�actuals �rE �adaptz"Deferred.fromFuture.<locals>.adapt� s9 �� �
&�4:�M�M�O� �
�O�O�I� &�� !�
&� #�I� �
&�s �% �;�;c �H �� �j � | j �� y re �r� rV )�reselfr( � futureCancels ��rE r� z#Deferred.fromFuture.<locals>.cancel� s �� � �M�M�O� �O�O�L� )rD c �( �� | �u r t � ��S | S re )rU )rX r6 r; s ��rE �uncancelz%Deferred.fromFuture.<locals>.uncancel� s �� � � �%�!��� �
��MrD )rX zFuture[_SelfResultT]r� r� )r: �Deferred[object]r� r� )rX r� r� z+Union[_SelfResultT, Deferred[_SelfResultT]])r� r� r0 )�clsr( r7 r� r� r= r6 r; s ` @@rE �
fromFuturezDeferred.fromFuture� s^ �� �( '� �x� � *� �6�{���� � � �
8� �
����"�� � ��'�� rD c �t � t |� st j |� r t |� S t |�d�� �)a�
Schedule the execution of a coroutine that awaits on L{Deferred}s,
wrapping it in a L{Deferred} that will fire on success/failure of the
coroutine.
Coroutine functions return a coroutine object, similar to how
generators work. This function turns that coroutine into a Deferred,
meaning that it can be used in regular Twisted code. For example::
import treq
from twisted.internet.defer import Deferred
from twisted.internet.task import react
async def crawl(pages):
results = {}
for page in pages:
results[page] = await treq.content(await treq.get(page))
return results
def main(reactor):
pages = [
"http://localhost:8080"
]
d = Deferred.fromCoroutine(crawl(pages))
d.addCallback(print)
return d
react(main)
@since: Twisted 21.2.0
@param coro: The coroutine object to schedule.
@raise ValueError: If C{coro} is not a coroutine or generator.
z is not a coroutine)r �inspect� isgenerator�_cancellableInlineCallbacksrM )r? �coros rE rr zDeferred.fromCoroutine� s8 � �\ �t� �� 3� 3�D� 9�.�t�4� 4� �D�8�+>�!?�@�@rD re )r� z+Optional[Callable[['Deferred[Any]'], None]]r� r� )rV z�Union[Callable[..., _NextResultT], Callable[..., Deferred[_NextResultT]], Callable[..., Failure], Callable[..., Union[_NextResultT, Deferred[_NextResultT], Failure]]]r\ z�Union[Callable[..., _NextResultT], Callable[..., Deferred[_NextResultT]], Callable[..., Failure], Callable[..., Union[_NextResultT, Deferred[_NextResultT], Failure]], None]r� zTuple[Any, ...]r� zMapping[str, Any]r� �_CallbackOrderedArgumentsr� r� r� z'Deferred[_NextResultT]')rV z0Callable[Concatenate[_SelfResultT, _P], Failure]ra �_P.argsrb � _P.kwargsr� �Deferred[_NextResultT])rV zOCallable[Concatenate[_SelfResultT, _P], Union[Failure, Deferred[_NextResultT]]]ra rG rb rH r� rI )rV zECallable[Concatenate[_SelfResultT, _P], Union[Failure, _NextResultT]]ra rG rb rH r� rI )rV z?Callable[Concatenate[_SelfResultT, _P], Deferred[_NextResultT]]ra rG rb rH r� rI )rV zTCallable[Concatenate[_SelfResultT, _P], Union[Deferred[_NextResultT], _NextResultT]]ra rG rb rH r� rI )rV z5Callable[Concatenate[_SelfResultT, _P], _NextResultT]ra rG rb rH r� rI )rV r ra r rb r r� �'Deferred[Any]')r\ z:Callable[Concatenate[Failure, _P], Deferred[_NextResultT]]ra rG rb rH r� �-'Deferred[Union[_SelfResultT, _NextResultT]]')r\ z+Callable[Concatenate[Failure, _P], Failure]ra rG rb rH r� z 'Deferred[Union[_SelfResultT]]')r\ z0Callable[Concatenate[Failure, _P], _NextResultT]ra rG rb rH r� rK )r\ r ra r rb r r� rJ )rV z@Callable[Concatenate[Union[_SelfResultT, Failure], _P], Failure]ra rG rb rH r� rI )rV z_Callable[Concatenate[Union[_SelfResultT, Failure], _P], Union[Failure, Deferred[_NextResultT]]]ra rG rb rH r� rI )rV zUCallable[Concatenate[Union[_SelfResultT, Failure], _P], Union[Failure, _NextResultT]]ra rG rb rH r� rI )rV zOCallable[Concatenate[Union[_SelfResultT, Failure], _P], Deferred[_NextResultT]]ra rG rb rH r� rI )rV zdCallable[Concatenate[Union[_SelfResultT, Failure], _P], Union[Deferred[_NextResultT], _NextResultT]]ra rG rb rH r� rI )rV zECallable[Concatenate[Union[_SelfResultT, Failure], _P], _NextResultT]ra rG rb rH r� rI )rV z!Callable[Concatenate[_T, _P], _T]ra rG rb rH r� �Deferred[_SelfResultT])rz �floatr� r- r� zWOptional[Callable[[Union[_SelfResultT, Failure], float], Union[_NextResultT, Failure]]]r� rK )rY �'Deferred[_SelfResultT]'r� z'Deferred[None]')rX r� r� r� )r] �'Optional[Union[Failure, BaseException]]r� r� r� r. )r� �_CallbackChainr� )r� rN )r� r� r� rN )r� z"Generator[Any, None, _SelfResultT])r1 r r� r- )r( r- r� rN )rE zKUnion[Coroutine[Deferred[Any], Any, _T], Generator[Deferred[Any], Any, _T]]r� �'Deferred[_T]')(r? r@ rA rB r� r� r� r� r� r ro r� r� r� r� r& r� r� r� r� r� rV r\ r� r� r� r� r r� r �__repr__r r6 r r �__next__r2 � classmethodr@ rr rC rD rE rU rU � s^ � �"�H �F�
�F�&*�J�#�*� "��
��
�E�,0�J�)�0� HL� D�D� D�
� D�h
�(*�.:�13�5A�1B�
�B�
�B�* &�+B�, ,�-B�. /�/B�0 3�1B�2
"�3B�` � �B� � � � � �
� � � � � �
� � �
� � �
� � � � � �W� � � � � �
� � � � � �Q� � � � � �
� � � � � �
� � �
� � �
� � � � � �G� � � � � �
� � � � W� � �K� � � � � �
7� � � � � �<� � � � � �
)� � � � � �A� � � � � �
7� � � �
� � �R� � � � � �
� � � � � �
� � �
� � �
� � � � � �
� �
� � �
�
� � � � � �
� �
� � �
�
� � � � � �
� � �
� � �
� � � � � �W� � � � � �
� � � � � �3� � � � � �
� � � �
�8
�E0��E0� �E0�
� E0�
7�E0�N8�6(�4%&�N&� !�!�8 �0
�T �l
2� �H�� �(� �(�0 � �H� �D �/� �/�b �/A�
�/A�
�
/A� �/ArD rU c � � t | t � r| S t j | � S # t $ r t | �d�� �w xY w)a�
Schedule the execution of a coroutine that awaits/yields from L{Deferred}s,
wrapping it in a L{Deferred} that will fire on success/failure of the
coroutine. If a Deferred is passed to this function, it will be returned
directly (mimicking the L{asyncio.ensure_future} function).
See L{Deferred.fromCoroutine} for examples of coroutines.
@param coro: The coroutine object to schedule, or a L{Deferred}.
z! is not a coroutine or a Deferred)rp rU rr rM )rE s rE �ensureDeferredrV 2 sP � �" �$��!�� � S��)�)�$�/� /��!� S� %��x�/P�%Q�R� R� S�s �) �Ac �0 � e Zd ZdZdd�Zdd�Zdd�Zd d�Zy)
�
FirstErrorz�
First error to occur in a L{DeferredList} if C{fireOnOneErrback} is set.
@ivar subFailure: The L{Failure} that occurred.
@ivar index: The index of the L{Deferred} in the L{DeferredList} where
it happened.
c �N � t j | ||� || _ || _ y re )� Exceptionr� �
subFailure�index)r� rQ r\ s rE r� zFirstError.__init__X s" � ����4��%�0�!�����
rD c �L � d| j | j j fz S )z�
The I{repr} of L{FirstError} instances includes the repr of the
wrapped failure's exception and the index of the L{FirstError}.
zFirstError[#%d, %r])r\ r[ r� r� s rE rR zFirstError.__repr__] s" � �
%��
�
�D�O�O�4I�4I�'J�J�JrD c �8 � d| j | j fz S )z�
The I{str} of L{FirstError} instances includes the I{str} of the
entire wrapped failure (including its traceback and exception) and
the index of the L{FirstError}.
zFirstError[#%d, %s])r\ r[ r� s rE r zFirstError.__str__d s � � %��
�
�D�O�O�'D�D�DrD c � � t |t � r8t | j | j f|j |j f� S y)a+
Comparison between L{FirstError} and other L{FirstError} instances
is defined as the comparison of the index and sub-failure of each
instance. L{FirstError} instances don't compare equal to anything
that isn't a L{FirstError} instance.
@since: 8.2
r� )rp rX r1 r\ r[ )r� �others rE �__cmp__zFirstError.__cmp__l s: � � �e�Z� (���
�
�D�O�O�4�u�{�{�E�DT�DT�6U�V� V�rD N)rQ r5 r\ �intr� r� r� )r` r� r� rb )r? r@ rA rB r� rR r ra rC rD rE rX rX N s � ���
K�E� rD rX Fc � � y re rC �� deferredList�fireOnOneCallback�fireOnOneErrback�
consumeErrorss rE �
_DeferredListri � r� rD c � � y re rC rd s rE ri ri � r� rD c � � y re rC rd s rE ri ri � r� rD c �V � e Zd ZdZdZdZ d dd�Z d d�Zd
d�Zy) � DeferredLista)
L{DeferredList} is a tool for collecting the results of several Deferreds.
This tracks a list of L{Deferred}s for their results, and makes a single
callback when they have all completed. By default, the ultimate result is a
list of (success, result) tuples, 'success' being a boolean.
L{DeferredList} exposes the same API that L{Deferred} does, so callbacks and
errbacks can be added to it in the same way.
L{DeferredList} is implemented by adding callbacks and errbacks to each
L{Deferred} in the list passed to it. This means callbacks and errbacks
added to the Deferreds before they are passed to L{DeferredList} will change
the result that L{DeferredList} sees (i.e., L{DeferredList} is not special).
Callbacks and errbacks can also be added to the Deferreds after they are
passed to L{DeferredList} and L{DeferredList} may change the result that
they see.
See the documentation for the C{__init__} arguments for more information.
@ivar _deferredList: The L{list} of L{Deferred}s to track.
Fc � � t |� | _ dgt | j � z | _ t j | � t | j � dk( r|s| j
g � || _ || _ || _ d| _
d}| j D ]< }|j | j | j |t f|t f�� |dz }�> y)aj
Initialize a DeferredList.
@param deferredList: The deferreds to track.
@param fireOnOneCallback: (keyword param) a flag indicating that this
L{DeferredList} will fire when the first L{Deferred} in
C{deferredList} fires with a non-failure result without waiting for
any of the other Deferreds. When this flag is set, the DeferredList
will fire with a two-tuple: the first element is the result of the
Deferred which fired; the second element is the index in
C{deferredList} of that Deferred.
@param fireOnOneErrback: (keyword param) a flag indicating that this
L{DeferredList} will fire when the first L{Deferred} in
C{deferredList} fires with a failure result without waiting for any
of the other Deferreds. When this flag is set, if a Deferred in the
list errbacks, the DeferredList will errback with a L{FirstError}
failure wrapping the failure of that Deferred.
@param consumeErrors: (keyword param) a flag indicating that failures in
any of the included L{Deferred}s should not be propagated to
errbacks added to the individual L{Deferred}s after this
L{DeferredList} is constructed. After constructing the
L{DeferredList}, any errors in the individual L{Deferred}s will be
converted to a callback result of L{None}. This is useful to
prevent spurious 'Unhandled error in Deferred' messages from being
logged. This does not prevent C{fireOnOneErrback} from working.
Nr �r� r� rv )�list�
_deferredList�len�
resultListrU r� rV rf rg rh �
finishedCountr� � _cbDeferred�SUCCESS�FAILURE)r� re rf rg rh r\ ry s rE r� zDeferredList.__init__� s� � �B "�,� /���
KO��RU� � � �S
� J
��� � ���$� � �t�!�!� "�a� '�0A� �M�M�"� �
"3�� � 0�� � *��� ����� �*�*� �H� � !� !�� � �� � � #�W� -� "�G� ,�
"�
� �A�I�E� rD c �$ � ||f| j |< | xj dz
c_ | j s�|t k( r | j r| j ||f� n�|t k( rC| j r7t |t � sJ �| j t t ||� � � nR| j t | j � k( r0| j t t t | j � � |t k( r
| j ry|S )zI
(internal) Callback for when one of my deferreds fires.
rv N)rs rt r� rv rf rV rw rg rp r5 r\ rX rr r% �_DeferredListResultListTr rh )r� rX r\ � succeededs rE ru zDeferredList._cbDeferred s� � � #,�V�!4����� � ���a� ���{�{��G�#��(>�(>��
�
�v�u�o�.��g�%�$�*?�*?�!�&�'�2�2�2�� � �W�Z���%>� ?�@��#�#�s�4�?�?�';�;� �
�
�d�#;�C�#@�$�/�/� R�S� �� �D�$6�$6���
rD c � � | j s#| j D ] } |j � � yy# t $ r t j d� Y �8w xY w)a�
Cancel this L{DeferredList}.
If the L{DeferredList} hasn't fired yet, cancel every L{Deferred} in
the list.
If the L{DeferredList} has fired, including the case where the
C{fireOnOneCallback}/C{fireOnOneErrback} flag is set and the
L{DeferredList} fires because one L{Deferred} in the list fires with a
non-failure/failure result, do nothing in the C{cancel} method.
z-Exception raised from user supplied cancellerN)r� rq r� r_ rP rQ )r� ry s rE r� zDeferredList.cancel sW � � �{�{� � .� .�
Q��Q� �O�O�%�
Q� �� %� Q��K�K� O�P�Q�s �1� A�AN�FFF)re � Iterable[Deferred[_SelfResultT]]rf r� rg r� rh r� )rX r� r\ rb rz r� r� zOptional[_SelfResultT]r� ) r? r@ rA rB rf rg r� ru r� rC rD rE rm rm � s| � ��, �� ��
#(�!&� #� D �6�D � �D � � D �
� D �L�"��+.��;?�� ��4QrD rm c �\ � | D ] }|�J �|\ }}|r�J � | D �cg c] }|d �� c}S c c}w )Nrv rC )rs rg rX �successr� r s rE �_parseDeferredListResultr� 4 sL � � � � �F��%� %�%� #�N�G�U��N�7� � %� %�Q�A�a�D� %�%�� %s � )c �D � t | d|�� j t � S )a
Returns, via a L{Deferred}, a list with the results of the given
L{Deferred}s - in effect, a "join" of multiple deferred operations.
The returned L{Deferred} will fire when I{all} of the provided L{Deferred}s
have fired, or when any one of them has failed.
This method can be cancelled by calling the C{cancel} method of the
L{Deferred}, all the L{Deferred}s in the list will be cancelled.
This differs from L{DeferredList} in that you don't need to parse
the result for success/failure.
@param consumeErrors: (keyword param) a flag, defaulting to False,
indicating that failures in any of the given L{Deferred}s should not be
propagated to errbacks added to the individual L{Deferred}s after this
L{gatherResults} invocation. Any such errors in the individual
L{Deferred}s will be converted to a callback result of L{None}. This
is useful to prevent spurious 'Unhandled error in Deferred' messages
from being logged. This parameter is available since 11.1.0.
T)rg rh )rm r� r� )re rh s rE �
gatherResultsr� ? s# � �0 ��t�=� ��k�*�+�,rD c �$ � � e Zd ZdZd� fd� Z� xZS )� FailureGroupz)
More than one failure occurred.
c �8 �� t t | � � || _ y re )�superr� r� �failures)r� r� r s �rE r� zFailureGroup.__init__a s �� �
�l�D�*�,� ��
rD )r� zSequence[Failure]r� r� )r? r@ rA rB r� �
__classcell__)r s @rE r� r� \ s �� ��!� !rD r� c �� ���� � d� d�fd� }t |�� �d��� fd� }g �d ���fd� }t | � �t | � D ] \ }}|j |||f|f�� � �S )
aV
Select the first available result from the sequence of Deferreds and
cancel the rest.
@return: A cancellable L{Deferred} that fires with the index and output of
the element of C{ds} to have a success result first, or that fires
with L{FailureGroup} holding a list of their failures if they all
fail.
Nc �4 �� �D ] }|j � � y re r� )rX rY � to_cancels �rE r� zrace.<locals>.cancelx s �� �
� �A�
�H�H�J� rD �r� c �t �� ��5�| ��D ] }|�us�|j � � �j || f� y y re r9 )� this_output�
this_indexrY � final_resultr� �winners ���rE rz zrace.<locals>.succeeded� sO �� � �>� �z�*�F� �
���F�?��H�H�J�
�
� !� !�:�{�";� <� rD c �� �� �j || f� t �� t �� k( r?�j � �D ��cg c] \ }}|�� }}}�j t |� � y y c c}}w re )r� rr �sortr\ r� )rQ r� �ignoredrg r� �
failure_stater� r� s ���rE �failedzrace.<locals>.failed� sg �� �� � �j�'� 2�3� �}� ��Y� � /� � � � �.;�<�l�w���<�H�<� � � � �h�!7� 8� 0�� =s � A,ro )rX � Deferred[_T]r� r� )r� r7 r� rb r� r� )rQ r5 r� rb r� r� )rU rp � enumerater� )
�dsr� rz r� r\ rY r� r� r� r� s
@@@@rE �racer� f sr �� � &*�F�� .6��-G�L�=�0 �M�9� �R��I� �b�M� W���q�
���y�&��x�e�X��V� W� �rD Tc �0 � e Zd ZU dZeZded< dd�Zdd�Zy) �waitForDeferred�#
See L{deferredGenerator}.
r rX c � � t j dt d�� t |t � st d|�d�� �|| _ y )Nz�twisted.internet.defer.waitForDeferred was deprecated in Twisted 15.0.0; please use twisted.internet.defer.inlineCallbacks instead� )�
stacklevelz6You must give waitForDeferred a Deferred. You gave it �.)�warnings�warn�DeprecationWarningrp rU � TypeErrorrY r� s rE r� zwaitForDeferred.__init__� sI � ��
�
�
�
��
� �!�X�&��H���Q�O��
� ��rD c � � t | j t � r| j j � | j t u | j S re )rp rX r5 �raiseExceptionr� r� s rE � getResultzwaitForDeferred.getResult� s6 � � �d�k�k�7� +� �K�K� &� &� (� � � �:�%��{�{�rD N)rY r> r� r� )r� r ) r? r@ rA rB r� rX r� r� r� rC rD rE r� r� � s � �� �F�C� �
� rD r� c � � ��� d}ddg� t � � }t |t � rt t d� � S t |t � rPt t |� f d�� �fd�
}|j j |� �d rd�d< �S d�d< d�d< d}��# t $ r �j |� �cY S t $ r �j � �cY S w xY w) r� NTrv z Yield waitForDeferred(d), not d!c �L �� | |_ �d r d�d< | �d< y t ��� y )Nr Frv )rX �_deferGenerator)�rrX ry �g�waitings ���rE � gotResultz"_deferGenerator.<locals>.gotResult s/ �� � !"��
��1�:�!&�G�A�J�!"�G�A�J�#�A�x�0rD r F)r� r� rX r� r� r� )
�nextr rV r_ r\ rp rU r] r� r� r% rY r� )r� ry rX r� r� s `` @rE r� r� � s� �� � �F� �� �G�
� ��!�W�F� �f�h� '�� �"D�E�F� F� �f�o� .� 6:�/�6�5R�
1��
1�#2�
1��
1�
�H�H� � �Y� '��q�z� #���
� �� �G�A�J� �G�A�J��F�S �� � � � � �f� %��O� � � � � � ��O� �s � B � C�:C�C� z&twisted.internet.defer.inlineCallbacksc �0 � � t � � d� fd� � }|S )aI
L{deferredGenerator} and L{waitForDeferred} help you write
L{Deferred}-using code that looks like a regular sequential function.
Consider the use of L{inlineCallbacks} instead, which can accomplish
the same thing in a more concise manner.
There are two important functions involved: L{waitForDeferred}, and
L{deferredGenerator}. They are used together, like this::
@deferredGenerator
def thingummy():
thing = waitForDeferred(makeSomeRequestResultingInDeferred())
yield thing
thing = thing.getResult()
print(thing) #the result! hoorj!
L{waitForDeferred} returns something that you should immediately yield; when
your generator is resumed, calling C{thing.getResult()} will either give you
the result of the L{Deferred} if it was a success, or raise an exception if it
was a failure. Calling C{getResult} is B{absolutely mandatory}. If you do
not call it, I{your program will not work}.
L{deferredGenerator} takes one of these waitForDeferred-using generator
functions and converts it into a function that returns a L{Deferred}. The
result of the L{Deferred} will be the last value that your generator yielded
unless the last value is a L{waitForDeferred} instance, in which case the
result will be L{None}. If the function raises an unhandled exception, the
L{Deferred} will errback instead. Remember that C{return result} won't work;
use C{yield result; return} in place of that.
Note that not yielding anything from your generator will make the L{Deferred}
result in L{None}. Yielding a L{Deferred} from your generator is also an error
condition; always yield C{waitForDeferred(d)} instead.
The L{Deferred} returned from your deferred generator may also errback if your
generator raised an exception. For example::
@deferredGenerator
def thingummy():
thing = waitForDeferred(makeSomeRequestResultingInDeferred())
yield thing
thing = thing.getResult()
if thing == 'I love Twisted':
# will become the result of the Deferred
yield 'TWISTED IS GREAT!'
return
else:
# will trigger an errback
raise Exception('DESTROY ALL LIFE')
Put succinctly, these functions connect deferred-using code with this 'fake
blocking' style in both directions: L{waitForDeferred} converts from a
L{Deferred} to the 'blocking' style, and L{deferredGenerator} converts from the
'blocking' style to a L{Deferred}.
c �8 �� t �| i |��t � � S re )r� rU )ra rb rg s �rE �unwindGeneratorz*deferredGenerator.<locals>.unwindGeneratorW s �� � �q�$� 1�&� 1�8�:�>�>rD )ra r� rb r� r� r> r �rg r� s ` rE �deferredGeneratorr� s$ �� �x �1�X�?� �?� �rD c � � e Zd Zdd�Zy)�_DefGen_Returnc � � || _ y re )r� )r� r� s rE r� z_DefGen_Return.__init__b s � ���
rD N)r� r� r� r� )r? r@ rA r� rC rD rE r� r� a s � �rD r� c � � t | � �)a�
Return val from a L{inlineCallbacks} generator.
Note: this is currently implemented by raising an exception
derived from L{BaseException}. You might want to change any
'except:' clauses to an 'except Exception:' clause so as not to
catch this exception.
Also: while this function currently will work when called from
within arbitrary functions called from within the generator, do
not rely upon this behavior.
)r� )�vals rE � returnValuer� f s � � ��
� rD )� auto_attribsc �* � e Zd ZU dZded< dZded< y)�_CancellationStatusa,
Cancellation status of an L{inlineCallbacks} invocation.
@ivar deferred: the L{Deferred} to callback or errback when the generator
invocation has finished.
@ivar waitingOn: the L{Deferred} being waited upon (which
L{_inlineCallbacks} must fill out before returning)
rL ry Nz Optional[Deferred[_SelfResultT]]� waitingOn)r? r@ rA rB r� r� rC rD rE r� r� v s � �� %�$�26�I�/�6rD r� c �@ � |d r d|d< | |d< yt | |||� y)a�
Helper for L{_inlineCallbacks} to handle a nested L{Deferred} firing.
@param r: The result of the L{Deferred}
@param waiting: Whether the L{_inlineCallbacks} was waiting, and the result.
@param gen: a generator object returned by calling a function or method
decorated with C{@}L{inlineCallbacks}
@param status: a L{_CancellationStatus} tracking the current status of C{gen}
@param context: the contextvars context to run `gen` in
r Frv N)�_inlineCallbacks)r� r� �gen�status�contexts rE �_gotResultInlineCallbacksr� � s+ � �( �q�z����
����
���C���1rD c �D � ddg}d}d} t | t � }|r+|j t t | � j |� } n |j |j
| � } |r |j, j1 |� yt | t2 � r:| j5 t6 ||||� |d
r
d|d
< | |_ y|d } d|d
< d|d< ��# t $ r}d}t |dd� }Y d}~��d}~wt $ �r�}t � } | �J �| d }
|
�J �|
j } | �J �t r| j } | �J �r| j } | �J �| j �J �| j j r�| } | �J �| j �J �| j j r'| j } | �J �| j j r�'| j j j }
| j }| j �J �| j �J �t! j" d| j j j$ �d| j j j$ �d �t& |
|� d}|j( }Y d}~��d}~wt* $ r |j, j/ � Y yw xY w) ar
Carry out the work of L{inlineCallbacks}.
Iterate the generator produced by an C{@}L{inlineCallbacks}-decorated
function, C{gen}, C{send()}ing it the results of each value C{yield}ed by
that generator, until a L{Deferred} is yielded, at which point a callback
is added to that L{Deferred} to call this function again.
@param result: The last result seen by this generator. Note that this is
never a L{Deferred} - by the time this function is invoked, the
L{Deferred} has been called back and this will be a particular result
at a point in its callback chain.
@param gen: a generator object returned by calling a function or method
decorated with C{@}L{inlineCallbacks}
@param status: a L{_CancellationStatus} tracking the current status of C{gen}
@param context: the contextvars context to run `gen` in
TNFrv r� r� zreturnValue() in z causing zX to exit: returnValue should only be invoked by functions decorated with inlineCallbacksr ) rp r5 �runr% �throwExceptionIntoGeneratorr r r r� r �tb_next�
_oldPypyStack�tb_frame�f_code� co_filename� tb_linenor� �
warn_explicit�co_namer� r� r_ ry r\ rV rU r� r� r� )rX r� r� r� r� �
stopIteration�
callbackValue� isFailure�e�excInfor� � appCodeTrace�
ultimateTrace�filename�linenos rE r� r� � s� � �H �� �G� �M� �M�
�Z �"�6�7�3�I�� �����&�)�E�E�s��� !���S�X�X�v�6��f �
�O�O� $� $�]� 3� � �f�h� '� �N�N�4�g�s�F�G� T��q�z� #���
�#)�� �� �Q�Z�F� �G�A�J� �G�A�J�k �� � 6� �M� #�A�w�� 5�M�� � G $� �j�G��&� &�&� ��
�I� �(� (�(�$�,�,�L� �+� +�+� � ,� 3� 3� �#�/�/�/�� ,� 3� 3� �#�/�/�/� �'�'�3� 3�3��#�#�+�+�
!-�
�$�0�0�0�$�,�,�8�8�8�#�+�+�3�3�$1�$9�$9�M�(�4�4�4� $�+�+�3�3� )�1�1�8�8�D�D��&�0�0��$�-�-�9�9�9�#�,�,�8�8�8��&�&�
&�.�.�5�5�=�=�$�-�-�4�4�<�<� � '� �� � !�M� �G�G�M�� � � �O�O� #� #� %� � �s2 �AC
�
J �C*�*
J �7CI6�;B5I6�6&J � J c � � g | j c| _ }| j t |� } | j j |� | j t � � y)z�
Helper for L{_cancellableInlineCallbacks} to add
L{_handleCancelInlineCallbacks} as the first errback.
@param it: The L{Deferred} to add the errback to.
@param status: a L{_CancellationStatus} tracking the current status of C{gen}
N)r� r� � _handleCancelInlineCallbacks�extendr\ �&_InternalInlineCallbacksCancelledError)�itr� �tmps rE � _addCancelCallbackToDeferredr� A sI � � �B�L�L��B�L�#� � � �3�V� <�B��L�L���� ��J�J�5�7�8rD c � �� | j t � t �fd�� �_ �j }|�J �|j � �j S )a�
Propagate the cancellation of an C{@}L{inlineCallbacks} to the
L{Deferred} it is waiting on.
@param result: An L{_InternalInlineCallbacksCancelledError} from
C{cancel()}.
@param status: a L{_CancellationStatus} tracking the current status of C{gen}
@return: A new L{Deferred} that the C{@}L{inlineCallbacks} generator
can callback or errback through.
c � �� t | �� S re �r� �rY r� s �rE �<lambda>z._handleCancelInlineCallbacks.<locals>.<lambda>_ s �� �)E�a��)P� rD )r� r� rU ry r� r� )rX r� �awaiteds ` rE r� r� Q sL �� � �K�K�6�7� � P�Q�F�O� � � �G� � � � � �N�N�� �?�?�rD c �f �� t �fd�� }t |� �t d| �t � � |S )z�
Make an C{@}L{inlineCallbacks} cancellable.
@param gen: a generator object returned by calling a function or method
decorated with C{@}L{inlineCallbacks}
@return: L{Deferred} for the C{@}L{inlineCallbacks} that is cancellable.
c � �� t | �� S re r� r� s �rE r� z-_cancellableInlineCallbacks.<locals>.<lambda>y s �� �0L�Q�PV�0W� rD N)rU r� r� �
_copy_context)r� ry r� s @rE rD rD j s/ �� � &�&W� X�H�
��
*�F��T�3��
��8� �OrD c � � e Zd ZdZy)r� z�
A unique exception used only in L{_cancellableInlineCallbacks} to verify
that an L{inlineCallbacks} is being cancelled as expected.
Nr> rC rD rE r� r� � rF rD r� c �0 � � t � � d� fd� � }|S )a
L{inlineCallbacks} helps you write L{Deferred}-using code that looks like a
regular sequential function. For example::
@inlineCallbacks
def thingummy():
thing = yield makeSomeRequestResultingInDeferred()
print(thing) # the result! hoorj!
When you call anything that results in a L{Deferred}, you can simply yield it;
your generator will automatically be resumed when the Deferred's result is
available. The generator will be sent the result of the L{Deferred} with the
'send' method on generators, or if the result was a failure, 'throw'.
Things that are not L{Deferred}s may also be yielded, and your generator
will be resumed with the same object sent back. This means C{yield}
performs an operation roughly equivalent to L{maybeDeferred}.
Your inlineCallbacks-enabled generator will return a L{Deferred} object, which
will result in the return value of the generator (or will fail with a
failure object if your generator raises an unhandled exception). Note that
you can't use C{return result} to return a value; use C{returnValue(result)}
instead. Falling off the end of the generator, or simply using C{return}
will cause the L{Deferred} to have a result of L{None}.
Be aware that L{returnValue} will not accept a L{Deferred} as a parameter.
If you believe the thing you'd like to return could be a L{Deferred}, do
this::
result = yield result
returnValue(result)
The L{Deferred} returned from your deferred generator may errback if your
generator raised an exception::
@inlineCallbacks
def thingummy():
thing = yield makeSomeRequestResultingInDeferred()
if thing == 'I love Twisted':
# will become the result of the Deferred
returnValue('TWISTED IS GREAT!')
else:
# will trigger an errback
raise Exception('DESTROY ALL LIFE')
It is possible to use the C{return} statement instead of L{returnValue}::
@inlineCallbacks
def loadData(url):
response = yield makeRequest(url)
return json.loads(response)
You can cancel the L{Deferred} returned from your L{inlineCallbacks}
generator before it is fired by your generator completing (either by
reaching its end, a C{return} statement, or by calling L{returnValue}).
A C{CancelledError} will be raised from the C{yield}ed L{Deferred} that
has been cancelled if that C{Deferred} does not otherwise suppress it.
c � �� �| i |��}t |t � st d��d|��� �t |� S # t $ r t d��d�� �w xY w)NzinlineCallbacks requires zP to produce a generator; insteadcaught returnValue being used in a non-generatorz% to produce a generator; instead got )r� r� rp r rD )ra rb r� rg s �rE r� z(inlineCallbacks.<locals>.unwindGenerator� sn �� � ��T�$�V�$�C� �#�}�-��$%�s�,��
� +�3�/�/�� � ��FG�J��
� �s �7 �A)ra rG rb rH r� r� r r� s ` rE �inlineCallbacksr� � s$ �� �| �1�X�
0� �
0� �rD c �� � e Zd Zd d�Zd
d�Ze dd�� Ze dd�� Ze dd�� Z dd�Zdd�Z dd�Ze dd �� Z
e dd
�� Z y )�_ConcurrencyPrimitivec � � g | _ y re )r� r� s rE r� z _ConcurrencyPrimitive.__init__� s � �-/�� rD c �& � | j � |S re )�release)r� r� s rE �_releaseAndReturnz'_ConcurrencyPrimitive._releaseAndReturn� s � � � � ���rD c � � y re rC �r� rg ra rb s rE r� z_ConcurrencyPrimitive.run� � � � rD c � � y re rC r� s rE r� z_ConcurrencyPrimitive.run� r� rD c � � y re rC r� s rE r� z_ConcurrencyPrimitive.run� s � � rD c �Z � ���� d���� fd� }� j � j |� S )a�
Acquire, run, release.
This method takes a callable as its first argument and any
number of other positional and keyword arguments. When the
lock or semaphore is acquired, the callable will be invoked
with those arguments.
The callable may return a L{Deferred}; if it does, the lock or
semaphore won't be released until that L{Deferred} fires.
@return: L{Deferred} of function result.
c �T �� t �g���i ���j �j � S re )rh r� r� )�
ignoredResultra rg rb r� s ����rE rc z*_ConcurrencyPrimitive.run.<locals>.execute s0 �� � !��4�T�4�V�4�<�<��&�&��
rD )r� r� r� r� )�acquirer� )r� rg ra rb rc s ```` rE r� z_ConcurrencyPrimitive.run� s& �� �* � � �|�|�~�)�)�'�2�2rD c �" � | j � S )zD
We can be used as an asynchronous context manager.
)r� r� s rE �
__aenter__z _ConcurrencyPrimitive.__aenter__ s � � �|�|�~� rD c �8 � | j � t d� S )NF)r� rZ )r� � _ConcurrencyPrimitive__exc_type� _ConcurrencyPrimitive__exc_value� _ConcurrencyPrimitive__tracebacks rE � __aexit__z _ConcurrencyPrimitive.__aexit__" s � �
� � �� �u�~� rD c � � y re rC r� s rE r� z _ConcurrencyPrimitive.acquire- � � � rD c � � y re rC r� s rE r� z _ConcurrencyPrimitive.release1 r rD N�r� r+ r� r� )r� r7 r� r7 )
rg �Callable[_P, Deferred[_T]]r� r+ ra rG rb rH r� r� )
rg �/Callable[_P, Coroutine[Deferred[Any], Any, _T]]r� r+ ra rG rb rH r� r� )
rg �Callable[_P, _T]r� r+ ra rG rb rH r� r� )
rg �HCallable[_P, Union[Deferred[_T], Coroutine[Deferred[Any], Any, _T], _T]]r� r+ ra rG rb rH r� r� �r� r+ r� �Deferred[Self])r z Optional[Type[BaseException]]r zOptional[BaseException]r zOptional[TracebackType]r� zDeferred[Literal[False]]r� ) r? r@ rA r� r� r& r� r� r r r� r� rC rD rE r� r� � s^ � �0�� � � &� �� � � �
� �
�
� � � � � ;� �� � � �
� �
�
� � � � �*� �� �3:� �FO� � � � � �
3� T� 3�� 3� � 3�
� 3�
�
3�< � �1� � -� � -� �
"� � �
� �
� �
� �
rD r� c �, � e Zd ZdZdZdd�Zdd�Zd d�Zy)
� DeferredLockz�
A lock for event driven systems.
@ivar locked: C{True} when this Lock has been acquired, false at all other
times. Do not change this value, but it is useful to examine for the
equivalent of a "non-blocking" acquisition.
Fc �: � | j j |� y�a�
Remove a deferred d from our waiting list, as the deferred has been
canceled.
Note: We do not need to wrap this in a try/except to catch d not
being in self.waiting because this canceller will not be called if
d has fired. release() pops a deferred out of self.waiting and
calls it, so the canceller will no longer be called.
@param d: The deferred that has been canceled.
N�r� �remover� s rE �_cancelAcquirezDeferredLock._cancelAcquireA � � �
� � ���A� rD c � � t | j �� }| j r | j j |� |S d| _ |j | � |S )aL
Attempt to acquire the lock. Returns a L{Deferred} that fires on
lock acquisition with the L{DeferredLock} as the value. If the lock
is locked, then the Deferred is placed at the end of a waiting list.
@return: a L{Deferred} which fires on lock acquisition.
@rtype: a L{Deferred}
r� T)rU r �lockedr� r� rV r� s rE r� zDeferredLock.acquireO sN � � %�t�/B�/B� C�� �;�;� �L�L� � �� "� �� �D�K�
�J�J�t� ��rD c � � | j sJ d� �d| _ | j r4d| _ | j j d� }|j | � yy)z�
Release the lock. If there is a waiting list, then the first
L{Deferred} in that waiting list will be called back.
Should be called by whomever did the L{acquire}() when the shared
resource is free.
z!Tried to release an unlocked lockFTr N)r r� r rV r� s rE r� zDeferredLock.release` sP � � �{�{�?� ?�?�{��� � �<�<� �D�K�� � � � ��#�A�
�J�J�t� � rD N�r� r+ rY r r� r� r
r )r? r@ rA rB r r r� r� rC rD rE r r 6 s � �� �F� � �" rD r c �0 � e Zd ZdZdd�Zdd�Zd d�Zd
d�Zy) �DeferredSemaphorea�
A semaphore for event driven systems.
If you are looking into this as a means of limiting parallelism, you might
find L{twisted.internet.task.Cooperator} more useful.
@ivar limit: At most this many users may acquire this semaphore at
once.
@ivar tokens: The difference between C{limit} and the number of users
which have currently acquired this semaphore.
c �j � t j | � |dk r t d� �|| _ || _ y)ze
@param tokens: initial value of L{tokens} and L{limit}
@type tokens: L{int}
rv z&DeferredSemaphore requires tokens >= 1N)r� r� �
ValueError�tokens�limit)r� r s rE r� zDeferredSemaphore.__init__~ s3 � �
�&�&�t�,� �A�:� � E�F� F� �� ���
rD c �: � | j j |� yr r r� s rE r z DeferredSemaphore._cancelAcquire� r rD c � � | j dk\ sJ d� �t | j �� }| j s | j j |� |S | j dz
| _ |j | � |S )zq
Attempt to acquire the token.
@return: a L{Deferred} which fires on token acquisition.
r z9Internal inconsistency?? tokens should never be negativer� rv )r rU r r� r� rV r� s rE r� zDeferredSemaphore.acquire� st � �
�K�K�1� � G� F� G� � $�t�/B�/B� C���{�{� �L�L� � �� "� �� �+�+��/�D�K�
�J�J�t� ��rD c � � | j | j k sJ d� �| j dz | _ | j rA| j dz
| _ | j j d� }|j | � yy)z�
Release the token.
Should be called by whoever did the L{acquire}() when the shared
resource is free.
z4Someone released me too many times: too many tokens!rv r N)r r r� r rV r� s rE r� zDeferredSemaphore.release� sp � �
�K�K�$�*�*� $� B� A� B� $��k�k�A�o�� � �<�<� �+�+��/�D�K�� � � � ��#�A�
�J�J�t� � rD N)r rb r� r� r r
r )r? r@ rA rB r� r r� r� rC rD rE r r q s � �
� � � �" rD r c � � e Zd Zy)�
QueueOverflowN�r? r@ rA rC rD rE r% r% � � � �rD r% c � � e Zd Zy)�QueueUnderflowNr& rC rD rE r) r) � r' rD r) c �> � e Zd ZdZ d dd�Zd d�Zd
d�Zd d�Zy) �
DeferredQueuea�
An event driven queue.
Objects may be added as usual to this queue. When an attempt is
made to retrieve an object when the queue is empty, a L{Deferred} is
returned which will fire when an object becomes available.
@ivar size: The maximum number of objects to allow into the queue
at a time. When an attempt to add a new object would exceed this
limit, L{QueueOverflow} is raised synchronously. L{None} for no limit.
@ivar backlog: The maximum number of L{Deferred} gets to allow at
one time. When an attempt is made to get an object which would
exceed this limit, L{QueueUnderflow} is raised synchronously. L{None}
for no limit.
Nc �< � g | _ g | _ || _ || _ y re )r� �pending�size�backlog)r� r. r/ s rE r� zDeferredQueue.__init__� s � � ,.�� �!#�� ��� � �� rD c �: � | j j |� y)a�
Remove a deferred d from our waiting list, as the deferred has been
canceled.
Note: We do not need to wrap this in a try/except to catch d not
being in self.waiting because this canceller will not be called if
d has fired. put() pops a deferred out of self.waiting and calls
it, so the canceller will no longer be called.
@param d: The deferred that has been canceled.
Nr r� s rE �
_cancelGetzDeferredQueue._cancelGet� r rD c � � | j r+| j j d� j |� y| j �"t | j
� | j k r | j
j
|� yt � �)zq
Add an object to this queue.
@raise QueueOverflow: Too many objects are in this queue.
r N)r� r rV r. rr r- r� r% )r� �objs rE �putzDeferredQueue.put� s` � � �<�<� �L�L� � �Q� � (� (�� -�
�Y�Y�
�#�d�l�l�"3�d�i�i�"?� �L�L� � �� $� �/� !rD c �8 � | j r$t | j j d� � S | j �"t | j
� | j k r3t
| j �� }| j
j |� |S t � �)a3
Attempt to retrieve and remove an object from the queue.
@return: a L{Deferred} which fires with the next object available in
the queue.
@raise QueueUnderflow: Too many (more than C{backlog})
L{Deferred}s are already waiting for an object from this queue.
r r� )
r- rZ r r/ rr r� rU r1 r� r) r� s rE �getzDeferredQueue.get� sq � � �<�<��4�<�<�+�+�A�.�/� /�
�\�\�
!�S�� � �%6�� � �%E� &�� � � A�A� �L�L� � �� "��H� �"� "rD )NN)r. �
Optional[int]r/ r7 r� r� )rY r� r� r� )r3 r7 r� r� )r� r� )r? r@ rA rB r� r1 r4 r6 rC rD rE r+ r+ � s: � ��" DH� �!� �3@� �
� � � "�#rD r+ c � � e Zd ZdZy)�AlreadyTryingToLockErrorz{
Raised when L{DeferredFilesystemLock.deferUntilLocked} is called twice on a
single L{DeferredFilesystemLock}.
Nr> rC rD rE r9 r9
rF rD r9 c �F � e Zd ZU dZdZdZded< dZded< d d
d�Zd d d�Z y) �DeferredFilesystemLockaj
A L{FilesystemLock} that allows for a L{Deferred} to be fired when the lock is
acquired.
@ivar _scheduler: The object in charge of scheduling retries. In this
implementation this is parameterized for testing.
@ivar _interval: The retry interval for an L{IReactorTime} based scheduler.
@ivar _tryLockCall: An L{IDelayedCall} based on C{_interval} that will manage
the next retry for acquiring the lock.
@ivar _timeoutCall: An L{IDelayedCall} based on C{deferUntilLocked}'s timeout
argument. This is in charge of timing out our attempt to acquire the
lock.
rv NzOptional[IDelayedCall]� _tryLockCall� _timeoutCallc � � t j j | |� |�ddlm} t t |� }|| _ y)z�
@param name: The name of the lock to acquire
@param scheduler: An object which provides L{IReactorTime}
Nr )�reactor)r/ �FilesystemLockr� �twisted.internetr? r% r- �
_scheduler)r� �name� schedulerr? s rE r� z DeferredFilesystemLock.__init__$
s6 � �
� � �(�(��t�4� � � 0� �\�7�3�I�#��rD c � � ����� � j �t t d� � S d�� fd� �t �fd�� �d���� �fd� � �� �S )a�
Wait until we acquire this lock. This method is not safe for
concurrent use.
@param timeout: the number of seconds after which to time out if the
lock has not been acquired.
@return: a L{Deferred} which will callback when the lock is acquired, or
errback with a L{TimeoutError} after timing out or an
L{AlreadyTryingToLockError} if the L{deferUntilLocked} has already
been called and not successfully locked the file.
z/deferUntilLocked isn't safe for concurrent use.c �X �� �j �J ��j j � d�_ �j �;�j j � r!�j j � d�_ �j � r�j d� y�j
| � y)z�
Cancel a L{DeferredFilesystemLock.deferUntilLocked} call.
@type reason: L{Failure}
@param reason: The reason why the call is cancelled.
N)r< r� r= r� �lockrV r\ )�reasonrY r� s ��rE � _cancelLockz<DeferredFilesystemLock.deferUntilLocked.<locals>._cancelLockF
s� �� � �$�$�0� 0�0� � � � $� $� &� $�D� �� � �,��1B�1B�1I�1I�1K��!�!�(�(�*�$(��!��y�y�{��
�
�4� �� � �&�!rD c �$ �� �t � � S re )rH )ry rI s �rE r� z9DeferredFilesystemLock.deferUntilLocked.<locals>.<lambda>Y
s �� �k�.�BR�6S� rD c � �� �j � rF�j �!�j j � d �_ d �_ �j d � y ��Q�j �Et t
d�j �fz � � } �j j ��| � �_ �j j �j �� �_ y )Nz&Timed out acquiring lock: %s after %fs) rG r= r� r< rV r5 rK rC rB r� � _interval)rH rI �_tryLockrY r� rz s �����rE rM z9DeferredFilesystemLock.deferUntilLocked.<locals>._tryLock[
s� �� ��y�y�{��$�$�0��%�%�,�,�.�(,�D�%�$(��!��
�
�4� ��&�4�+<�+<�+D� $�$� D� #�y�y�'� 2� 3�� �F� )-���(A�(A� ��f�)�D�%� %)�O�O�$=�$=�d�n�n�h�$W��!rD )rH zUnion[Failure, Exception]r� r� r� )r< r] r9 rU )r� rz rI rM rY s ``@@@rE �deferUntilLockedz'DeferredFilesystemLock.deferUntilLocked2
sS �� � � � � (��(�E���
� "�& %�%S� T�� X� X�. �
��rD re )rC r� rD zOptional[IReactorTime]r� r� )rz zOptional[float]r� zDeferred[None])
r? r@ rA rB rL r< r� r= r� rN rC rD rE r; r;
s/ � � � �I�+/�L�(�/�+/�L�(�/� $� BrD r; )rU rm rZ r] rw rv r= rK r� rh rV r� r� r� r� r r r+ r; r9 rH )rR r5 r� r5 )rX r7 r� rQ re )rX rO r� rJ )r` r ra rG rb rH r� rQ )rg r ra rG rb rH r� rQ )rg r
ra rG rb rH r� rQ )rg r ra rG rb rH r� rQ )rg r ra rG rb rH r� rQ )ry z'Deferred[object]'r� r� )r} r7 r� r7 )r} r5 r� r5 )r� r� r� r� )r� r� )r� r7 rz rM r� r7 )rE zYUnion[Coroutine[Deferred[Any], Any, _T], Generator[Deferred[Any], Any, _T], Deferred[_T]]r� r� )FF)
re r} rf z
Literal[True]rg r� rh r� r� z2Deferred[_DeferredListSingleResultT[_SelfResultT]]r| )
re r} rf zLiteral[False]rg r� rh r� r� z0Deferred[_DeferredListResultListT[_SelfResultT]])
re r} rf r� rg r� rh r� r� zkUnion[Deferred[_DeferredListSingleResultT[_SelfResultT]], Deferred[_DeferredListResultListT[_SelfResultT]]])F)rs z"List[_DeferredListResultItemT[_T]]rg r� r� zList[_T])re zIterable[Deferred[_T]]rh r� r� zDeferred[List[_T]])r� zSequence[Deferred[_T]]r� zDeferred[tuple[int, _T]])r� �_DeferableGeneratorry r> r� z
Deferred[Any])rg z"Callable[..., _DeferableGenerator]r� z Callable[..., Deferred[object]])r� r� r� r ) r� r� r� z List[Any]r� �KUnion[Generator[Deferred[Any], Any, _T], Coroutine[Deferred[Any], Any, _T]]r� �_CancellationStatus[_T]r� �_Contextr� r� )
rX r� r� rP r� rQ r� rR r� r� )r� r� r� rQ r� r� )rX r5 r� rQ r� r� )r� zQUnion[Generator[Deferred[Any], object, _T], Coroutine[Deferred[Any], object, _T]]r� r� )rg z/Callable[_P, Generator[Deferred[Any], Any, _T]]r� r )�rB �
__future__r rB r� r� �abcr r �asyncior r r � contextvarsr rR r
r� �enumr � functoolsr
�sysr r �typesr r r r �typingr r r r r r r r r r r r r r! r" r# r$ r% r& �attr� incrementalr' r( r) r* r+ �twisted.internet.interfacesr, r- �twisted.loggerr. �twisted.pythonr/ �twisted.python.compatr0 r1 r2 �twisted.python.deprecater3 r4 �twisted.python.failurer5 r6 rP r7 r8 �versionr� rZ r= rH rK r� rM rS rZ r] rc rh rz r~ r� r� r� r� r� r� r� r� �DeferredCallback�DeferredErrbackrF r� r� rP r� r� r� r� r� rU rV rX rb �_DeferredListSingleResultTr� �_DeferredListResultItemTry ri rm r� r� r� r� rv rw r� rO r� r� r_ r� r� �sr� r� r� r� r� rD r� r� r� r r r% r) r+ r9 r@ r; �__all__rC rD rE �<module>rk s2 ��
�
#� � � � #� :� :� J� � � (� O� O�� � � � � �, � � 8� 8� B� !� #� 8� 8� B� 7� �h��
�T�]���t�_�� �=�.�0�0�:�=�
��� ��Y� � �9� � �� �
�
�(
� � � �'.� �:C� �� �$
��!��*1��=F����
��
��6�� �� �� � �
��
���� '��3<����
�� <!�O�<!� �<!� �<!� � <!�~ � �I�r�1�a� �<��B� �B��� ���(
��
�" �
!�
!�
� � � � �
�C��K�(� � �3��;�'�� !�&�#�+� .� � #�C��K� 0� �� �
� �� �(;�(;� <�<�=�!�!� #��
�
�o� /���9L�9L�1M�M�N�!�!� #�� � �� +;�2�*>� �'� >� �~�&� ��~�&� �'F� 'F�TjA�y� �&� jA�Z S� �S� �
S�8 �(�� (� �(�V #�<��#4� 5� � ��|�!3�4� � � 8� � F�G� �� � "'� #� �6� �(� � � � � �
<� � � � � -2�!&� #� �6� �)� � � � � �
:� � � � #(�!&� #� �6� � � � � � � �
� � !�L�MQ� �
%�c�
*�+�MQ�b NS�&�2�&�FJ�&�
�&� AF�,�(�,�9=�,��,�:!�9� !�L�` ��
��� �: ���d� 2�3� �=��=�&6�=��=�@ �G�I�r�1�a� (�*R�S�?�)�?�$�?� T�?�J�]� �
� ����T�� 7�'�,�/� 7� � 7� 2�
�2�
�2�
�2�
$�2� �2�
�2�6
�] � �] �
�] �
$�
] � �] �
�] �
�] �@
9��
9� 5�
9� �
9� � �� 4����2�
��
� �.�Y� �N�6�N� �N�hW
�C� W
�t8 �(� 8 �vF �-� F �R �I� � �Y� �E#�G�B�K� E#�P�y� �c�X� 4� 4� c�L �rD
Mini Shell