Reactive state management for Python
Project description
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:
- 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
- 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.
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.
Caveats
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.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file observ-0.6.0.tar.gz.
File metadata
- Download URL: observ-0.6.0.tar.gz
- Upload date:
- Size: 11.0 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fd3f07248847cf0c44b38798ec5746b88e87093d590682b9a46a1f595d7c8bce |
|
| MD5 | 2ceb919d49708a53b625a3f16283f80a |
|
| BLAKE2b-256 | 20656bcb24b34d7eca48236f571b3005bf863eb2951e9fa2c707f060f97f410a |
File details
Details for the file observ-0.6.0-py3-none-any.whl.
File metadata
- Download URL: observ-0.6.0-py3-none-any.whl
- Upload date:
- Size: 11.3 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b709657dafbd522effb3534a0fcf5f124e650ea392e6b6768ae5a9f0177c1f19 |
|
| MD5 | c9d59e8a47a11b189e016fb8a440350b |
|
| BLAKE2b-256 | 9a8e6943728827c1ff3fc5cb6e8ad158a1e019fdf33e479b2975edd4b1bf43f7 |
