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.4.0.tar.gz (7.5 kB view details)

Uploaded Source

Built Distribution

observ-0.4.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: observ-0.4.0.tar.gz
  • Upload date:
  • Size: 7.5 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.4.0.tar.gz
Algorithm Hash digest
SHA256 a8d9b1480e8b791bd1f36f62d852507da4535bfd0b670b65c30ef1c0f337894d
MD5 7c99366ade0353be7a51184ff36dcb69
BLAKE2b-256 c0f712e1f0c462e61e2d2fff8d10b8de43bd3d8c433d1511309a4601c2ad09f0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: observ-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 8.2 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.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2410788b31d1874364fa9423c5aa3476763eb2f872bb074c3942ec7a8c9feb30
MD5 ebdc026840d9112d0457e9cb533d3b8e
BLAKE2b-256 04c06823aee7a9afa5697e782d4f89a2d7aa4a016f4f29d8d46971a20927a65b

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