Reactive properties and owners for Python classes.
Project description
ReactivePy
A simple library to manage reactive properties within an object using custom descriptors and update methods.
About ReactivePy
ReactivePy lets you create objects that contain reactive properties. Those can be updated in bulk, which allows ReactivePy to notify its observers of changes. The callback can then read the history, update value as well as the name of the attribute.
from reactive import ReactiveOwner, ReactiveProperty
class Foo(ReactiveOwner):
def __init__(self):
super().__init__()
self.name = ReactiveProperty("Foo")
self.age = ReactiveProperty(6)
foo = Foo()
def on_change(*args):
for arg in args: print(arg.name, "updated to", arg)
def on_name_change(curr: Any, org: Any):
print("Name updated from", org, "to", curr)
foo.on_change(on_update, foo.name, foo.age)
foo.name.on_change(on_name_update)
foo._bulk_update({"name": "name", "value": "Bar"},
{"name": "age", "value": 12})
Reactive properties can also be strong-typed raising a TypeError
if the value they're being set to doesn't match the field_type
defined in the constructor. Strong-typing a property looks like this:
class Foo(ReactiveOwner):
def __init__(self):
super().__init__()
self.name = ReactiveProperty("Foo", field_type=str)
all_reactive
decorator
The ReactiveOwner.all_reactive
owner can be used on classes, where all public attributes should be reactive, which will additionally override the __setattr__
method to convert any attribute writes.
Classes using the ReactiveOwner.all_reactive
decorator do not need to inherit from ReactiveOwner
:
@ReactiveOwner.all_reactive
class Foo:
def __init__(self):
super().__init__()
self.name = ReactiveProperty("Foo", field_type=str)
Known Issues
class ReactiveProperty
does not work for typebool
andNoneType
.
Project details
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
Hashes for ReactivePy-1.6.0.dev0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b1c05137c6b9a41dfe526c5279f485cf6203c3d5cf2df390d018374d05dbbaff |
|
MD5 | 3a8fb6312c7cec427b635c5d377c43c9 |
|
BLAKE2b-256 | 4ee28e8f2bdf81706f12bd25758f030d436780ab99fb62116612ae6cc71aa756 |