Source code for pykka.gevent

from __future__ import absolute_import

import sys
import warnings

import gevent
import gevent.event
import gevent.queue

from pykka import Actor, Future, Timeout


__all__ = ['GeventActor', 'GeventFuture']


warnings.warn(
    "eventlet support is deprecated and will be removed in Pykka 3.0.",
    DeprecationWarning,
)


class GeventFuture(Future):
    """
    :class:`GeventFuture` implements :class:`pykka.Future` for use with
    :class:`GeventActor`.

    It encapsulates a :class:`gevent.event.AsyncResult` object which may be
    used directly, though it will couple your code with gevent.
    """

    #: The encapsulated :class:`gevent.event.AsyncResult`
    async_result = None

    def __init__(self, async_result=None):
        super(GeventFuture, self).__init__()
        if async_result is None:
            async_result = gevent.event.AsyncResult()
        self.async_result = async_result

    def get(self, timeout=None):
        try:
            return super(GeventFuture, self).get(timeout=timeout)
        except NotImplementedError:
            pass

        try:
            return self.async_result.get(timeout=timeout)
        except gevent.Timeout as e:
            raise Timeout(e)

    def set(self, value=None):
        assert not self.async_result.ready(), 'value has already been set'
        self.async_result.set(value)

    def set_exception(self, exc_info=None):
        assert exc_info is None or len(exc_info) == 3
        exc_info = exc_info or sys.exc_info()
        self.async_result.set_exception(exc_info[1], exc_info=exc_info)


class GeventActor(Actor):
    """
    :class:`GeventActor` implements :class:`pykka.Actor` using the `gevent
    <http://www.gevent.org/>`_ library. gevent is a coroutine-based Python
    networking library that uses greenlet to provide a high-level synchronous
    API on top of libevent event loop.

    This is a very fast implementation.
    """

    @staticmethod
    def _create_actor_inbox():
        return gevent.queue.Queue()

    @staticmethod
    def _create_future():
        return GeventFuture()

    def _start_actor_loop(self):
        gevent.Greenlet.spawn(self._actor_loop)