o )ZhC@sddlZddlZddlZddlmZmZddlmZmZddl m Z m Z m Z m Z mZddl Z e jr9ddl mZmZgdZGdddeZGd d d eZGd d d eZGd ddeZGdddeZGdddeZGdddeZdS)N)genioloop)Future"future_set_result_unless_cancelled)UnionOptionalTypeAny Awaitable)DequeSet) ConditionEvent SemaphoreBoundedSemaphoreLockc@s$eZdZdZdddZdddZdS) _TimeoutGarbageCollectorzBase class for objects that periodically clean up timed-out waiters. Avoids memory leak in a common pattern like: while True: yield condition.wait(short_timeout) print('looping....') returnNcCst|_d|_dS)Nr) collectionsdeque_waiters _timeoutsselfrD/var/www/html/lang_env/lib/python3.10/site-packages/tornado/locks.py__init__)s  z!_TimeoutGarbageCollector.__init__cCs>|jd7_|jdkrd|_tdd|jD|_dSdS)Ndrcss|] }|s|VqdSN)done).0wrrr 2sz<_TimeoutGarbageCollector._garbage_collect..)rrrrrrrr_garbage_collect-s  z)_TimeoutGarbageCollector._garbage_collectrN)__name__ __module__ __qualname____doc__rr$rrrrrs rc@sdeZdZdZdefddZ ddeeee j fde e fddZ dd eddfd d Zdd dZdS)r aA condition allows one or more coroutines to wait until notified. Like a standard `threading.Condition`, but does not need an underlying lock that is acquired and released. With a `Condition`, coroutines can wait to be notified by other coroutines: .. testcode:: import asyncio from tornado import gen from tornado.locks import Condition condition = Condition() async def waiter(): print("I'll wait right here") await condition.wait() print("I'm done waiting") async def notifier(): print("About to notify") condition.notify() print("Done notifying") async def runner(): # Wait for waiter() and notifier() in parallel await gen.multi([waiter(), notifier()]) asyncio.run(runner()) .. testoutput:: I'll wait right here About to notify Done notifying I'm done waiting `wait` takes an optional ``timeout`` argument, which is either an absolute timestamp:: io_loop = IOLoop.current() # Wait up to 1 second for a notification. await condition.wait(timeout=io_loop.time() + 1) ...or a `datetime.timedelta` for a timeout relative to the current time:: # Wait up to 1 second. await condition.wait(timeout=datetime.timedelta(seconds=1)) The method returns False if there's no notification before the deadline. .. versionchanged:: 5.0 Previously, waiters could be notified synchronously from within `notify`. Now, the notification will always be received on the next iteration of the `.IOLoop`. rcCs.d|jjf}|jr|dt|j7}|dS)Nz<%sz waiters[%s]>) __class__r&rlen)rresultrrr__repr__qszCondition.__repr__NtimeoutcsTtj|r(dfdd }tj||fddS)zWait for `.notify`. Returns a `.Future` that resolves ``True`` if the condition is notified, or ``False`` after a timeout. rNcss tddSNF)r rr$rrwaiterrr on_timeouts  z"Condition.wait..on_timeoutc SrZremove_timeout_io_looptimeout_handlerr z Condition.wait..r%)rrappendrIOLoopcurrent add_timeoutadd_done_callbackrr/r3rr9rr:r2rwaitws   zCondition.waitrncCsTg}|r|jr|j}|s|d8}|||r|js|D]}t|dq dS)zWake ``n`` waiters.rTN)rpopleftr r=r)rrEwaitersr2rrrnotifys     zCondition.notifycCs|t|jdS)zWake all waiters.N)rHr,rrrrr notify_allszCondition.notify_allrrr%)r&r'r(r)strr.rrfloatdatetime timedeltar boolrDintrHrIrrrrr 5s;  r c@sreZdZdZdddZdefddZdefdd Zdd d Z dd d Z dde e e ejfdedfddZdS)raAn event blocks coroutines until its internal flag is set to True. Similar to `threading.Event`. A coroutine can wait for an event to be set. Once it is set, calls to ``yield event.wait()`` will not block unless the event has been cleared: .. testcode:: import asyncio from tornado import gen from tornado.locks import Event event = Event() async def waiter(): print("Waiting for event") await event.wait() print("Not waiting this time") await event.wait() print("Done") async def setter(): print("About to set the event") event.set() async def runner(): await gen.multi([waiter(), setter()]) asyncio.run(runner()) .. testoutput:: Waiting for event About to set the event Not waiting this time Done rNcCsd|_t|_dSr0)_valuesetrrrrrrs zEvent.__init__cCs d|jj|r dfSdfS)Nz<%s %s>rRclear)r+r&is_setrrrrr.s  zEvent.__repr__cCs|jS)z-Return ``True`` if the internal flag is true.rQrrrrrTsz Event.is_setcCs2|jsd|_|jD] }|s|dq dSdS)zSet the internal flag to ``True``. All waiters are awakened. Calling `.wait` once the flag is set will not block. TN)rQrr set_result)rfutrrrrRs  z Event.setcCs d|_dS)zkReset the internal flag to ``False``. Calls to `.wait` will block until `.set` is called. FNrUrrrrrSs z Event.clearr/csftjr dSjfdd|dur"St|}|fdd|S)zBlock until the internal flag is true. Returns an awaitable, which raises `tornado.util.TimeoutError` after a timeout. Ncs j|Sr)rremoverWrrrr;s zEvent.wait..cssSdSr)r cancel)tfrYrrr;s)rrQrVraddrArZ with_timeout)rr/Z timeout_futr)rWrrrDs    z Event.waitr%r)r&r'r(r)rrKr.rOrTrRrSrrrLrMrNr rDrrrrrs '  rc@sPeZdZdZdeddfddZdddZd d d eed ee j ddfd dZ dS)_ReleasingContextManagerzReleases a Lock or Semaphore at the end of a "with" statement. with (yield semaphore.acquire()): pass # Now semaphore.release() has been called. objrNcCs ||_dSr)_obj)rr^rrrr s z!_ReleasingContextManager.__init__cCsdSrrrrrr __enter__sz"_ReleasingContextManager.__enter__exc_typeOptional[Type[BaseException]]exc_valexc_tbcCs|jdSr)r_release)rrarcrdrrr__exit__sz!_ReleasingContextManager.__exit__r%) r&r'r(r)r rr`r BaseExceptiontypes TracebackTyperfrrrrr]s r]cseZdZdZddeddffdd Zdeffdd Zdd d Z dd e e e e j fdeefd dZdddZddde ede ejddfddZdddZddde ede ejddfddZZS)ra A lock that can be acquired a fixed number of times before blocking. A Semaphore manages a counter representing the number of `.release` calls minus the number of `.acquire` calls, plus an initial value. The `.acquire` method blocks if necessary until it can return without making the counter negative. Semaphores limit access to a shared resource. To allow access for two workers at a time: .. testsetup:: semaphore from collections import deque from tornado import gen from tornado.ioloop import IOLoop from tornado.concurrent import Future inited = False async def simulator(futures): for f in futures: # simulate the asynchronous passage of time await gen.sleep(0) await gen.sleep(0) f.set_result(None) def use_some_resource(): global inited global futures_q if not inited: inited = True # Ensure reliable doctest output: resolve Futures one at a time. futures_q = deque([Future() for _ in range(3)]) IOLoop.current().add_callback(simulator, list(futures_q)) return futures_q.popleft() .. testcode:: semaphore import asyncio from tornado import gen from tornado.locks import Semaphore sem = Semaphore(2) async def worker(worker_id): await sem.acquire() try: print("Worker %d is working" % worker_id) await use_some_resource() finally: print("Worker %d is done" % worker_id) sem.release() async def runner(): # Join all workers. await gen.multi([worker(i) for i in range(3)]) asyncio.run(runner()) .. testoutput:: semaphore Worker 0 is working Worker 1 is working Worker 0 is done Worker 2 is working Worker 1 is done Worker 2 is done Workers 0 and 1 are allowed to run concurrently, but worker 2 waits until the semaphore has been released once, by worker 0. The semaphore can be used as an async context manager:: async def worker(worker_id): async with sem: print("Worker %d is working" % worker_id) await use_some_resource() # Now the semaphore has been released. print("Worker %d is done" % worker_id) For compatibility with older versions of Python, `.acquire` is a context manager, so ``worker`` could also be written as:: @gen.coroutine def worker(worker_id): with (yield sem.acquire()): print("Worker %d is working" % worker_id) yield use_some_resource() # Now the semaphore has been released. print("Worker %d is done" % worker_id) .. versionchanged:: 4.3 Added ``async with`` support in Python 3.5. rvaluerNcs$t|dkr td||_dS)Nrz$semaphore initial value must be >= 0)superr ValueErrorrQrrjr+rrrs  zSemaphore.__init__csPt}|jdkr dnd|j}|jrd|t|j}d|dd|S)Nrlockedzunlocked,value:{0}z{0},waiters:{1}z <{0} [{1}]>r)rkr.rQformatrr,)rresextrarnrrr.s zSemaphore.__repr__cCsT|jd7_|jr(|j}|s#|jd8_|t|dS|js dSdS)*Increment the counter and wake one waiter.rN)rQrrFr rVr]r1rrrres zSemaphore.releaser/cs~tjdkrjd8_tSj|r=d fdd }tj || fddS) zDecrement the counter. Returns an awaitable. Block if the counter is zero and wait for a `.release`. The awaitable raises `.TimeoutError` after the deadline. rrrNcs"s tdSr)r Z set_exceptionr TimeoutErrorr$rr1rrr3s z%Semaphore.acquire..on_timeoutcr4rr5r6r8rrr;r<z#Semaphore.acquire..r%) rrQrVr]rr=rr>r?r@rArBrrCracquires     zSemaphore.acquirecCtd)Nz0Use 'async with' instead of 'with' for Semaphore RuntimeErrorrrrrr`zSemaphore.__enter__typrb tracebackcC |dSrr`)rr{rjr|rrrrf zSemaphore.__exit__c|IdHdSrrvrrrr __aenter__zSemaphore.__aenter__tbc|dSrrerr{rjrrrr __aexit__ zSemaphore.__aexit__rJr%r)r&r'r(r)rPrrKr.rerrrLrMrNr r]rvr`rgrhrirfrr __classcell__rrrnrrs>d   rcs:eZdZdZd deddffdd Zd fdd ZZS) ra:A semaphore that prevents release() being called too many times. If `.release` would increment the semaphore's value past the initial value, it raises `ValueError`. Semaphores are mostly used to guard resources with limited capacity, so a semaphore released too many times is a sign of a bug. rrjrNcstj|d||_dS)Nrj)rkr_initial_valuermrnrrrs zBoundedSemaphore.__init__cs"|j|jkr tdtdS)rtz!Semaphore released too many timesN)rQrrlrkrerrnrrres zBoundedSemaphore.releaserJr%)r&r'r(r)rPrrerrrrnrrsrc@seZdZdZdddZdefddZ ddeee e j fde e fd d Zdd d Zdd dZdddeedeejddfddZdddZdddeedeejddfddZdS)raA lock for coroutines. A Lock begins unlocked, and `acquire` locks it immediately. While it is locked, a coroutine that yields `acquire` waits until another coroutine calls `release`. Releasing an unlocked lock raises `RuntimeError`. A Lock can be used as an async context manager with the ``async with`` statement: >>> from tornado import locks >>> lock = locks.Lock() >>> >>> async def f(): ... async with lock: ... # Do something holding the lock. ... pass ... ... # Now the lock is released. For compatibility with older versions of Python, the `.acquire` method asynchronously returns a regular context manager: >>> async def f2(): ... with (yield lock.acquire()): ... # Do something holding the lock. ... pass ... ... # Now the lock is released. .. versionchanged:: 4.3 Added ``async with`` support in Python 3.5. rNcCstdd|_dS)Nrr)r_blockrrrrr sz Lock.__init__cCsd|jj|jfS)Nz<%s _block=%s>)r+r&rrrrrr.sz Lock.__repr__r/cCs |j|S)zAttempt to lock. Returns an awaitable. Returns an awaitable, which raises `tornado.util.TimeoutError` after a timeout. )rrv)rr/rrrrvs z Lock.acquirecCs(z|jWdStytdw)zUnlock. The first coroutine in line waiting for `acquire` gets the lock. If not locked, raise a `RuntimeError`. zrelease unlocked lockN)rrerlryrrrrres  z Lock.releasecCrw)Nz+Use `async with` instead of `with` for Lockrxrrrrr`(rzzLock.__enter__r{rbrjrcCr}rr~rrrrrf+rz Lock.__exit__crrrrrrrr3rzLock.__aenter__crrrrrrrr6rzLock.__aexit__r%r)r&r'r(r)rrKr.rrrLrMrNr r]rvrer`rgrhrirfrrrrrrrs> $  r)rrMrhtornadorrZtornado.concurrentrrtypingrrrr r TYPE_CHECKINGr r __all__objectrr rr]rrrrrrrs$id: