Observ 👁
Observ is a Python port of Vue.js' computed properties and watchers. It is event loop/framework agnostic and has no dependencies so it can be used in any project targeting Python >= 3.9.
The store that used to be part of observ is now available as reliev.
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. Use watcher.pause() and watcher.resume() to temporarily suspend the watcher: if a dependency changed while the watcher was paused, it triggers once upon resume. Call watcher.stop() (or the watcher object itself) to stop it permanently.
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/uv:
pip install observ
Check out examples/observe_qt.py for a simple example using observ.
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.
2 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file observ-0.19.0.tar.gz.
File metadata
- Download URL: observ-0.19.0.tar.gz
- Upload date:
- Size: 38.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
17000f5e33871677ab2976496756597d497e16369bf52121b6461c788f4414fe
|
|
| MD5 |
73bd00f8de1560bcdb81bcc49b899c9c
|
|
| BLAKE2b-256 |
786486b09a04f721fac7d5aac6d39f8a7c03d5e291211b0bcfd25fb278e0fbfc
|
Provenance
The following attestation bundles were made for observ-0.19.0.tar.gz:
Publisher:
ci.yml on fork-tongue/observ
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
observ-0.19.0.tar.gz -
Subject digest:
17000f5e33871677ab2976496756597d497e16369bf52121b6461c788f4414fe - Sigstore transparency entry: 2061818988
- Sigstore integration time:
-
Permalink:
fork-tongue/observ@d71ae2e3221ae27b3227135c67c15a24056c2360 -
Branch / Tag:
refs/tags/v0.19.0 - Owner: https://github.com/fork-tongue
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@d71ae2e3221ae27b3227135c67c15a24056c2360 -
Trigger Event:
push
-
Statement type:
File details
Details for the file observ-0.19.0-py3-none-any.whl.
File metadata
- Download URL: observ-0.19.0-py3-none-any.whl
- Upload date:
- Size: 20.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4a357243f3b376ad68e64fe6c2565634da7459db25c00087025ae24e90b048f8
|
|
| MD5 |
30258fe32459a22cadf718f99e3219f0
|
|
| BLAKE2b-256 |
c0921b0c4c4c0bdb050aed9e59d3e0273278e2876db7ebea006956c42e064c94
|
Provenance
The following attestation bundles were made for observ-0.19.0-py3-none-any.whl:
Publisher:
ci.yml on fork-tongue/observ
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
observ-0.19.0-py3-none-any.whl -
Subject digest:
4a357243f3b376ad68e64fe6c2565634da7459db25c00087025ae24e90b048f8 - Sigstore transparency entry: 2061819221
- Sigstore integration time:
-
Permalink:
fork-tongue/observ@d71ae2e3221ae27b3227135c67c15a24056c2360 -
Branch / Tag:
refs/tags/v0.19.0 - Owner: https://github.com/fork-tongue
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
ci.yml@d71ae2e3221ae27b3227135c67c15a24056c2360 -
Trigger Event:
push
-
Statement type:
