deb-python-greenio/greenio/__init__.py
2014-01-14 11:23:20 -05:00

153 lines
4.6 KiB
Python

##
# Copyright (c) 2013 Yury Selivanov
# License: Apache 2.0
##
"""greenio package allows to compose greenlets and asyncio coroutines."""
__all__ = ['task', 'yield_from']
import greenlet
import asyncio
from asyncio import unix_events, tasks, futures
class _LoopGreenlet(greenlet.greenlet):
"""Main greenlet (analog to main thread) for the event-loop.
It's a policy task to provide event-loop implementation with
its "run_*" methods executed in _LoopGreenlet context"""
class _TaskGreenlet(greenlet.greenlet):
"""Each task (and its subsequent coroutines) decorated with
``@greenio.task`` is executed in this greenlet"""
class GreenTask(asyncio.Task):
def __init__(self, *args, **kwargs):
self._greenlet = None
super(GreenTask, self).__init__(*args, **kwargs)
def _step(self, value=None, exc=None):
if self._greenlet is None:
# Means that the task is not currently in a suspended greenlet
# waiting for results for "yield_from"
ovr = super(GreenTask, self)._step
self._greenlet = _TaskGreenlet(ovr)
# Store a reference to the current task for "yield_from"
self._greenlet.task = self
# Now invoke overloaded "Task._step" in "_TaskGreenlet"
result = self._greenlet.switch(value, exc)
# If "result" is "_YIELDED" it means that the "yield_from"
# method was called
if result is not _YIELDED:
# And if not - then task jumped out of greenlet without
# calling "yield_from"
self._greenlet.task = None
self._greenlet = None
else:
self.__class__._current_tasks.pop(self._loop)
else:
# The task is in the greenlet, that means that we have a result
# for the "yield_from"
self.__class__._current_tasks[self._loop] = self
if exc is not None:
result = self._greenlet.throw(
type(exc), exc, exc.__traceback__)
else:
result = self._greenlet.switch(value)
# Again, if "result" is "_YIELDED" then we just called "yield_from"
# again
if result is not _YIELDED:
self._greenlet.task = None
self._greenlet = None
else:
self.__class__._current_tasks.pop(self._loop)
class _GreenLoopMixin(object):
def _green_run(self, method, args, kwargs):
return _LoopGreenlet(method).switch(*args, **kwargs)
def run_until_complete(self, *args, **kwargs):
ovr = super(_GreenLoopMixin, self).run_until_complete
return self._green_run(ovr, args, kwargs)
def run_forever(self, *args, **kwargs):
ovr = super(_GreenLoopMixin, self).run_forever
return self._green_run(ovr, args, kwargs)
class GreenUnixSelectorLoop(_GreenLoopMixin, unix_events.SelectorEventLoop):
pass
class GreenEventLoopPolicy(asyncio.DefaultEventLoopPolicy):
def new_event_loop(self):
return GreenUnixSelectorLoop()
def yield_from(future):
"""A function to use instead of ``yield from`` statement."""
gl = greenlet.getcurrent()
if __debug__:
if not isinstance(gl.parent, _LoopGreenlet):
raise RuntimeError(
'"greenio.yield_from" requires GreenEventLoopPolicy '
'or compatible')
# or something went horribly wrong...
if not isinstance(gl, _TaskGreenlet):
raise RuntimeError(
'"greenio.yield_from" was supposed to be called from a '
'"greenio.task" or a subsequent coroutine')
# ...ditto
task = gl.task
if not isinstance(future, futures.Future):
raise RuntimeError(
'greenlet.yield_from was supposed to receive only Futures, '
'got {!r} in task {!r}'.format(future, task))
# "_wakeup" will call the "_step" method (which we overloaded in
# GreenTask, and therefore wakeup the awaiting greenlet)
future.add_done_callback(task._wakeup)
task._fut_waiter = future
# task cancellation has been delayed.
if task._must_cancel:
if task._fut_waiter.cancel():
task._must_cancel = False
# Jump out of the current task greenlet (we'll return to GreenTask._step)
return gl.parent.switch(_YIELDED)
def task(func):
"""A decorator, allows use of ``yield_from`` in the decorated or
subsequent coroutines."""
coro = asyncio.coroutine(func)
def task_wrapper(*args, **kwds):
return GreenTask(coro(*args, **kwds))
return task_wrapper
class _YIELDED(object):
"""Marker, don't use it"""