/usr/lib/python3/dist-packages/twisted/internet/__pycache__
Edit: /usr/lib/python3/dist-packages/twisted/internet/__pycache__/task.cpython-310.pyc (32141B)
o
bH @ s~ d Z ddlZddlZddlZddlmZmZmZmZm Z m
Z
m Z m Z m
Z
mZmZ ddlmZ ddlmZ ddlmZ ddlmZmZmZ ddlmZ dd l m Z m Z m Z dd
l m!Z!m"Z" dd l#m$Z$ dd l%m&Z& e
d
Z'G dd dZ(G dd de)Z*G dd de*Z+G dd de*Z,G dd de,Z-G dd de,Z.G dd de,Z/G d d d e*Z0G d d d Z1d Z2d!eg df d"e fd#d$Z3e
d%Z4G d&d' d'Z5G d(d) d)Z6e6 Z7d*ee' d"eee' fd+d,Z8d*ee' d"e5fd-d.Z9ee G d/d0 d0Z: d@d1e d2e;d!e ed3e'f d4e
Z>g d?Z?dS )Bz)
Scheduling utility methods and classes.
N) Callable CoroutineIterableIteratorListNoReturnOptionalSequenceTypeVarUnioncast) implementer)Version) DelayedCall)DeferredensureDeferred
maybeDeferred)ReactorNotRunning) IDelayedCall IReactorCore IReactorTime)logreflect) _getDeprecationWarningString)Failure_Tc @ s6 e Zd ZU dZdZee ed< dZdZ ee
d ed< dZ ee ed< dZ
dZee ed< dZee ed< d ed
ef d ed ed
dfddZed
ee
d fddZedeegef d
d fddZde d
efddZd'de ded
e
d fddZd(d d Zd(d d Z d(d d!Z d"e d
dfd#d$Z d
e fd%d&Z dS )) 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}.
@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.
@ivar _realLastTime: When counting skips, the time at which the skip
counter was last invoked.
@ivar _runAtStart: A flag indicating whether the 'now' argument was passed
to L{LoopingCall.start}.
NcallF _deferredinterval starttime
_realLastTimef.akwreturnc O s. || _ || _|| _ddlm} tt|| _d S Nr reactor)r" r# r$ twisted.internetr( r r clock)selfr" r# r$ r( r, 7/usr/lib/python3/dist-packages/twisted/internet/task.py__init__N s
zLoopingCall.__init__c C s. t dtdddddd}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.deferredTwisted r z the deferred returned by start()) replacement )
stacklevel)r r warningswarnDeprecationWarningr )r+
warningStringr, r, r- deferredV s zLoopingCall.deferred
countCallablec s dt f fdd }| |S )a
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 of 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.
@return: An instance of L{LoopingCall} with call counting enabled,
which provides the count as the first positional argument.
@since: 9.0
r% c s j } jdkr| _ dS j}|d u r5jd us!J dj}jr5jd us0J d|j8 }|}| }|| }|dkrN| _ |S d S )Nr z(LoopingCall called before it was startedz&Looping call called with None interval)r* secondsr r! r _runAtStart _intervalOf)nowlastTime lastInterval thisIntervalcountr9 r+ r, r- counter s,
z&LoopingCall.withCount..counter)object)clsr9 rD r, rC r- withCountf s zLoopingCall.withCounttc C s8 | j dusJ | jdusJ || 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.
N)r r int)r+ rH elapsedTime intervalNumr, r, r- r= s
zLoopingCall._intervalOfTr> c C sf | j rJ d|dk rtdd| _ t }| _| j | _|| _|| _|r+| |S | | 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
ValueErrorr r r* r; r r r<
_scheduleFrom)r+ r r> r8 r, r, r- start s zLoopingCall.startc C sZ | j sJ dd| _ | jdur+| j d| _| jd}| _|dus$J || dS dS )zStop running function.z1Tried to stop a LoopingCall that was not running.FN)rL r cancelr callbackr+ dr, r, r- stop s
zLoopingCall.stopc C sH | j sJ d| jdur"| j d| _| j | _| | j dS dS )zT
Skip the next iteration and reset the timer.
@since: 11.1
z2Tried to reset a LoopingCall that was not running.N)rL r rP r* r; r rN r+ r, r, r- reset s
zLoopingCall.resetc sf dt dd f fdd }dtdd f fdd }d _t jg jR i j}|| || d S )Nresultr% c sB j r
j d S jd } _|d usJ | d S N)rL rN r* r; r rQ )rW rS rU r, r- cb s
z LoopingCall.__call__..cbfailurec s. d _ jd } _|d usJ || d S )NF)rL r errback)rZ rS rU r, r- eb s z LoopingCall.__call__..eb) rE r r r r" r# r$ addCallback
addErrback)r+ rY r\ rS r, rU r- __call__ s
zLoopingCall.__call__whenc s* dt f fdd } j| _dS )z
Schedule the next iteration of this looping call.
@param when: The present time from whence the call is scheduled.
r% c sZ j dkrdS jd usJ j } j d usJ j | j }| kr+ j S |S )Nr )r r )
runningForuntilNextIntervalr+ r` r, r- howLong s
z*LoopingCall._scheduleFrom..howLongN)floatr* callLaterr )r+ r` rd r, rc r- rN s zLoopingCall._scheduleFromc C s t | jdd }|d u r(t | jdd }|d ur(t | jdd }|d ur(| d| }|d u r2t| j}d| j|t| jt| jS )N __qualname____name__im_class.z LoopingCall<{!r}>({}, *{}, **{}))getattrr" r safe_reprformatr r# r$ )r+ funcimClassr, r, r- __repr__% s
zLoopingCall.__repr__)Tr% N)!rh
__module__rg __doc__r r r __annotations__rL r r r re r< r r! r rE r. propertyr8 classmethodrI rG r= boolrO rT rV r_ rN strrp r, r, r, r- r * s*
" ;
&r c @ 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.
Nrh rr rg rs r, r, r, r- rz : rz c @ ry )SchedulerStoppedzt
The operation could not complete because the scheduler was stopped in
progress or was already stopped.
Nr{ r, r, r, r- r} C r| r} c @ ry ) TaskFinishedz
The operation could not complete because the task was already completed,
stopped, encountered an error or otherwise permanently stopped running.
Nr{ r, r, r, r- r~ J r| r~ c @ ry )TaskDonezR
The operation could not complete because the task was already completed.
Nr{ r, r, r, r- r Q r| r c @ ry ) TaskStoppedzH
The operation could not complete because the task was stopped.
Nr{ r, r, r, r- r W r| r c @ ry )
TaskFailedz]
The operation could not complete because the task died with an unhandled
error.
Nr{ r, r, r, r- r ] r| r c @ ry ) NotPausedz^
This exception is raised when a task is resumed which was not previously
paused.
Nr{ r, r, r, r- r d r| r c @ s( e Zd ZdZdddZdefddZdS ) _Timerg{Gz?r% Nc C s t | j | _d S rX )time MAX_SLICEendrU r, r, r- r. n s z_Timer.__init__c C s t | jkS rX )r r rU r, r, r- r_ q s z_Timer.__call__rq )rh rr rg r r. rw r_ r, r, r, r- r k s
r g:0yE>callabler% c C s ddl m} tt|t| S r& )r) r( r r rf _EPSILON)r r( r, r, r- _defaultSchedulerx s r _TaskResultTc @ s e Zd ZdZdee ddddfddZdeee fd d
Zdd d Z dd
dZ
de de ee e
f ddfddZdddZdddZdddZdS )CooperativeTaskaU
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{Deferred}s to fire when this task
completes, fails, or finishes.
@ivar _pauseCount: the number of times that this L{CooperativeTask} has
been paused; if 0, it is running.
@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}.
iterator
cooperator
Cooperatorr% Nc 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+ r r r, r, r- r. s zCooperativeTask.__init__c C s> t }| jdu r| j| |S | jdusJ || j |S )a
Get a L{Deferred} notification of when this task is complete.
@return: a L{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{Deferred}
N)r r r appendr rQ rR r, r, r- whenDone s
zCooperativeTask.whenDonec C s4 | | jd7 _| jdkr| j| dS 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) _checkFinishr r _removeTaskrU r, r, r- pause s
zCooperativeTask.pausec C sJ | j dkrt | j d8 _ | j dkr!| jdu r#| j| dS dS dS )z
Resume processing of a paused L{CooperativeTask}.
@raise NotPaused: if this L{CooperativeTask} is not paused.
r r: N)r r r r r rU r, r, r- resume s
zCooperativeTask.resumecompletionStatedeferredResultc C s8 || _ || _| js| j| | jD ]}|| qdS )a
@param completionState: a L{SchedulerError} 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)r r r r r r rQ )r+ r r rS 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)r r r r rU r, r, r- rT s zCooperativeTask.stopc C s | j dur| j dS )zk
If this task has been stopped, raise the appropriate subclass of
L{TaskFinished}.
N)r rU r, r, r- r s
z CooperativeTask._checkFinishc s zt j}W n# ty t j Y dS ty* t t Y dS w t|t rK
dtddf fdd }| fdd| dS 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{Deferred}.
rZ r% Nc s t | d S rX )r r )rZ rU r, r- failLater s z/CooperativeTask._oneWorkUnit..failLaterc s S rX )r rW rU r, r- z.CooperativeTask._oneWorkUnit..) nextr
StopIterationr r
BaseExceptionr r
isinstancer r addCallbacks)r+ rW r r, rU r- _oneWorkUnit s
z CooperativeTask._oneWorkUnitrq )rh rr rg rs r r r. r r r r rz r r r rT r r r, r, r, r- r s,
r c @ s e Zd ZdZeedfdeg eg ef f deeg df gef defddZ d"d e
e d
e e
e
e d e
e
e fd d
Zd e
e d efddZded dfddZded dfddZd ee fddZd#ddZdZd#ddZd#d d Zd#d d Zed efd d!ZdS )$r a
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{Deferred} then work will pause until the
L{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},
L{resumed} and L{waited
on}. L{coiterate} has the same effect, but
returns only a L{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} 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}.
TterminationPredicateFactory schedulerNstartedc 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)_tasksiter
_metarator _terminationPredicateFactory
_scheduler _delayedCall_stopped_started)r+ r r r r, r, r- r. > s
zCooperator.__init__r doneDeferredr% c C s& |du rt }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{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 r r
chainDeferred)r+ r r r, r, r- coiterate] 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.
)r )r+ r r, r, r- cooperatet s
zCooperator.cooperatetaskc C sB | j r| j| |t tt dS | j| | dS )zH
Add a L{CooperativeTask} object to this L{Cooperator}.
N)r r r r r} r _rescheduler+ r r, r, r- r s
zCooperator._addTaskc C s4 | j | | j s| jr| j d| _dS dS dS )zF
Remove a L{CooperativeTask} from this L{Cooperator}.
N)r remover rP r r, r, r- r s
zCooperator._removeTaskc c sH | }| jr"| jD ] }|V | r dS q t| j| _| jsdS dS )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+
terminatorrH 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+ taskObjr, r, r- _tick s
zCooperator._tickFc C s: | j sd| _d S | jd u r| jr| | j| _d S d S d S NT)r _mustScheduleOnStartr r r r rU r, r, r- r s zCooperator._reschedulec C s& d| _ d| _| jr| `| dS dS )z)
Begin scheduling steps.
FTN)r r r r rU r, r, r- rO s zCooperator.startc C sN d| _ | jD ] }|t tt qg | _| jdur%| j d| _dS dS )z
Stop scheduling steps. Errback the completion Deferreds of all
iterators which have been added and forget about them.
TN)r r r r} r r rP r r, r, r- rT 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 rU r, r, r- rL s zCooperator.runningrX rq ) rh rr rg rs r r r rw r r. r r r r r r r r r r r r r r rO rT ru rL r, r, r, r- r s> "
"
r r c C
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 r r, r, r- r s
r c C r )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
@ s e Zd ZdZdZdddZdefddZdd d
Zd ed e d
e
f de
de
de f
ddZ de
e fddZdeddfddZdee ddfddZdS )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 r% Nc C s
g | _ d S rX callsrU r, r, r- r. s
zClock.__init__c C | 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.
@return: The time which should be considered the current time.
)rightNowrU 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 rX )getTime)r# r, r, r- r r z"Clock._sortCalls..)keyN)r sortrU r, r, r-
_sortCalls s zClock._sortCallsdelayr .argsr$ c O s> t | | |||| jjdd | j}| j| | |S )zL
See L{twisted.internet.interfaces.IReactorTime.callLater}.
c S s d S rX r, )cr, r, r- r ! s z!Clock.callLater..)r r; r r r r )r+ r r r r$ dcr, r, r- rf s
zClock.callLaterc C r )zQ
See L{twisted.internet.interfaces.IReactorTime.getDelayedCalls}
r rU r, r, r- getDelayedCalls( s zClock.getDelayedCallsamountc C s | j |7 _ | | jr@| jd | krD| jd}d|_|j|ji |j | | jrB| jd | ksdS dS dS dS )z
Move time on this clock forward by the given amount and run whatever
pending calls should be run.
@param amount: The number of seconds which to advance this clock's
time.
r r: N)
r r r r r; popcalledrn r r$ )r+ r r r, r, r- advance. s ,z
Clock.advancetimingsc C s |D ]}| | qdS )zB
Advance incrementally by the given set of times.
N)r )r+ r r r, r, r- pump> s z
Clock.pumprq )rh rr rg rs r r. re r; r r rE r rf r r r r r r, r, r, r- r s(
r r* r .r r$ c sZ dt t ddffdd }dtdtf fdd }t |}|| | ||jd|S ) a+
Call the given function after a certain period of time has passed.
@param clock: The object which will be used to schedule the delayed
call.
@param delay: The number of seconds to wait before calling the function.
@param callable: The callable to call after the delay, or C{None}.
@param args: The positional arguments to pass to C{callable}.
@param kw: The keyword arguments to pass to C{callable}.
@return: A deferred that fires with the result of the callable when the
specified time has elapsed.
r8 r% Nc s d S rX )rP )r8 ) delayedCallr, r- deferLaterCancel_ s z$deferLater..deferLaterCancelrW c s d u rd S i S rX r, r )r r r$ r, r- rY b s zdeferLater..cb)r rE r r] rf rQ )r* r r r r$ r rY rS r, )r r r r$ r-
deferLaterF s
r r, mainz Deferred[_T]argv_reactorc s du rddl m} tt| t| g|R }dddfdd } dd | d
td tddf fd d
d
tddf fdd }|| t
dS )a
Call C{main} and run the reactor until the L{Deferred} it returns fires or
the coroutine it returns completes.
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}::
async def main(reactor, username, password):
return "ok"
task.react(main, ("alice", "secret"))
@param main: A callable which returns a L{Deferred} or
coroutine. 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' Fr% c s d d S r r, r, )stoppingr, r-
onShutdown s zreact..onShutdownbeforeshutdownrW stopReactorc sl |r d usJ z W n ty Y nw t| tr4| td ur*| jjd S t | d dd S d S )Nz main function encountered errorr: )
rT r r r check
SystemExitvaluecoder err)rW r )r r r, r- rT s
zreact..stopc s0 r | d d S d usJ | d d S )NFT)callWhenRunningr )r rT r r, r- cbFinish s zreact..cbFinishrq ) r) r( r r r addSystemEventTriggerrE rw addBothrunsysexit)r r r r( finishedr r r, )r r rT r r- reactm s +
r )r r r} r r r r rX )r, N)@rs r r r4 typingr r r r r r r r r
r r zope.interfacer
incrementalr twisted.internet.baser twisted.internet.deferr r r twisted.internet.errorr twisted.internet.interfacesr r r twisted.pythonr r twisted.python.deprecater twisted.python.failurer r r Exceptionrz r} r~ r r r r r r r r r r r r r r re rE r r __all__r, r, r, r- s 4
:
P
,
W