[REF-1356] Track changes applied to Base subclass via helper method.
#2242
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
When a helper method manipulates fields on a Base instance that is associated with a state, recursively wrap the helper method with the MutableProxy so it also tracks changes. If the helper method returns a mutable object, this object will also be tied back to the same field on the state to allow for "get_*" type functions that still track changes. Fix #2239
ariwbolton
reviewed
Dec 1, 2023
tests/test_state.py
Outdated
Comment on lines
2331
to
2344
| def test_set_base_field_via_setter(): | ||
| """When calling a setter on a Base instance, also track changes.""" | ||
|
|
||
| class BaseFieldSetterState(BaseState): | ||
| c1: Custom1 = Custom1(foo="") | ||
|
|
||
| bfss = BaseFieldSetterState() | ||
| assert "c1" not in bfss.dirty_vars | ||
| bfss.c1.double_foo() | ||
| assert "c1" not in bfss.dirty_vars | ||
| bfss.c1.set_foo("bar") | ||
| assert "c1" in bfss.dirty_vars | ||
|
|
||
|
|
There was a problem hiding this comment.
Great, this covers the issue -- thanks!
I'm now wondering if this will work if using Custom2 to do a nested call to Custom1 (something like a hypothetical c2r.set_c1_foo(), which calls c1r.set_foo()). I do see some terminology around recursion in the function wrapper, so if I had to guess it seems like this is the intent; if so maybe good to also capture in a test case?
tests/test_state.py
Outdated
Comment on lines
2331
to
2344
| def test_set_base_field_via_setter(): | ||
| """When calling a setter on a Base instance, also track changes.""" | ||
|
|
||
| class BaseFieldSetterState(BaseState): | ||
| c1: Custom1 = Custom1(foo="") | ||
|
|
||
| bfss = BaseFieldSetterState() | ||
| assert "c1" not in bfss.dirty_vars | ||
| bfss.c1.double_foo() | ||
| assert "c1" not in bfss.dirty_vars | ||
| bfss.c1.set_foo("bar") | ||
| assert "c1" in bfss.dirty_vars | ||
|
|
||
|
|
There was a problem hiding this comment.
Also wondering how this works for shared references, too? Something like this:
class State(rx.State):
a: A()
b: B()
def __init__(self):
c = C()
a.c = c
b.c = c
def trigger_a():
self.a.update_c() # Does this trigger `b` being dirty?
masenf
changed the title
Base subclass via helper method.Base subclass via helper method.
picklelo
reviewed
May 28, 2024
picklelo
approved these changes
May 30, 2024
benedikt-bartscher
pushed a commit
to benedikt-bartscher/reflex
that referenced
this pull request
Jun 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When a helper method manipulates fields on a Base instance that is associated with a state, recursively wrap the helper method with the MutableProxy so it also tracks changes.
If the helper method returns a mutable object, this object will also be tied back to the same field on the state to allow for "get_*" type functions that still track changes.
Fix #2239