PKJoK-B## aiorun.py"""Boilerplate for asyncio applications""" import logging import asyncio from asyncio import ( get_event_loop, AbstractEventLoop, Task, gather, CancelledError, Future ) from concurrent.futures import Executor, ThreadPoolExecutor from signal import SIGTERM, SIGINT from typing import Optional, Coroutine, Callable from weakref import WeakSet from functools import partial __all__ = ['run', 'shutdown_waits_for'] __version__ = '2017.11.5' logger = logging.getLogger('aiorun') _DO_NOT_CANCEL_COROS = WeakSet() def shutdown_waits_for(coro, loop=None): """Prevent coro from being cancelled during the shutdown sequence. The trick here is that we add this coro to the global "DO_NOT_CANCEL" collection, and then later during the shutdown sequence we make sure that the task that wraps this coro will NOT be cancelled. To make this work, we have to create a super-secret task, below, that communicates with the caller (which "awaits" us) via a Future. Using a Future in this way allows us to avoid awaiting the Task, which decouples the Task from the normal exception propagation which would normally happen when the outer Task gets cancelled. We get the result of coro back to the caller via Future.set_result. NOTE that during the shutdown sequence, the caller WILL NOT be able to receive a result, since the caller will likely have been cancelled. So you should probably not rely on capturing results via this function. """ loop = loop or get_event_loop() fut = Future(loop=loop) # This future will connect coro and the caller. async def coro_proxy(): """This function will await coro, but it will also send the result over the the future. Rememeber: the outside caller (of shutdown_waits_for) will be awaiting fut, NOT coro(), due to the decoupling. However, when coro completes, we need to send its result over to the fut to make it look *as if* it was just coro running the whole time. This whole thing is a teeny magic trick. """ try: result = await coro try: fut.set_result(result) except asyncio.InvalidStateError: logger.warning('Failed to set result.') except CancelledError as e: fut.set_exception(e) new_coro = coro_proxy() # We'll taskify this one instead of coro. _DO_NOT_CANCEL_COROS.add(new_coro) # The new task must not be cancelled. loop.create_task(new_coro) # Make the task # Ok, so we *could* simply return fut. Callers can await it as normal, # e.g. # # async def blah(): # x = await shutdown_waits_for(bleh()) # # That will work fine. However, callers may *also* want to detach the # call from the current execution context, e.g. # # async def blah(): # loop.create_task(shutdown_waits_for(bleh())) # # This will only work if shutdown_waits_for() returns a coroutine. # Therefore, we just make a new coroutine to wrap the `await fut` and # return that. Then both things will work. # # (Side note: instead of callers using create_tasks, it would also work # if they used `asyncio.ensure_future()` instead, since that can work # with futures. But I don't like ensure_future.) # # (Another side note: You don't even need `create_task()` or # `ensure_future()`...If you don't want a result, you can just call # `shutdown_waits_for()` as a flat function call, no await or anything, # and it should still work; unfortunately it causes a RuntimeWarning to # tell you that ``inner()`` was never awaited :/ async def inner(): return await fut return inner() def _shutdown(loop=None): logger.debug('Entering shutdown handler') loop = loop or get_event_loop() loop.remove_signal_handler(SIGTERM) loop.add_signal_handler(SIGINT, lambda: None) logger.critical('Stopping the loop') loop.call_soon_threadsafe(loop.stop) def run(coro: Optional[Coroutine] = None, *, loop: Optional[AbstractEventLoop] = None, shutdown_handler: Optional[ Callable[[Optional[AbstractEventLoop]], None]] = None, executor_workers: int = 10, executor: Optional[Executor] = None, use_uvloop: bool = False, close_loop_after_shutdown: bool = False) -> None: """ Start up the event loop, and wait for a signal to shut down. :param coro: Optionally supply a coroutine. The loop will still run if missing. This would typically be a "main" coroutine from which all other work is spawned. :param loop: Optionally supply your own loop. If missing, the default loop attached to the current thread context will be used, i.e., whatever ``asyncio.get_event_loop()`` returns. :param shutdown_handler: By default, SIGINT and SIGTERM will be handled and will stop the loop, thereby invoking the shutdown sequence. Alternatively you can supply your own shutdown handler function. It should conform to the type spec as shown in the function signature. :param executor_workers: The number of workers in the executor. (NOTE: ``run()`` creates a new executor instance internally, regardless of whether you supply your own loop.) :param executor: You can decide to use your own executor instance if you like. :param use_uvloop: The loop policy will be set to use uvloop. It is your responsibility to install uvloop. If missing, an ``ImportError`` will be raised. :param close_loop_after_shutdown: It turns out to be quite inconvenient to automatically close the loop after shutdown. For example, during testing it is common to call ``run()`` a bunch of times. If the loop is closed, then subsequent attempts to call ``run()`` will raise because "the loop is closed".One way to get around this is to always supply your own loop, but that introduces more complexity. Therefore, by default, don't close the loop on run exit. """ logger.debug('Entering run()') assert not (loop and use_uvloop), ( "'loop' and 'use_uvloop' parameters are mutually " "exclusive. (Just make your own uvloop and pass it in)." ) if use_uvloop: import uvloop asyncio.set_event_loop_policy(uvloop.EventLoopPolicy()) loop = loop or get_event_loop() if coro: async def new_coro(): """During shutdown, run_until_complete() will exit if a CancelledError bubbles up from anything in the group. To counteract that, we'll try to handle any CancelledErrors that bubble up from the given coro. This isn't fool-proof: if the user doesn't provide a coro, and instead creates their own with loop.create_task, that task might bubble a CancelledError into the run_until_complete().""" try: await coro except asyncio.CancelledError: pass loop.create_task(new_coro()) shutdown_handler = shutdown_handler or partial(_shutdown, loop) loop.add_signal_handler(SIGINT, shutdown_handler) loop.add_signal_handler(SIGTERM, shutdown_handler) if not executor: logger.debug('Creating default executor') executor = ThreadPoolExecutor(max_workers=executor_workers) loop.set_default_executor(executor) logger.critical('Running forever.') loop.run_forever() logger.critical('Entering shutdown phase.') def sep(): tasks = Task.all_tasks(loop=loop) do_not_cancel = set() for t in tasks: # TODO: we don't need access to the coro. We could simply # TODO: store the task itself in the weakset. if t._coro in _DO_NOT_CANCEL_COROS: do_not_cancel.add(t) tasks -= do_not_cancel logger.critical('Cancelling pending tasks.') for t in tasks: print('Cancelling task: ', t) t.cancel() return tasks, do_not_cancel tasks, do_not_cancel = sep() # Here's a protip: if you group a bunch of tasks, and some of them # get cancelled, and they DON'T HANDLE THE CANCELLATION, then the # raised CancelledError will bubble up to, and stop the # loop.run_until_complete() line: meaning, not all the tasks in # the gathered group will actually be complete. You need to # enable this with the ``return_exceptions`` flag. group = gather(*tasks, *do_not_cancel, return_exceptions=True) logger.critical('Running pending tasks till complete') # TODO: obtain all the results, and log any results that are exceptions # other than CancelledError. Will be useful for troubleshooting. loop.run_until_complete(group) logger.critical('Waiting for executor shutdown.') executor.shutdown(wait=True) if close_loop_after_shutdown: logger.critical('Closing the loop.') loop.close() logger.critical('Leaving. Bye!') PKSK;U],],"aiorun-2017.11.5.dist-info/LICENSE Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. PK!H١Wd aiorun-2017.11.5.dist-info/WHEEL HM K-*ϳR03rOK-J,/RH,Q0343 /, (-JLR()*M ILR(4KM̫#DPK!HT [##aiorun-2017.11.5.dist-info/METADATAYnb%u O8 cDZjˆ\-yWwDE}EGQ}@y-$nvfv7|L_+cuYIt/8 KSͽOsi#ԙ2U&iEK!*ӱt8ggee\eGGGsze~oңFs‚_|s<]Z8g9]PRg#(m^~9:8ͤz84h$^^UekW2N(gn!jI7KW粘׸ {Z3m Wd@J} S'^VH2XZr}qV$RQmïu#?_{mzAEB˵3cfgd珦Fq0oI3W 7".J{h*,wmاMQXv_|6ר[gK:XpXf?}(ۺCM{AZx8;zxt |!,p')zV8$ ()i˲5v#V:.5fe|=RBUi\̔y#}@+ d٢>jGBM7PBǖN.^ lT?*31(>xPc2VbGKƉT[}Ey9no N&bV1! *5r_9O&Bp*-B=<:*"3'p•¦0IR.@,Te);{YYVueD<."+< [эTID ^VQ:-ETb\fp?jCdk6*X ^lXO<(% Vdh܂r^K]0!pDz+c-=gοeW4 Љ.s( ɗۭE Els) t$zUVS-@ 0. 31z^&PuDnnUCa{WwZ.~yv~9@O_kXo9IiH WȊBW`lB)W%h ȴ:UU}E`sG ۛY@"cW"ѫɄ^FEkuE ,V.Θ;R|5hC:ɩQުv cm0: #L8c0@P6g3߲}9y.V$9;B#9L&`$N"$0 rOѵ/*>rXI˂,:psoQީ _*8@0Bp\f!+ZMv&OYScJK)C"*öDs(AuE`FldoNX-E6,XUtQfa}<2=Zc /ЃYm>ťYz=qLrj)Y =beI!9ptU+5~jAmR*aIl=mI9w(%ReW҈ kX]e{UW ]窠E,A qV*2C)(3\So lmk0R iƵ~P :] r $Wbna o$C\K ,tF c^Bp @ W1gqRT0"`PNg0TFL`j\zU " .Ae[upjGt1 x(\D)r_5⃶MMv2áu`G˳\\ r o(q,ɿhj.Fh[8lIN nVӫ*~Aϸ^!m'swV(ڔ$oíhP]{'>7?p H5=qWhFh`)jz[2ZڬTFr|#u[t8J6φtU-(ų~ܚ̘1a˒y%ȀEv.2}V.k!MiN/h{ۼPkGf ?//m\SF FyE^]w1fNfțo6+4(HT7Ϯ5Awۦfɮv848&/P?݆ Zw2M`1=I551O+K YY6y3!q.>L6+)}ZuVL~[Fj+)^&+7 0 qÏ~-]ugu_k.kucpmtǐ 07Z t^T~FD@KJ|޸$S#&۳&K5Vx Cii;Ɋ̎I;8pǦxobWvIםm4Cm)۲MkV[zL UٕZ]l_G({ P%-geg'hGB2)2\%ɝm6`i/ָW?'8w&0 xR8SϹF)*0˹ CY-~Z?(JݔFH TWZ:ݚ+%m|ڽ[Tg-  zSϔuZ#~"٦lV>Wj-8Zxl>tq4mOR[CE%mf?ΨW w71MK+%͛^2` z{v!ޤޢ-s>reA9\ZQʕrPK!HEv!aiorun-2017.11.5.dist-info/RECORD}KR0}Eh%l |8Öwk#{k#?xzocyU-b-ڸTt.< `[90!> **V>(u_բ@IRŞmo3"t`kB{llݩCli ~/XѲ.NL&N3 42Ͼ/bjԴק9uu{GI5棝ǑЅ5Ӏau3jPKJoK-B## aiorun.pyPKSK;U],],"#aiorun-2017.11.5.dist-info/LICENSEPK!H١Wd Paiorun-2017.11.5.dist-info/WHEELPK!HT [##Qaiorun-2017.11.5.dist-info/METADATAPK!HEv!_aiorun-2017.11.5.dist-info/RECORDPKuO`