Skip to main content

No project description provided

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

Uploaded Source

Built Distribution

observ-0.3.0-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: observ-0.3.0.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.6.8 Windows/10

File hashes

Hashes for observ-0.3.0.tar.gz
Algorithm Hash digest
SHA256 6a7b6cff92158387c412f0f7f9838241830f5ab95cc0b398d7fdd5a62816482e
MD5 82a00d4a2012f78ffd21fa2040140523
BLAKE2b-256 b86f4e2a261532c50d5073408e449e74acad2cf26a2af4d1ffe7639a8b32f150

See more details on using hashes here.

File details

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

File metadata

  • Download URL: observ-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 5.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.4 CPython/3.6.8 Windows/10

File hashes

Hashes for observ-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a524b09725c8a4095db22461fca00f17d1ac4b4eab6739dc96660c0ba10f4e22
MD5 c830944795611ed45f679370bd4622e9
BLAKE2b-256 852915ef786d84fd58209620d0e3c1761338f33fafd9d6897581c09fe51e5e9d

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