Skip to main content

Reactive state management for Python

Project description

PyPI version CI status

Observ 👁

Observ is a Python port of Vue.js' computed properties and watchers. It is completely event loop/framework agnostic and has no dependencies so it can be used in any project targeting Python >= 3.6.

Observ provides the following two benefits for stateful applications:

  1. You no longer need to manually invalidate and recompute state (e.g. by dirty flags):
    • computed state is invalidated automatically
    • computed state is lazily re-evaluated
  2. You can react to changes in state (computed or not), enabling unidirectional flow:
    • state changes lead to view changes (e.g. a state change callback updates a UI widget)
    • the view triggers input events (e.g. a mouse event is triggered in the UI)
    • input events lead to state changes (e.g. a mouse event updates the state)

API

from observ import observe, computed, watch

  • state = observe(state)

Observe nested structures of dicts, lists, tuples and sets. Returns an observable clone of the state input object.

  • watcher = watch(func, callback, deep=False, immediate=False)

React to changes in the state accessed in func with callback(old_value, new_value). Returns a watcher object. delelete it to disable the callback.

  • wrapped_func = computed(func)

Define computed state based on observable state with func and recompute lazily. Returns a wrapped copy of the function which only recomputes the output if any of the state it depends on becomes dirty. Can be used as a function decorator.

Quick start and example

Install observ with pip/pipenv/poetry:

pip install observ

Check out examples/observe_qt.py for a simple example using observ.

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

observ-0.5.0.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

observ-0.5.0-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

Details for the file observ-0.5.0.tar.gz.

File metadata

  • Download URL: observ-0.5.0.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for observ-0.5.0.tar.gz
Algorithm Hash digest
SHA256 972c0791b44ec4cb00b8103c3d8a02982f543f9a403c1bf69fe8150c9cb7a1ed
MD5 0b069545417627a3eaea9523e6313d5d
BLAKE2b-256 f751a328591b75dd149b391d5e76db09f692b4d4daa04332148deb84fccc3b22

See more details on using hashes here.

File details

Details for the file observ-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: observ-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 8.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.9.7

File hashes

Hashes for observ-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8d402d1198d914d014386861561c7a1847a5d0489a23efe0ad8c94986815c175
MD5 4bba4ef4c4c6ef470db8d5be11a5ae7a
BLAKE2b-256 716aa2514bef3fd71e75ada28d3c9c26229ac12904db00ab3525f4ebc72ef975

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