← Back
Editing: task.cpython-38.pyc
U ��W[�y � @ s� d Z ddlmZmZ eZddlZddlZddlZddl m Z ddl m Z ddl m Z ddlmZ ddlmZ dd lmZ dd lmZmZ dd lmZ dd lmZ G d d� d�ZG dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Z G dd� de �Z!G dd� de �Z"G dd � d e �Z#G d d � d e$�Z%d Z&d d!� Z'G d"d#� d#e$�Z(G d$d%� d%e$�Z)e)� Z*d&d'� Z+d(d)� Z,e e�G d*d+� d+��Z-d,d-� Z.d1d/d0�Z/dd+dd%d'd-d0gZ0dS )2z) Scheduling utility methods and classes. � )�division�absolute_importN)� implementer)�log)�reflect)� _getDeprecationWarningString)�Failure)�Version)�base�defer)� IReactorTime)�ReactorNotRunningc @ s� e Zd ZdZdZdZdZdZdZdZ dd� Z e dd� �Z dd � Z ee �Z d d � Zdd d�Zdd� Zdd� Zdd� Zdd� Zdd� ZdS )� LoopingCalla� Call a function repeatedly. If C{f} returns a deferred, rescheduling will not take place until the deferred has fired. The result value is ignored. @ivar f: The function to call. @ivar a: A tuple of arguments to pass the function. @ivar kw: A dictionary of keyword arguments to pass to the function. @ivar clock: A provider of L{twisted.internet.interfaces.IReactorTime}. The default is L{twisted.internet.reactor}. Feel free to set this to something else, but it probably ought to be set *before* calling L{start}. @type running: C{bool} @ivar running: A flag which is C{True} while C{f} is scheduled to be called (or is currently being called). It is set to C{True} when L{start} is called and set to C{False} when L{stop} is called or if C{f} raises an exception. In either case, it will be C{False} by the time the C{Deferred} returned by L{start} fires its callback or errback. @type _realLastTime: C{float} @ivar _realLastTime: When counting skips, the time at which the skip counter was last invoked. @type _runAtStart: C{bool} @ivar _runAtStart: A flag indicating whether the 'now' argument was passed to L{LoopingCall.start}. NFc O s( || _ || _|| _ddlm} || _d S �Nr ��reactor)�f�a�kw�twisted.internetr �clock)�selfr r r r � r �7/usr/lib/python3/dist-packages/twisted/internet/task.py�__init__D s zLoopingCall.__init__c C s. t dtdddd�dd�}tj|tdd� | jS ) z� DEPRECATED. L{Deferred} fired when loop stops or fails. Use the L{Deferred} returned by L{LoopingCall.start}. z*twisted.internet.task.LoopingCall.deferredZTwisted� r z the deferred returned by start())Z replacement� )� stacklevel)r r �warnings�warn�DeprecationWarning� _deferred)r Z warningStringr r r �deferredK s �zLoopingCall.deferredc s � �fdd�}| |��d�_ �S )aW An alternate constructor for L{LoopingCall} that makes available the number of calls which should have occurred since it was last invoked. Note that this number is an C{int} value; It represents the discrete number of calls that should have been made. For example, if you are using a looping call to display an animation with discrete frames, this number would be the number of frames to advance. The count is normally 1, but can be higher. For example, if the reactor is blocked and takes too long to invoke the L{LoopingCall}, a Deferred returned from a previous call is not fired before an interval has elapsed, or if the callable itself blocks for longer than an interval, preventing I{itself} from being called. When running with an interval if 0, count will be always 1. @param countCallable: A callable that will be invoked each time the resulting LoopingCall is run, with an integer specifying the number of calls that should have been invoked. @type countCallable: 1-argument callable which takes an C{int} @return: An instance of L{LoopingCall} with call counting enabled, which provides the count as the first positional argument. @rtype: L{LoopingCall} @since: 9.0 c s| �j �� } �jdkr"| �_� d�S �j}|d krF�j}�jrF|�j8 }��|�}��| �}|| }|dkrx| �_� |�S d S )Nr � )r �seconds�interval� _realLastTime� starttime� _runAtStart� _intervalOf)�nowZlastTimeZ lastIntervalZ thisInterval�count�� countCallabler r r �counterz s z&LoopingCall.withCount.<locals>.counterN)r& )�clsr- r. r r, r � withCountZ s zLoopingCall.withCountc C s || j }t|| j �}|S )aD Determine the number of intervals passed as of the given point in time. @param t: The specified time (from the start of the L{LoopingCall}) to be measured in intervals @return: The C{int} number of intervals which have passed as of the given point in time. )r' �intr% )r �tZ elapsedTimeZ intervalNumr r r r) � s zLoopingCall._intervalOfTc C sf | j rtd��|dk r td��d| _ t�� }| _| j�� | _|| _ || _ |rV| � n | � | j� |S )a� Start running function every interval seconds. @param interval: The number of seconds between calls. May be less than one. Precision will depend on the underlying platform, the available hardware, and the load on the system. @param now: If True, run this call right now. Otherwise, wait until the interval has elapsed before beginning. @return: A Deferred whose callback will be invoked with C{self} when C{self.stop} is called, or whose errback will be invoked when the function raises an exception or returned a deferred that has its errback invoked. z.Tried to start an already running LoopingCall.r zinterval must be >= 0T) �running�AssertionError� ValueErrorr �Deferredr! r r$ r' r% r( � _scheduleFrom)r r% r* r" r r r �start� s zLoopingCall.startc C sJ | j std��d| _ | jdk rF| j�� d| _| jd }| _|�| � dS )z Stop running function. z1Tried to stop a LoopingCall that was not running.FN)r3 r4 �call�cancelr! �callback�r �dr r r �stop� s zLoopingCall.stopc C sD | j std��| jdk r@| j�� d| _| j�� | _| �| j� dS )zT Skip the next iteration and reset the timer. @since: 11.1 z2Tried to reset a LoopingCall that was not running.N)r3 r4 r9 r: r r$ r' r7 �r r r r �reset� s zLoopingCall.resetc sN � fdd�}� fdd�}d � _ tj� jf� j�� j�}|�|� |�|� d S )Nc s4 � j r� �� j�� � n� jd }� _|�� � d S �N)r3 r7 r r$ r! r; )�resultr= r? r r �cb� s z LoopingCall.__call__.<locals>.cbc s" d� _ � jd }� _|�| � d S )NF)r3 r! Zerrback)Zfailurer= r? r r �eb� s z LoopingCall.__call__.<locals>.eb)r9 r Z maybeDeferredr r r � addCallbackZ addErrback)r rC rD r= r r? r �__call__� s zLoopingCall.__call__c s$ � �fdd�}� j �|� � �� _dS )z� Schedule the next iteration of this looping call. @param when: The present time from whence the call is scheduled. c s> � j dkrdS �� j } � j | � j }��| kr:� j S |S )Nr )r% r' )Z runningForZuntilNextInterval�r �whenr r �howLong� s z*LoopingCall._scheduleFrom.<locals>.howLongN)r � callLaterr9 )r rH rI r rG r r7 � s zLoopingCall._scheduleFromc C sx t | jd�r| jj}n@t | jd�rJ| jj}t | jd�rV| jjjd | }n t�| j�}d| j|t�| j�t�| j �f S )N� __qualname__�__name__�im_class�.z LoopingCall<%r>(%s, *%s, **%s)) �hasattrr rK rL rM r Z safe_reprr% r r )r �funcr r r �__repr__ s �zLoopingCall.__repr__)T)rL � __module__rK �__doc__r9 r3 r! r% r( r' r �propertyr" r0 � classmethodr) r8 r> r@ rF r7 rQ r r r r r s& 9 ! #r c @ s e Zd ZdZdS )�SchedulerErrorz� The operation could not be completed because the scheduler or one of its tasks was in an invalid state. This exception should not be raised directly, but is a superclass of various scheduler-state-related exceptions. N�rL rR rK rS r r r r rV ' s rV c @ s e Zd ZdZdS )�SchedulerStoppedzt The operation could not complete because the scheduler was stopped in progress or was already stopped. NrW r r r r rX 1 s rX c @ s e Zd ZdZdS )� TaskFinishedz� The operation could not complete because the task was already completed, stopped, encountered an error or otherwise permanently stopped running. NrW r r r r rY 9 s rY c @ s e Zd ZdZdS )�TaskDonezR The operation could not complete because the task was already completed. NrW r r r r rZ A s rZ c @ s e Zd ZdZdS )� TaskStoppedzH The operation could not complete because the task was stopped. NrW r r r r r[ H s r[ c @ s e Zd ZdZdS )� TaskFailedz] The operation could not complete because the task died with an unhandled error. NrW r r r r r\ O s r\ c @ s e Zd ZdZdS )� NotPausedz^ This exception is raised when a task is resumed which was not previously paused. NrW r r r r r] W s r] c @ s e Zd ZdZdd� Zdd� ZdS )�_Timerg{�G�z�?c C s t � � | j | _d S rA )�time� MAX_SLICE�endr? r r r r a s z_Timer.__init__c C s t � � | jkS rA )r_ ra r? r r r rF e s z_Timer.__call__N)rL rR rK r` r rF r r r r r^ _ s r^ g:�0�yE>c C s ddl m} |�t| �S r )r r rJ �_EPSILON)�xr r r r �_defaultSchedulerk s rd c @ sP e Zd ZdZdd� Zdd� Zdd� Zdd � Zd d � Zd d � Z dd� Z dd� Z dS )�CooperativeTaska� A L{CooperativeTask} is a task object inside a L{Cooperator}, which can be paused, resumed, and stopped. It can also have its completion (or termination) monitored. @see: L{Cooperator.cooperate} @ivar _iterator: the iterator to iterate when this L{CooperativeTask} is asked to do work. @ivar _cooperator: the L{Cooperator} that this L{CooperativeTask} participates in, which is used to re-insert it upon resume. @ivar _deferreds: the list of L{defer.Deferred}s to fire when this task completes, fails, or finishes. @type _deferreds: C{list} @type _cooperator: L{Cooperator} @ivar _pauseCount: the number of times that this L{CooperativeTask} has been paused; if 0, it is running. @type _pauseCount: C{int} @ivar _completionState: The completion-state of this L{CooperativeTask}. L{None} if the task is not yet completed, an instance of L{TaskStopped} if C{stop} was called to stop this task early, of L{TaskFailed} if the application code in the iterator raised an exception which caused it to terminate, and of L{TaskDone} if it terminated normally via raising C{StopIteration}. @type _completionState: L{TaskFinished} c C s2 || _ || _g | _d| _d| _d| _|�| � dS )zq A private constructor: to create a new L{CooperativeTask}, see L{Cooperator.cooperate}. r N)� _iterator� _cooperator� _deferreds� _pauseCount�_completionState�_completionResult�_addTask)r �iteratorZ cooperatorr r r r � s zCooperativeTask.__init__c C s0 t �� }| jdkr | j�|� n |�| j� |S )a� Get a L{defer.Deferred} notification of when this task is complete. @return: a L{defer.Deferred} that fires with the C{iterator} that this L{CooperativeTask} was created with when the iterator has been exhausted (i.e. its C{next} method has raised C{StopIteration}), or fails with the exception raised by C{next} if it raises some other exception. @rtype: L{defer.Deferred} N)r r6 rj rh �appendr; rk r< r r r �whenDone� s zCooperativeTask.whenDonec C s0 | � � | jd7 _| jdkr,| j�| � dS )a@ Pause this L{CooperativeTask}. Stop doing work until L{CooperativeTask.resume} is called. If C{pause} is called more than once, C{resume} must be called an equal number of times to resume this task. @raise TaskFinished: if this task has already finished or completed. r# N)� _checkFinishri rg � _removeTaskr? r r r �pause� s zCooperativeTask.pausec C sB | j dkrt� �| j d8 _ | j dkr>| jdkr>| j�| � dS )z� Resume processing of a paused L{CooperativeTask}. @raise NotPaused: if this L{CooperativeTask} is not paused. r r# N)ri r] rj rg rl r? r r r �resume� s zCooperativeTask.resumec C s8 || _ || _| js | j�| � | jD ]}|�|� q$dS )a @param completionState: a L{TaskFinished} exception or a subclass thereof, indicating what exception should be raised when subsequent operations are performed. @param deferredResult: the result to fire all the deferreds with. N)rj rk ri rg rq rh r; )r ZcompletionStateZdeferredResultr= r r r � _completeWith� s z CooperativeTask._completeWithc C s | � � | �t� tt� �� dS )z� Stop further processing of this task. @raise TaskFinished: if this L{CooperativeTask} has previously completed, via C{stop}, completion, or failure. N)rp rt r[ r r? r r r r> � s zCooperativeTask.stopc C s | j dk r| j �dS )zk If this task has been stopped, raise the appropriate subclass of L{TaskFinished}. N)rj r? r r r rp � s z CooperativeTask._checkFinishc s� zt � j�}W n> tk r2 � �t� � j� Y nP � �t� t� � Y n6X t|tj �r�� � � � fdd�}|� � fdd�|� dS )z� Perform one unit of work for this task, retrieving one item from its iterator, stopping if there are no further items in the iterator, and pausing if the result was a L{defer.Deferred}. c s � � t� | � d S rA )rt r\ )r r? r r � failLater s z/CooperativeTask._oneWorkUnit.<locals>.failLaterc s � � � S rA )rs �rB r? r r �<lambda> � z.CooperativeTask._oneWorkUnit.<locals>.<lambda>N) �nextrf � StopIterationrt rZ r\ r � isinstancer r6 rr Z addCallbacks)r rB ru r r? r � _oneWorkUnit� s �z CooperativeTask._oneWorkUnitN) rL rR rK rS r ro rr rs rt r> rp r| r r r r re p s # re c @ sz e Zd ZdZeedfdd�Zddd�Zdd � Zd d � Z d d � Z dd� Z dd� Z dZ dd� Zdd� Zdd� Zedd� �ZdS ) � Cooperatora� Cooperative task scheduler. A cooperative task is an iterator where each iteration represents an atomic unit of work. When the iterator yields, it allows the L{Cooperator} to decide which of its tasks to execute next. If the iterator yields a L{defer.Deferred} then work will pause until the L{defer.Deferred} fires and completes its callback chain. When a L{Cooperator} has more than one task, it distributes work between all tasks. There are two ways to add tasks to a L{Cooperator}, L{cooperate} and L{coiterate}. L{cooperate} is the more useful of the two, as it returns a L{CooperativeTask}, which can be L{paused<CooperativeTask.pause>}, L{resumed<CooperativeTask.resume>} and L{waited on<CooperativeTask.whenDone>}. L{coiterate} has the same effect, but returns only a L{defer.Deferred} that fires when the task is done. L{Cooperator} can be used for many things, including but not limited to: - running one or more computationally intensive tasks without blocking - limiting parallelism by running a subset of the total tasks simultaneously - doing one thing, waiting for a L{Deferred<defer.Deferred>} to fire, doing the next thing, repeat (i.e. serializing a sequence of asynchronous tasks) Multiple L{Cooperator}s do not cooperate with each other, so for most cases you should use the L{global cooperator<task.cooperate>}. Tc C s2 g | _ td�| _|| _|| _d| _d| _|| _dS )aA Create a scheduler-like object to which iterators may be added. @param terminationPredicateFactory: A no-argument callable which will be invoked at the beginning of each step and should return a no-argument callable which will return True when the step should be terminated. The default factory is time-based and allows iterators to run for 1/100th of a second at a time. @param scheduler: A one-argument callable which takes a no-argument callable and should invoke it at some future point. This will be used to schedule each step of this Cooperator. @param started: A boolean which indicates whether iterators should be stepped as soon as they are added, or if they will be queued up until L{Cooperator.start} is called. r NF)�_tasks�iter� _metarator� _terminationPredicateFactory� _scheduler� _delayedCall�_stopped�_started)r ZterminationPredicateFactoryZ schedulerZstartedr r r r 5 s zCooperator.__init__Nc C s( |dkrt �� }t|| ��� �|� |S )a� Add an iterator to the list of iterators this L{Cooperator} is currently running. Equivalent to L{cooperate}, but returns a L{defer.Deferred} that will be fired when the task is done. @param doneDeferred: If specified, this will be the Deferred used as the completion deferred. It is suggested that you use the default, which creates a new Deferred for you. @return: a Deferred that will fire when the iterator finishes. N)r r6 re ro Z chainDeferred)r rm Z doneDeferredr r r � coiterateS s zCooperator.coiteratec C s t || �S )a Start running the given iterator as a long-running cooperative task, by calling next() on it as a periodic timed event. @param iterator: the iterator to invoke. @return: a L{CooperativeTask} object representing this task. )re )r rm r r r � cooperateg s zCooperator.cooperatec C s@ | j r(| j�|� |�t� tt� �� n| j�|� | �� dS )zH Add a L{CooperativeTask} object to this L{Cooperator}. N)r� r~ rn rt rX r � _reschedule�r Ztaskr r r rl s s zCooperator._addTaskc C s, | j �|� | j s(| jr(| j�� d| _dS )zF Remove a L{CooperativeTask} from this L{Cooperator}. N)r~ �remover� r: r� r r r rq � s zCooperator._removeTaskc c s> | � � }| jr:| jD ]}|V |� r dS qt| j�| _qdS )z� Yield all L{CooperativeTask} objects in a loop as long as this L{Cooperator}'s termination condition has not been met. N)r� r~ r� r )r � terminatorr2 r r r �_tasksWhileNotStopped� s z Cooperator._tasksWhileNotStoppedc C s( d| _ | �� D ] }|�� q| �� dS )z) Run one scheduler tick. N)r� r� r| r� �r ZtaskObjr r r �_tick� s zCooperator._tickFc C s2 | j sd| _d S | jd kr.| jr.| �| j�| _d S )NT)r� �_mustScheduleOnStartr� r~ r� r� r? r r r r� � s zCooperator._reschedulec C s" d| _ d| _| jr | `| �� dS )z) Begin scheduling steps. FTN)r� r� r� r� r? r r r r8 � s zCooperator.startc C sJ d| _ | jD ]}|�t� tt� �� q g | _| jdk rF| j�� d| _dS )z� Stop scheduling steps. Errback the completion Deferreds of all iterators which have been added and forget about them. TN)r� r~ rt rX r r� r: r� r r r r> � s � zCooperator.stopc C s | j o | j S )z� Is this L{Cooperator} is currently running? @return: C{True} if the L{Cooperator} is running, C{False} otherwise. @rtype: C{bool} )r� r� r? r r r r3 � s zCooperator.running)N)rL rR rK rS r^ rd r r� r� rl rq r� r� r� r� r8 r> rT r3 r r r r r} s" !� r} c C s t �| �S )a% Cooperatively iterate over the given iterator, dividing runtime between it and all other iterators which have been passed to this function and not yet exhausted. @param iterator: the iterator to invoke. @return: a Deferred that will fire when the iterator finishes. )�_theCooperatorr� �rm r r r r� � s r� c C s t �| �S )aS Start running the given iterator as a long-running cooperative task, by calling next() on it as a periodic timed event. This is very useful if you have computationally expensive tasks that you want to run without blocking the reactor. Just break each task up so that it yields frequently, pass it in here and the global L{Cooperator} will make sure work is distributed between them without blocking longer than a single iteration of a single task. @param iterator: the iterator to invoke. @return: a L{CooperativeTask} object representing this task. )r� r� r� r r r r� � s r� c @ sL e Zd ZdZdZdd� Zdd� Zdd� Zd d � Zd d � Z d d� Z dd� Z dS )�Clockz� Provide a deterministic, easily-controlled implementation of L{IReactorTime.callLater}. This is commonly useful for writing deterministic unit tests for code which schedules events using this API. g c C s g | _ d S rA ��callsr? r r r r � s zClock.__init__c C s | j S )a$ Pretend to be time.time(). This is used internally when an operation such as L{IDelayedCall.reset} needs to determine a time value relative to the current time. @rtype: C{float} @return: The time which should be considered the current time. )�rightNowr? r r r r$ s z Clock.secondsc C s | j jdd� d� dS )zR Sort the pending calls according to the time they are scheduled. c S s | � � S rA )�getTime)r r r r rw rx z"Clock._sortCalls.<locals>.<lambda>)�keyN)r� �sortr? r r r � _sortCalls s zClock._sortCallsc O s@ t �| �� | |||| jjdd� | j�}| j�|� | �� |S )zL See L{twisted.internet.interfaces.IReactorTime.callLater}. c S s d S rA r )�cr r r rw rx z!Clock.callLater.<locals>.<lambda>)r Z DelayedCallr$ r� r� rn r� )r rH Zwhatr r Zdcr r r rJ s � zClock.callLaterc C s | j S )zQ See L{twisted.internet.interfaces.IReactorTime.getDelayedCalls} r� r? r r r �getDelayedCalls$ s zClock.getDelayedCallsc C sb | j |7 _ | �� | jr^| jd �� | �� kr^| j�d�}d|_|j|j|j � | �� qdS )z� Move time on this clock forward by the given amount and run whatever pending calls should be run. @type amount: C{float} @param amount: The number of seconds which to advance this clock's time. r r# N) r� r� r� r� r$ �popZcalledrP �argsr )r �amountr9 r r r �advance+ s z Clock.advancec C s |D ]}| � |� qdS )zo Advance incrementally by the given set of times. @type timings: iterable of C{float} N)r� )r Ztimingsr� r r r �pump= s z Clock.pumpN) rL rR rK rS r� r r$ r� rJ r� r� r� r r r r r� � s r� c s@ �fdd�}t �|�}|�� ��fdd�� | �||jd��|S )a� Call the given function after a certain period of time has passed. @type clock: L{IReactorTime} provider @param clock: The object which will be used to schedule the delayed call. @type delay: C{float} or C{int} @param delay: The number of seconds to wait before calling the function. @param callable: The object to call after the delay. @param *args: The positional arguments to pass to C{callable}. @param **kw: The keyword arguments to pass to C{callable}. @rtype: L{defer.Deferred} @return: A deferred that fires with the result of the callable when the specified time has elapsed. c s � � � d S rA )r: )r" )� delayedCallr r �deferLaterCancel^ s z$deferLater.<locals>.deferLaterCancelc s �� ��S rA r )Zignored)r� �callabler r r rw a rx z deferLater.<locals>.<lambda>N)r r6 rE rJ r; )r Zdelayr� r� r r� r= r )r� r� r� r r � deferLaterH s r� r c s� � dkrddl m� | � f|�� }dg�g �� �dd�jd� � �fdd��� ��fd d �}|�|� � �� t��d � dS ) aR Call C{main} and run the reactor until the L{Deferred} it returns fires. This is intended as the way to start up an application with a well-defined completion condition. Use it to write clients or one-off asynchronous operations. Prefer this to calling C{reactor.run} directly, as this function will also: - Take care to call C{reactor.stop} once and only once, and at the right time. - Log any failures from the C{Deferred} returned by C{main}. - Exit the application when done, with exit code 0 in case of success and 1 in case of failure. If C{main} fails with a C{SystemExit} error, the code returned is used. The following demonstrates the signature of a C{main} function which can be used with L{react}:: def main(reactor, username, password): return defer.succeed('ok') task.react(main, ('alice', 'secret')) @param main: A callable which returns a L{Deferred}. It should take the reactor as its first parameter, followed by the elements of C{argv}. @param argv: A list of arguments to pass to C{main}. If omitted the callable will be invoked with no additional arguments. @param _reactor: An implementation detail to allow easier unit testing. Do not supply this parameter. @since: 12.3 Nr r ZbeforeZshutdownTc sd |r&z � � � W n tk r$ Y nX t| t�r`| �t�d k rH| jj}nt� | d� d}|�d< d S )Nz main function encountered errorr# r ) r> r r{ r Zcheck� SystemExit�value�coder �err)rB Z stopReactorr� )�_reactor�codesr r r> � s zreact.<locals>.stopc s" �r�| d� n� � �| d� d S )NFT)ZcallWhenRunningrv )r� r> �stoppingr r �cbFinish� s zreact.<locals>.cbFinish)r r ZaddSystemEventTriggerrn ZaddBoth�run�sys�exit)�main�argvr� Zfinishedr� r )r� r� r> r� r �reactg s # r� )r N)1rS Z __future__r r �typeZ __metaclass__r� r_ r Zzope.interfacer Ztwisted.pythonr r Ztwisted.python.deprecater Ztwisted.python.failurer Z incrementalr r r r Ztwisted.internet.interfacesr Ztwisted.internet.errorr r � ExceptionrV rX rY rZ r[ r\ r] �objectr^ rb rd re r} r� r� r� r� r� r� �__all__r r r r �<module> s\ % ?R F �
Save File
Cancel