refactor: rename _id field of combine reducer state to combine_reducers_id

Author: sassanh

CHANGELOG.md

@@ -6,6 +6,7 @@
 - refactor: move the common code for manipulating the signature of the wrapped functions in `WithStore` and `Autorun` to a utility function
 - feat: support `with_state` to be applied to methods of classes, not just functions
 - feat: support `view` to be applied to methods of classes, not just functions, it works for `autorun` too, but only when it is being called directly like a view
+- refactor: rename `_id` field of combine reducer state to `combine_reducers_id`
 
 ## Version 0.23.0
 

README.md

@@ -275,7 +275,7 @@ You can then add a new reducer to it using the `reducer_id` like this:
 ```python
 store.dispatch(
     CombineReducerRegisterAction(
-        _id=reducer_id,
+        combine_reducers_id=reducer_id,
         key='third',
         third=third_reducer,
     ),
@@ -287,7 +287,7 @@ You can also remove a reducer from it like this:
 ```python
 store.dispatch(
     CombineReducerRegisterAction(
-        _id=reducer_id,
+        combine_reducers_id=reducer_id,
         key='second',
     ),
 )

demo.py

@@ -156,7 +156,7 @@ def render(base10_value: CountStateType) -> int:
 
     store.dispatch(
         CombineReducerRegisterAction(
-            _id=reducer_id,
+            combine_reducers_id=reducer_id,
             key='inverse',
             reducer=inverse_reducer,
         ),
@@ -167,7 +167,7 @@ def render(base10_value: CountStateType) -> int:
 
     store.dispatch(
         CombineReducerUnregisterAction(
-            _id=reducer_id,
+            combine_reducers_id=reducer_id,
             key='straight',
         ),
     )

pyproject.toml

@@ -19,7 +19,7 @@ classifiers = [
 [tool.uv]
 dev-dependencies = [
   "poethepoet >= 0.24.4",
-  "pyright >= 1.1.400",
+  "pyright >= 1.1.401",
   "ruff >= 0.11.8",
   "pytest >= 8.1.1",
   "pytest-cov >= 4.1.0",

redux/basic_types.py

@@ -471,11 +471,11 @@ def __call__(
 
 
 class BaseCombineReducerState(Immutable):
-    _id: str
+    combine_reducers_id: str
 
 
 class CombineReducerAction(BaseAction):
-    _id: str
+    combine_reducers_id: str
 
 
 class CombineReducerInitAction(CombineReducerAction, InitAction, Generic[Payload]):

redux/combine_reducers.py

@@ -44,9 +44,12 @@ def combine_reducers(
 ) -> tuple[ReducerType[CombineReducerState, Action, Event], str]:
     _ = action_type, event_type
     reducers = reducers.copy()
-    _id = uuid.uuid4().hex
+    id_ = uuid.uuid4().hex
 
-    state_class = make_immutable(state_type.__name__, (('_id', str), *reducers.keys()))
+    state_class = make_immutable(
+        state_type.__name__,
+        (('combine_reducers_id', str), *reducers.keys()),
+    )
 
     def combined_reducer(
         state: CombineReducerState | None,
@@ -58,22 +61,26 @@ def combined_reducer(
         if (
             state is not None
             and isinstance(action, CombineReducerAction)
-            and action._id == _id  # noqa: SLF001
+            and action.combine_reducers_id == id_
         ):
             if isinstance(action, CombineReducerRegisterAction):
                 key = action.key
                 reducer = action.reducer
                 reducers[key] = reducer
                 state_class = make_immutable(
                     state_type.__name__,
-                    (('_id', str), *reducers.keys()),
+                    (('combine_reducers_id', str), *reducers.keys()),
                 )
                 reducer_result = reducer(
                     None,
-                    CombineReducerInitAction(_id=_id, key=key, payload=action.payload),
+                    CombineReducerInitAction(
+                        combine_reducers_id=id_,
+                        key=key,
+                        payload=action.payload,
+                    ),
                 )
                 state = state_class(
-                    _id=state._id,  # noqa: SLF001
+                    combine_reducers_id=state.combine_reducers_id,
                     **{
                         key_: (
                             reducer_result.state
@@ -107,21 +114,21 @@ def combined_reducer(
                 state_class.__dataclass_fields__ = fields_copy
 
                 state = state_class(
-                    _id=state._id,  # noqa: SLF001
+                    combine_reducers_id=state.combine_reducers_id,
                     **{key_: getattr(state, key_) for key_ in reducers if key_ != key},
                 )
 
         reducers_results = {
             key: reducer(
                 None if state is None else getattr(state, key),
-                CombineReducerInitAction(key=key, _id=_id)
+                CombineReducerInitAction(key=key, combine_reducers_id=id_)
                 if isinstance(action, InitAction)
                 else action,
             )
             for key, reducer in reducers.items()
         }
         result_state = state_class(
-            _id=_id,
+            combine_reducers_id=id_,
             **{
                 key: result.state if is_complete_reducer_result(result) else result
                 for key, result in reducers_results.items()
@@ -150,4 +157,4 @@ def combined_reducer(
             events=result_events,
         )
 
-    return combined_reducer, _id
+    return combined_reducer, id_

tests/results/test_features/general/store-000.jsonc

@@ -1,11 +1,11 @@
 // store-000
 {
-  "_id": "e3e70682c2094cac629f6fbed82c07cd",
   "_type": "StateType",
   "base10": {
     "_type": "CountStateType",
     "count": 10
   },
+  "combine_reducers_id": "e3e70682c2094cac629f6fbed82c07cd",
   "straight": {
     "_type": "CountStateType",
     "count": 0

tests/results/test_features/general/store-001.jsonc

@@ -1,11 +1,11 @@
 // store-001
 {
-  "_id": "e3e70682c2094cac629f6fbed82c07cd",
   "_type": "StateType",
   "base10": {
     "_type": "CountStateType",
     "count": 11
   },
+  "combine_reducers_id": "e3e70682c2094cac629f6fbed82c07cd",
   "straight": {
     "_type": "CountStateType",
     "count": 1

tests/results/test_features/general/store-002.jsonc

@@ -1,11 +1,11 @@
 // store-002
 {
-  "_id": "e3e70682c2094cac629f6fbed82c07cd",
   "_type": "StateType",
   "base10": {
     "_type": "CountStateType",
     "count": 12
   },
+  "combine_reducers_id": "e3e70682c2094cac629f6fbed82c07cd",
   "inverse": {
     "_type": "CountStateType",
     "count": -1

tests/results/test_features/general/store-003.jsonc

@@ -1,11 +1,11 @@
 // store-003
 {
-  "_id": "e3e70682c2094cac629f6fbed82c07cd",
   "_type": "StateType",
   "base10": {
     "_type": "CountStateType",
     "count": 12
   },
+  "combine_reducers_id": "e3e70682c2094cac629f6fbed82c07cd",
   "inverse": {
     "_type": "CountStateType",
     "count": -1