Skip to main content

Simple python events library

Project description

PyEventEmitter

Python events library, heavily inspired by Node.js’ EventEmitter.

Installation

$ pip install PyEventEmitter

How to use

The library provides an EventEmitter class. This class let you bind listeners to events and trigger events.

import event_emitter as events

em = events.EventEmitter()

def hello(who):
    print('Hello {}'.format(who))

em.on('hello', hello)
em.emit('hello', who='World')  # prints Hello World

You can also use on decorator :

import event_emitter as events

em = events.EventEmitter()

@events.on(emitter=em, event='hello')
def hello(who):
    print('Hello {}'.format(who))

em.emit('hello', who='World')  # prints Hello World

Using once instead of on may be usefull if you want your listener to be called once :

import event_emitter as events

em = events.EventEmitter()

def hello(who):
    print('Hello {}'.format(who))

em.once('hello', hello)
em.emit('hello', who='World')  # prints Hello World
em.emit('hello', who='World')  # nothing happens

Of course, there is also a decorator for this :

import event_emitter as events

em = events.EventEmitter()

@events.once(emitter=em, event='hello')
def hello(who):
    print('Hello {}'.format(who))

em.emit('hello', who='World')  # prints Hello World

You can remove a listener bound to an event :

import event_emitter as events

em = events.EventEmitter()

def hello(who):
    print('Hello {}'.format(who))

em.on('hello', hello)
em.remove('hello', hello)
em.emit('hello', who='World')  # nothing happens

You can also remove all listeners bound to an event thanks to remove_all.

The count method returns the number of listeners bound to an event :

import event_emitter as events

em = events.EventEmitter()

def hello(who):
    print('Hello {}'.format(who))

em.on('hello', hello)
print(em.count('hello'))  # prints 1

Project details


Release history Release notifications

This version
History Node

1.0.4

History Node

1.0.3

History Node

1.0.2

History Node

1.0.0

History Node

0.1.3

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
PyEventEmitter-1.0.4.tar.gz (1.9 kB) Copy SHA256 hash SHA256 Source None Jun 4, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page