/usr/lib/python2.7/dist-packages/pyee/__init__.py is in python-pyee 3.0.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 | # -*- coding: utf-8 -*-
"""
pyee supplies an ``EventEmitter`` object similar to the ``EventEmitter``
from Node.js. It supports both synchronous callbacks and asyncio coroutines.
Example
-------
::
In [1]: from pyee import EventEmitter
In [2]: ee = EventEmitter()
In [3]: @ee.on('event')
...: def event_handler():
...: print('BANG BANG')
...:
In [4]: ee.emit('event')
BANG BANG
In [5]:
"""
try:
from asyncio import iscoroutine, ensure_future
except ImportError:
iscoroutine = None
ensure_future = None
from collections import defaultdict
__all__ = ['EventEmitter', 'PyeeException']
class PyeeException(Exception):
"""An exception internal to pyee."""
pass
class EventEmitter(object):
"""The EventEmitter class.
For interoperation with asyncio, one can specify the scheduler and
the event loop. The scheduler defaults to ``asyncio.ensure_future``,
and the loop defaults to ``None``. When used with the default scheduler,
this will schedule the coroutine onto asyncio's default loop.
This should also be compatible with recent versions of twisted by
setting ``scheduler=twisted.internet.defer.ensureDeferred``.
Most events are registered with EventEmitter via the ``on`` and ``once``
methods. However, pyee EventEmitters have two *special* events:
- ``new_listener``: Fires whenever a new listener is created. Listeners for
this event do not fire upon their own creation.
- ``error``: When emitted raises an Exception by default, behavior can be
overriden by attaching callback to the event.
For example::
@ee.on('error')
def onError(message):
logging.err(message)
ee.emit('error', Exception('something blew up'))
For synchronous callbacks, exceptions are **not** handled for you---
you must catch your own exceptions inside synchronous ``on`` handlers.
However, when wrapping **async** functions, errors will be intercepted
and emitted under the ``error`` event. **This behavior for async
functions is inconsistent with node.js**, which unlike this package has
no facilities for handling returned Promises from handlers.
"""
def __init__(self, scheduler=ensure_future, loop=None):
self._events = defaultdict(list)
self._schedule = scheduler
self._loop = loop
def on(self, event, f=None):
"""Registers the function (or optionally an asyncio coroutine function)
``f`` to the event name ``event``.
If ``f`` isn't provided, this method returns a function that
takes ``f`` as a callback; in other words, you can use this method
as a decorator, like so::
@ee.on('data')
def data_handler(data):
print(data)
As mentioned, this method can also take an asyncio coroutine function::
@ee.on('data')
async def data_handler(data)
await do_async_thing(data)
This will automatically schedule the coroutine using the configured
scheduling function (defaults to ``asyncio.ensure_future``) and the
configured event loop (defaults to ``asyncio.get_event_loop()``).
"""
def _on(f):
# Fire 'new_listener' *before* adding the new listener!
self.emit('new_listener', event, f)
# Add the necessary function
self._events[event].append(f)
# Return original function so removal works
return f
if f is None:
return _on
else:
return _on(f)
def emit(self, event, *args, **kwargs):
"""Emit ``event``, passing ``*args`` and ``**kwargs`` to each attached
function. Returns ``True`` if any functions are attached to ``event``;
otherwise returns ``False``.
Example::
ee.emit('data', '00101001')
Assuming ``data`` is an attached function, this will call
``data('00101001')'``.
For coroutine event handlers, calling emit is non-blocking. In other
words, you do not have to await any results from emit, and the
coroutine is scheduled in a fire-and-forget fashion.
"""
handled = False
# Copy the events dict first. Avoids a bug if the events dict gets
# changed in the middle of the following for loop.
events_copy = list(self._events[event])
# Pass the args to each function in the events dict
for f in events_copy:
result = f(*args, **kwargs)
if iscoroutine and iscoroutine(result):
if self._loop:
d = self._schedule(result, loop=self._loop)
else:
d = self._schedule(result)
if hasattr(d, 'add_done_callback'):
@d.add_done_callback
def _callback(f):
exc = f.exception()
if exc:
self.emit('error', exc)
elif hasattr(d, 'addErrback'):
@d.addErrback
def _callback(exc):
self.emit('error', exc)
handled = True
if not handled and event == 'error':
if len(args):
raise args[0]
else:
raise PyeeException("Uncaught, unspecified 'error' event.")
return handled
def once(self, event, f=None):
"""The same as ``ee.on``, except that the listener is automatically
removed after being called.
"""
def _once(f):
def g(*args, **kwargs):
f(*args, **kwargs)
self.remove_listener(event, g)
return g
def _wrapper(f):
self.on(event, _once(f))
return f
if f is None:
return _wrapper
else:
_wrapper(f)
def remove_listener(self, event, f):
"""Removes the function ``f`` from ``event``."""
self._events[event].remove(f)
def remove_all_listeners(self, event=None):
"""Remove all listeners attached to ``event``.
If ``event`` is ``None``, remove all listeners on all events.
"""
if event is not None:
self._events[event] = []
else:
self._events = None
self._events = defaultdict(list)
def listeners(self, event):
"""Returns the list of all listeners registered to the ``event``.
"""
return self._events[event]
|