Skip to main content

Simple signal/slot implementation

Project description

https://img.shields.io/pypi/v/signaling.svg?style=flat-square https://img.shields.io/travis/mdomke/signaling/master.svg?style=flat-square https://img.shields.io/pypi/l/signaling.svg?style=flat-square

What is this?

signaling is a simple implementation of the signal/slot pattern as known from the Qt framework. It has no external requirements and 100% test-coverage.

Installation

The usual

pip install signaling

How to use it?

Consider that you have a function that should be called whenever a connected signal is emitted, as illustrated by the following code block:

def slot(arg):
  print("Slot called with {}".format(arg))

signal = Signal(args=['arg'])
signal.connect(slot)
signal.emit(arg=1)  # Slot called with 1

In fact you can connect multiple slots to the same signal, as long as they share the same function signature.

Notice that the signaling library performs some sanity checks when connecting slots and emitting signals.

  • All slots connected to a signal have to provide the same argument specifiction as denoted by the args parameter of the Signal constructor.

  • An emit-call has to be made with the exact same arguments as specified with the Signal constructor.

So all of the below examples would raise an exception:

def slot_with_arg(arg):
  pass

def slot_without_arg():
  pass

# InvalidSlot: Slot 'slot_with_arg' has to callable without arguments
Signal().connect(slot_with_arg)

# InvalidSlot: Slot 'slot_without_args' has to accept args ['arg'] or **kwargs.
Signal(args['arg']).connect(slot_without_arg)

s = Signal()
s.connect(slot_without_args)
# InvalidEmit: Emit has to be called without arguments.
s.emit(foo=1)

Project details


Download files

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

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

signaling-0.0.2-py2.py3-none-any.whl (5.6 kB view details)

Uploaded Python 2Python 3

File details

Details for the file signaling-0.0.2-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for signaling-0.0.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 afe93eb37f93807a205bf79cbddee7e468c710463e148ff159abafb0c5a72f30
MD5 819834ffb10c856190f4d658d65411cb
BLAKE2b-256 bdb049dae878106f102bbad38446ee77fb6450a1c790bb5e5f7e819dbedc3eb4

See more details on using hashes here.

Supported by

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