Package: asyncdef.engine
Core event loop implementation.This package contains a configurable event loop and a set of hooks that allow
for async networking, time based scheduling, and coroutine management. Below
are samples of using each of the major components. Use caution. This project
is still very much in its infancy.Example UsageAsync Networking# Create a non-blocking socket server that logs data and closes connections.importfunctoolsimportsocketfromasyncdef.engine.coreimportEnginefromasyncdef.engine.processors.selectorimportSelector# Generate a non-blocking socket listener.sock=socket.socket()sock.setblocking(0)sock.bind(('localhost',9898))sock.listen()defhandle_data(selector,conn):"""Triggered on data waiting for read."""data=conn.recv(4096)print('Got data{}.'.format(data))selector.remove_reader(conn)conn.close()defhandle_connection(selector,listening_socket):"""Triggered on new incoming connection."""conn,addr=listening_socket.accept()conn.setblocking(0)selector.add_reader(conn,functools.partial(handle_data,selector),)# Create an instance of the selector and event loop.selector=Selector()loop=Engine(selector)# Set up the socket polling.selector.add_reader(sock,functools.partial(handle_connection,selector))# Start the event loop.loop.start()Time Scheduling# Schedule a function to run in five seconds.importfunctoolsfromasyncdef.engine.coreimportEnginefromasyncdef.engine.processors.timeimportTimedefprint_and_stop(loop):print("Stopping the loop.")loop.stop()time=Time()loop=Engine(time)handle=loop.defer_for(5,functools.partial(print_and_stop,loop))loop.start()Coroutine Managementimportfunctoolsfromconcurrent.futuresimportFuturefromasyncdef.engine.coreimportEnginefromasyncdef.engine.processors.coroutineimportCoroutinefromasyncdef.engine.processors.timeimportTimeclassAwaitableFuture(Future):"""An awaitable version of the standard lib Future."""def__await__(self):"""Return self until resolved."""whileself._state!='FINISHED':yieldselfreturnself.result()asyncdefwait_for_future(loop,future):value=awaitfutureprint('Got value{}. Stopping the loop.'.format(value))loop.stop()defresolve_future(future):print('Resolving future.')future.set_result(True)time=Time()coromgr=Coroutine()loop=Engine(coromgr,time)future=AwaitableFuture()time.defer_for(5,functools.partial(resolve_future,future))handle=coromgr.add(wait_for_future(loop,future))loop.start()TestingAll tests suites are paired one-to-one with the module they test and live
directly adjacent to that same module. All tests are expected to pass for
Python 3.5 and above. To run tests use tox with the included tox.ini file or
create a virtualenv and install the ‘[testing]’ extras.LicenseCopyright 2016 Kevin ConwayLicensed 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 athttp://www.apache.org/licenses/LICENSE-2.0Unless 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.ContributingFirstly, if you’re putting in a patch then thank you! Here are some tips for
getting your patch merged:StyleAs long as the code passes the PEP8 and PyFlakes gates then the style is
acceptable.DocsThe PEP257 gate will check that all public methods have docstrings. If you’re
adding something new, like a helper function, try out thenapoleon style of docstrings.TestsMake sure the patch passes all the tests. If you’re adding a new feature don’t
forget to throw in a test or two. If you’re fixing a bug then definitely add
at least one test to prevent regressions.