A Python EventBus
Project description
pyeventbus3 is a publish/subscribe event bus for Python 3. (Fork of pyeventbus 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)
pyeventbus3 in 3 steps:
Define events:
class MessageEvent: # Additional fields and methods if needed def __init__(self): pass
Prepare subscribers: Declare and annotate your subscribing method, optionally specify a thread mode:
from pyeventbus3.pyeventbus3 import * @subscribe(onEvent=MessageEvent) def func(self, event): # Do something pass
Register your subscriber. For example, if you want to register a class in Python:
from pyeventbus3.pyeventbus3 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 pyeventbus3.pyeventbus3 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 pass
PARALLEL:
Runs the method in a seperate python thread:: @subscribe(threadMode = Mode.PARALLEL, onEvent=MessageEvent) def func(self, event): # Do something pass
GREENLET:
Runs the method in a greenlet using gevent library:: @subscribe(threadMode = Mode.GREENLET, onEvent=MessageEvent) def func(self, event): # Do something pass
BACKGROUND:
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 There is 10 workers by default, see exemple to modify this number.
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 pyeventbus3
Example:
git clone https://github.com/FlavienVernier/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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size pyeventbus3-0.10-py3-none-any.whl (11.2 kB) | File type Wheel | Python version py3 | Upload date | Hashes View |
Filename, size pyeventbus3-0.10.tar.gz (5.1 kB) | File type Source | Python version None | Upload date | Hashes View |
Close
Hashes for pyeventbus3-0.10-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 160205e503dcf790fe1aec1c34f964dc5c59241384ef855ab6905caeea9fb2cf |
|
MD5 | ef483898b4f3c2bd413b378980a6b5d1 |
|
BLAKE2-256 | d57a5c9e2f8cfbc7f1b448a14c09497deba42d6768fa1e3bae69cd7e4dfb2464 |