pyeventbus
pyeventbus is a publish/subscribe event bus for Python 2.7.
- simplifies the communication between python classes
- decouples event senders and receivers
- performs well threads, greenlets, queues and concurrent processes
- avoids complex and error-prone dependencies and life cycle issues
- makes code simpler
- has advanced features like delivery threads, workers and spawning different processes, etc.
- is tiny (3KB archive)
pyeventbus in 3 steps:
Define events:
class MessageEvent: # Additional fields and methods if needed def __init__(self): passPrepare subscribers: Declare and annotate your subscribing method, optionally specify a thread mode:
from pyeventbus import * @subscribe(onEvent=MessageEvent) def func(self, event): # Do something passRegister your subscriber. For example, if you want to register a class in Python:
from pyeventbus import * class MyClass: def __init__(self): pass def register(self, myclass): PyBus.Instance().register(myclass, self.__class__.__name__) # then during initilization myclass = MyClass() myclass.register(myclass)Post events:
from pyeventbus import * class MyClass: def __init__(self): pass def register(self, myclass): PyBus.Instance().register(myclass, self.__class__.__name__) def postingAnEvent(self): PyBus.Instance().post(MessageEvent()) myclass = MyClass() myclass.register(myclass) myclass.postingAnEvent()
Modes: pyeventbus can run the subscribing methods in 5 different modes
POSTING:
Runs the method in the same thread as posted. For example, if an event is posted from main thread, the subscribing method also runs in the main thread. If an event is posted in a seperate thread, the subscribing method runs in the same seperate method This is the default mode, if no mode has been provided:: @subscribe(threadMode = Mode.POSTING, onEvent=MessageEvent) def func(self, event): # Do something passPARALLEL:
Runs the method in a seperate python thread:: @subscribe(threadMode = Mode.PARALLEL, onEvent=MessageEvent) def func(self, event): # Do something passGREENLET:
Runs the method in a greenlet using gevent library:: @subscribe(threadMode = Mode.GREENLET, onEvent=MessageEvent) def func(self, event): # Do something passBACKGROUND:
Adds the subscribing methods to a queue which is executed by workers:: @subscribe(threadMode = Mode.BACKGROUND, onEvent=MessageEvent) def func(self, event): # Do something pass
CONCURRENT:
Runs the method in a seperate python process:: @subscribe(threadMode = Mode.CONCURRENT, onEvent=MessageEvent) def func(self, event): # Do something pass
Adding pyeventbus to your project:
pip install pyeventbus
Example:
git clone https://github.com/n89nanda/pyeventbus.git cd pyeventbus virtualenv venv source venv/bin/activate pip install pyeventbus python example.py
Benchmarks and Performance:
Refer /pyeventbus/tests/benchmarks.txt for performance benchmarks on CPU, I/O and networks heavy tasks. Run /pyeventbus/tests/test.sh to generate the same benchmarks. Performance comparison between all the modes with Python and Cython
Inspiration
Inspired by Eventbus from greenrobot: https://github.com/greenrobot/EventBus
81 Dec 22, 2022
54 Jan 3, 2023
49 Nov 21, 2022
104 Nov 16, 2022
153 Jan 7, 2023
32 Dec 26, 2022
14 Nov 28, 2022
96 Nov 1, 2022
0 Jul 21, 2022
19 May 04, 2022
80 Nov 28, 2022
1 Jan 06, 2022
1 Dec 25, 2021
10 Dec 05, 2022
72 Dec 08, 2022
67 Dec 25, 2022
16 Dec 04, 2022
16 Dec 13, 2022
2 Jun 28, 2022
6 Jul 31, 2022
577 Dec 17, 2022
79 Jan 06, 2023
0 Jan 07, 2022
93 Sep 30, 2022
58 Dec 23, 2022
179 Dec 28, 2022
1.1k Jan 06, 2023
87 Dec 09, 2022