Skip to main content

Lightweight event handling for Python

Build StatusCoverage StatusPyPI versionGitHub license

Description

This is an implementation of the “Observer Pattern” with inspiration from the Kivy framework. Many of the features though are intentionally stripped down and more generalized. The goal is to have a simple drop-in library with no dependencies that stays out of the programmer’s way.

Installation

pip install python-dispatch

Usage

For more information, see the documentation here: https://nocarryr.github.io/python-dispatch

Events

from pydispatch import Dispatcher

class MyEmitter(Dispatcher):
    # Events are defined in classes and subclasses with the '_events_' attribute
    _events_ = ['on_state', 'new_data']
    def do_some_stuff(self):
        # do stuff that makes new data
        data = self.get_some_data()
        # Then emit the change with optional positional and keyword arguments
        self.emit('new_data', data=data)

# An observer - could inherit from Dispatcher or any other class
class MyListener(object):
    def on_new_data(self, *args, **kwargs):
        data = kwargs.get('data')
        print('I got data: {}'.format(data))
    def on_emitter_state(self, *args, **kwargs):
        print('emitter state changed')

emitter = MyEmitter()
listener = MyListener()

emitter.bind(on_state=listener.on_emitter_state)
emitter.bind(new_data=listener.on_new_data)

emitter.do_some_stuff()
# >>> I got data: ...

emitter.emit('on_state')
# >>> emitter state changed

Properties

from pydispatch import Dispatcher, Property

class MyEmitter(Dispatcher):
    # Property objects are defined and named at the class level.
    # They will become instance attributes that will emit events when their values change
    name = Property()
    value = Property()

class MyListener(object):
    def on_name(self, instance, value, **kwargs):
        print('emitter name is {}'.format(value))
    def on_value(self, instance, value, **kwargs):
        print('emitter value is {}'.format(value))

emitter = MyEmitter()
listener = MyListener()

emitter.bind(name=listener.on_name, value=listener.on_value)

emitter.name = 'foo'
# >>> emitter name is foo
emitter.value = 42
# >>> emitter value is 42

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

python-dispatch-0.0.9.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

python_dispatch-0.0.9-py2.py3-none-any.whl (11.5 kB view details)

Uploaded Python 2Python 3

File details

Details for the file python-dispatch-0.0.9.tar.gz.

File metadata

File hashes

Hashes for python-dispatch-0.0.9.tar.gz
Algorithm Hash digest
SHA256 27804696f2cf80ad5268a8bd7533dbc079f4dd8789fdada3594b8831f6596dd1
MD5 40d20193f7bed790bb354bf6284be67c
BLAKE2b-256 3c97109424414225921d6208834573543ef68c40ab616156af77d09a3bf18861

See more details on using hashes here.

File details

Details for the file python_dispatch-0.0.9-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for python_dispatch-0.0.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 5f247e5e4fcb354e44655a8d5a109003fb3414691aba874c7172cdfe721e3fb6
MD5 14ee4d266aa4cb1cccb29e0f9e992e57
BLAKE2b-256 b5efc54ca8345c650c2bfb42194a2a8909bae81e028225c221c5b9216ee34863

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page