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 event loop/framework agnostic and has only one pure-python dependency (patchdiff) so it can be used in any project targeting Python >= 3.9.

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 reactive, computed, watch

  • state = reactive(state)

Observe nested structures of dicts, lists, tuples and sets. Returns an observable proxy that wraps 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.

Note: The API has evolved and become more powerful since the original creation of this README. Track issue #10 to follow updates to observ's documentation.

Quick start and examples

Install observ with pip/pipenv/poetry:

pip install observ

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

Check out examples/store_with_undo_redo.py for a simple example using the included undo/redo-capable Store abstraction.

Caveat

Observ keeps references to the object passed to the reactive in order to keep track of dependencies and proxies for that object. When the object that is passed into reactive is not managed by other code, then observ should cleanup its references automatically when the proxy is destroyed. However, if there is another reference to the original object, then observ will only release its own reference when the garbage collector is run and all other references to the object are gone. For this reason, the best practise is to keep no references to the raw data, and instead work with the reactive proxies only.

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

Uploaded Source

Built Distribution

observ-0.14.1-py3-none-any.whl (17.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: observ-0.14.1.tar.gz
  • Upload date:
  • Size: 15.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for observ-0.14.1.tar.gz
Algorithm Hash digest
SHA256 66329ce79b6520a67433b68d452d6d9fc7faed8cade0b48623d42d0e03c3a3c2
MD5 7751ed5a5b5addd6e97fcaf6803b7301
BLAKE2b-256 2d063bde55a54c59e4814d8a0a42e4c4b559e576c9936a318b8388a552b5f567

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: observ-0.14.1-py3-none-any.whl
  • Upload date:
  • Size: 17.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for observ-0.14.1-py3-none-any.whl
Algorithm Hash digest
SHA256 1532c44749c1bcc6e197c0eb94cad55a42c967df67c38fd5217d3355ee9fd660
MD5 f009dad9736ab20a297ffa2fb1a4e5a9
BLAKE2b-256 23bab6953c7ad25789842b6bdcaa55b25c14425cb7a0cf446a9777c70d6acdf4

See more details on using hashes here.

Provenance

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