Skip to main content

Lightweight event handling for Python

Build Status Coverage Status PyPI version GitHub 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

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.91.tar.gz (9.6 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.91-py2.py3-none-any.whl (9.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

File hashes

Hashes for python-dispatch-0.0.91.tar.gz
Algorithm Hash digest
SHA256 d3f95e290af9db8f6e98d211231f21014abd6cfe23c04b6a3297ddbbb3c3d6a4
MD5 4b3b66137ddc69c038f65dc5fdf59c8c
BLAKE2b-256 213253b653ee81e52fa2da3e5b656320c6efc38d1e0f983d5c22022700483465

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for python_dispatch-0.0.91-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 578fd64b9d20a3336cfd134f1af8e8bf453060d675b95c5b1422a838e6fdcdaa
MD5 0d8a7bc7bfabe2914351e89ca149944a
BLAKE2b-256 929edb952cbe7f0255fc432e2075faab2faf02b1c0d1c869778ef7ceb7fc69d3

See more details on using hashes here.

Release history Release notifications | RSS feed

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.32

2 files

0.1.31

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

This release

0.0.91 This release

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page