pyee2

A port of node.js's primus/eventemitter3 to python. Based on jfhbrook/pyee.


Keywords
events, emitter, node, js, eventemitter, eventemitter3, asyncio, python-3
License
MIT
Install
pip install pyee2==2.0.0

Documentation

pyee2

Code style: black

pyee2 is the primus/eventemitter3 EventEmitter implementation ported to python with inspiration from jfhbrook/pyee.

pyee2:

  • Does not raise or emit an error event when your listener raises an error and no one is listening for the "error" event. That is to say pyee2 catches all errors raised by event listeners and only emits an error if there are listeners for the "error" event.
  • The only time an exception is raised from an "emit" function is if EventEmitter.raising_emit is used to emit the event.
  • Does not not emit an event when a new listener is added or removed.
  • Only supports function or functions that return awaitables (coroutine, future, task) as event listeners. The test for awaitableness is done via "inspect.isawaitable"
from pyee2 import EventEmitter

ee = EventEmitter()

@ee.on("event")
def handler(arg, data=3):
    print(f"handler called arg={arg} data={data}")

ee.emit("event", 1, data=2)