Skip to main content

Reactive Signals and Computed values.

Project description

Signified

PyPI - Downloads PyPI - Version Tests Status


Documentation: https://dougmercer.github.io/signified

Source Code: https://github.com/dougmercer/signified


A Python library for reactive programming (with kind-of working type narrowing).

Getting started

pip install signified

Why care?

signified is a reactive programming library that implements two primary data structures: Signal and Computed.

Both of these objects implement the Observer and Observable design patterns. This means that they can notify other Observers if they change, and they can subscribe to be notified if another Observable changes.

This allows us to create a network of computation, where one value being modified can trigger other objects to update.

This allows us to write more declarative code, like,

x = Signal(3)
x_squared = x ** 2  # currently equal to 9
x.value = 10  # Will immediately notify x_squared, whose value will become 100.

Here, x_squared became a reactive expression (more specifically, a Computed object) whose value is always equal to x ** 2. Neat!

signified's Signal object effective gives us a container which stores a value, and Computed gives us a container to store the current value of a function. In the above example, we generated the Computed object on-the-fly using overloaded Python operators like **, but we could have just as easily done,

from signified import computed

@computed
def power(x, n):
    return x**n

x_squared = power(x, 2)  # equivalent to the above

Together, these data structures allow us to implement a wide variety of capabilities. In particular, I wrote this library to make my to-be-released animation library easier to maintain and more fun to work with.

... what do you mean by "kind of working type narrowing"?

Other reactive Python libraries don't really attempt to implement type hints (e.g., param).

signified is type hinted and supports type narrowing even for nested reactive values.

from signified import Signal

a = Signal(1.0)
b = Signal(Signal(Signal(2)))
reveal_type(a + b)  # Computed[float | int]

Unfortunately, for the time being, our type hints only work with pyright.

Read the docs!

Checkout https://dougmercer.github.io/signified to find out more.

Project details


Download files

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

Source Distribution

signified-0.1.5.tar.gz (16.5 kB view details)

Uploaded Source

Built Distribution

signified-0.1.5-py3-none-any.whl (12.3 kB view details)

Uploaded Python 3

File details

Details for the file signified-0.1.5.tar.gz.

File metadata

  • Download URL: signified-0.1.5.tar.gz
  • Upload date:
  • Size: 16.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for signified-0.1.5.tar.gz
Algorithm Hash digest
SHA256 6a60ddd64781c17041c43e46838aa83069a2b22a3d9eba67d21c18349964db03
MD5 ff66c59b59f6c65725c5d42b8c8ca0b4
BLAKE2b-256 51074cc4bfda805e800d43fc7e22cff825f0ecda0d9aa44aff1503fc34b74c66

See more details on using hashes here.

File details

Details for the file signified-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: signified-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 12.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for signified-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 f00491cc2797d1a013d42fd253c7ca4aeaf88d05d914bc2901ceaad1aac71ed1
MD5 44de6eed7fabfc367c8b5b61c00772ad
BLAKE2b-256 daff85d0c050e3d701a4bebf3c38ff917d05b0d77de4ad631bbd16092acc2694

See more details on using hashes here.

Supported by

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