feat(core): add _type field to the serialized immutable instances

sassanh · Sep 3, 2024 · 3708af6 · 3708af6
1 parent 616dfc2
commit 3708af6
Show file tree

Hide file tree

Showing 83 changed files with 247 additions and 101 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## Version 0.16.1
+
+- feat(core): add `_type` field to the serialized immutable instances
+
 ## Version 0.16.0
 
 - feat(core): add blocking `wait_for_event_handlers` method to `Store` to wait for all event handlers to finish

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-redux"
-version = "0.16.0"
+version = "0.16.1"
 description = "Redux implementation for Python"
 authors = ["Sassan Haradji <sassanh@gmail.com>"]
 license = "Apache-2.0"
@@ -14,14 +14,16 @@ packages = [{ include = "redux" }, { include = "redux_pytest" }]
 python = "^3.11"
 python-immutable = "^1.1.1"
 python-strtobool = "^1.0.0"
+pyright = "^1.1.378"
+ruff = "^0.6.3"
 
 [tool.poetry.group.dev]
 optional = true
 
 [tool.poetry.group.dev.dependencies]
 poethepoet = "^0.24.4"
 pyright = "^1.1.376"
-ruff = "^0.5.7"
+ruff = "^0.6.0"
 pytest = "^8.1.1"
 pytest-cov = "^4.1.0"
 pytest-timeout = "^2.3.1"

diff --git a/redux/serialization_mixin.py b/redux/serialization_mixin.py
@@ -37,7 +37,7 @@ def _serialize_dataclass_to_dict(
         cls: type[SerializationMixin],
         obj: Immutable,
     ) -> dict[str, Any]:
-        result = {}
+        result: dict[str, object] = {'_type': obj.__class__.__name__}
         for field in dataclasses.fields(obj):
             value = cls.serialize_value(getattr(obj, field.name))
             result[field.name] = value

diff --git a/redux_pytest/fixtures/event_loop.py b/redux_pytest/fixtures/event_loop.py
@@ -25,7 +25,7 @@ def create_task(self: LoopThread, coro: Coroutine) -> None:
         self.loop.call_soon_threadsafe(self.loop.create_task, coro)
 
 
-@pytest.fixture()
+@pytest.fixture
 def event_loop() -> LoopThread:
     loop_thread = LoopThread()
     loop_thread.start()

diff --git a/redux_pytest/fixtures/monitor.py b/redux_pytest/fixtures/monitor.py
@@ -39,7 +39,7 @@ def monitor(self: StoreMonitor, store: Store) -> None:
         self.store.register_event_middleware(self._event_middleware)
 
 
-@pytest.fixture()
+@pytest.fixture
 def store_monitor(store: Store, mocker: MockerFixture) -> StoreMonitor:
     """Fixture to check if an action was dispatched."""
     monitor = StoreMonitor(mocker)

diff --git a/redux_pytest/fixtures/snapshot.py b/redux_pytest/fixtures/snapshot.py
@@ -145,13 +145,13 @@ def close(self: StoreSnapshot[State]) -> None:
             assert not json_path.exists(), f'Snapshot {filename} not taken'
 
 
-@pytest.fixture()
+@pytest.fixture
 def snapshot_prefix() -> str | None:
     """Return the prefix for the snapshots."""
     return None
 
 
-@pytest.fixture()
+@pytest.fixture
 def store_snapshot(
     request: SubRequest,
     store: Store,

diff --git a/redux_pytest/fixtures/store.py b/redux_pytest/fixtures/store.py
@@ -10,14 +10,14 @@
     from redux.main import Store
 
 
-@pytest.fixture()
-def store() -> Store:  # noqa: PT004 # pragma: no cover
+@pytest.fixture
+def store() -> Store:  # pragma: no cover
     """Provide current store (this is a placeholder returning None)."""
     msg = 'This fixture should be overridden.'
     raise NotImplementedError(msg)
 
 
-@pytest.fixture()
+@pytest.fixture
 def needs_finish(store: Store) -> Generator:
     """Dispatch a finish action after the test."""
     yield None

diff --git a/redux_pytest/fixtures/wait_for.py b/redux_pytest/fixtures/wait_for.py
@@ -157,7 +157,7 @@ def wrapper(*args: WaitForArgs.args, **kwargs: WaitForArgs.kwargs) -> None:
         return decorator(check) if check else decorator
 
 
-@pytest.fixture()
+@pytest.fixture
 def wait_for() -> Generator[WaitFor, None, None]:
     """Provide `wait_for` decorator."""
     context = WaitFor()

diff --git a/tests/results/test_autorun/callability/store-000.jsonc b/tests/results/test_autorun/callability/store-000.jsonc
@@ -1,4 +1,5 @@
 // store-000
 {
+  "_type": "StateType",
   "value": 0
 }
diff --git a/tests/results/test_autorun/callability/store-001.jsonc b/tests/results/test_autorun/callability/store-001.jsonc
@@ -1,4 +1,5 @@
 // store-001
 {
+  "_type": "StateType",
   "value": 1
 }
diff --git a/tests/results/test_autorun/callability/store-002.jsonc b/tests/results/test_autorun/callability/store-002.jsonc
@@ -1,4 +1,5 @@
 // store-002
 {
+  "_type": "StateType",
   "value": 3
 }
diff --git a/tests/results/test_autorun/callability/store-003.jsonc b/tests/results/test_autorun/callability/store-003.jsonc
@@ -1,4 +1,5 @@
 // store-003
 {
+  "_type": "StateType",
   "value": 4
 }
diff --git a/tests/results/test_autorun/general/store-000.jsonc b/tests/results/test_autorun/general/store-000.jsonc
@@ -1,4 +1,5 @@
 // store-000
 {
+  "_type": "StateType",
   "value": 0
 }
diff --git a/tests/results/test_autorun/general/store-001.jsonc b/tests/results/test_autorun/general/store-001.jsonc
@@ -1,4 +1,5 @@
 // store-001
 {
+  "_type": "StateType",
   "value": 1
 }
diff --git a/tests/results/test_autorun/general/store-002.jsonc b/tests/results/test_autorun/general/store-002.jsonc
@@ -1,4 +1,5 @@
 // store-002
 {
+  "_type": "StateType",
   "value": 3
 }
diff --git a/tests/results/test_autorun/general/store-003.jsonc b/tests/results/test_autorun/general/store-003.jsonc
@@ -1,4 +1,5 @@
 // store-003
 {
+  "_type": "StateType",
   "value": 4
 }
diff --git a/tests/results/test_autorun/subscription/store-000.jsonc b/tests/results/test_autorun/subscription/store-000.jsonc
@@ -1,4 +1,5 @@
 // store-000
 {
+  "_type": "StateType",
   "value": 0
 }
diff --git a/tests/results/test_autorun/subscription/store-001.jsonc b/tests/results/test_autorun/subscription/store-001.jsonc
@@ -1,4 +1,5 @@
 // store-001
 {
+  "_type": "StateType",
   "value": 1
 }
diff --git a/tests/results/test_autorun/subscription/store-002.jsonc b/tests/results/test_autorun/subscription/store-002.jsonc
@@ -1,4 +1,5 @@
 // store-002
 {
+  "_type": "StateType",
   "value": 3
 }
diff --git a/tests/results/test_autorun/subscription/store-003.jsonc b/tests/results/test_autorun/subscription/store-003.jsonc
@@ -1,4 +1,5 @@
 // store-003
 {
+  "_type": "StateType",
   "value": 4
 }
diff --git a/tests/results/test_autorun/value_property/store-000.jsonc b/tests/results/test_autorun/value_property/store-000.jsonc
@@ -1,4 +1,5 @@
 // store-000
 {
+  "_type": "StateType",
   "value": 0
 }
diff --git a/tests/results/test_autorun/value_property/store-001.jsonc b/tests/results/test_autorun/value_property/store-001.jsonc
@@ -1,4 +1,5 @@
 // store-001
 {
+  "_type": "StateType",
   "value": 1
 }
diff --git a/tests/results/test_autorun/value_property/store-002.jsonc b/tests/results/test_autorun/value_property/store-002.jsonc
@@ -1,4 +1,5 @@
 // store-002
 {
+  "_type": "StateType",
   "value": 3
 }
diff --git a/tests/results/test_autorun/value_property/store-003.jsonc b/tests/results/test_autorun/value_property/store-003.jsonc
@@ -1,4 +1,5 @@
 // store-003
 {
+  "_type": "StateType",
   "value": 4
 }
diff --git a/tests/results/test_autorun/with_comparator/store-000.jsonc b/tests/results/test_autorun/with_comparator/store-000.jsonc
@@ -1,4 +1,5 @@
 // store-000
 {
+  "_type": "StateType",
   "value": 0
 }
diff --git a/tests/results/test_autorun/with_comparator/store-001.jsonc b/tests/results/test_autorun/with_comparator/store-001.jsonc
@@ -1,4 +1,5 @@
 // store-001
 {
+  "_type": "StateType",
   "value": 1
 }
diff --git a/tests/results/test_autorun/with_comparator/store-002.jsonc b/tests/results/test_autorun/with_comparator/store-002.jsonc
@@ -1,4 +1,5 @@
 // store-002
 {
+  "_type": "StateType",
   "value": 4
 }
diff --git a/tests/results/test_features/general/store-000.jsonc b/tests/results/test_features/general/store-000.jsonc
@@ -1,10 +1,13 @@
 // store-000
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 10
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 0
   }
 }
diff --git a/tests/results/test_features/general/store-001.jsonc b/tests/results/test_features/general/store-001.jsonc
@@ -1,10 +1,13 @@
 // store-001
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 11
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 1
   }
 }
diff --git a/tests/results/test_features/general/store-002.jsonc b/tests/results/test_features/general/store-002.jsonc
@@ -1,13 +1,17 @@
 // store-002
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 12
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": -1
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 2
   }
 }
diff --git a/tests/results/test_features/general/store-003.jsonc b/tests/results/test_features/general/store-003.jsonc
@@ -1,10 +1,13 @@
 // store-003
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 12
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": -1
   }
 }
diff --git a/tests/results/test_features/general/store-004.jsonc b/tests/results/test_features/general/store-004.jsonc
@@ -1,10 +1,13 @@
 // store-004
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 10
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": 1
   }
 }
diff --git a/tests/results/test_features/general/store-005.jsonc b/tests/results/test_features/general/store-005.jsonc
@@ -1,10 +1,13 @@
 // store-005
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 8
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": 3
   }
 }
diff --git a/tests/results/test_features/general/store-autorun-000.jsonc b/tests/results/test_features/general/store-autorun-000.jsonc
@@ -1,10 +1,13 @@
 // store-autorun-000
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 10
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 0
   }
 }
diff --git a/tests/results/test_features/general/store-autorun-001.jsonc b/tests/results/test_features/general/store-autorun-001.jsonc
@@ -1,10 +1,13 @@
 // store-autorun-001
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 11
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 1
   }
 }
diff --git a/tests/results/test_features/general/store-autorun-002.jsonc b/tests/results/test_features/general/store-autorun-002.jsonc
@@ -1,13 +1,17 @@
 // store-autorun-002
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 12
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": -1
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 2
   }
 }
diff --git a/tests/results/test_features/general/store-autorun-003.jsonc b/tests/results/test_features/general/store-autorun-003.jsonc
@@ -1,10 +1,13 @@
 // store-autorun-003
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 10
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": 1
   }
 }
diff --git a/tests/results/test_features/general/store-autorun-004.jsonc b/tests/results/test_features/general/store-autorun-004.jsonc
@@ -1,10 +1,13 @@
 // store-autorun-004
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 8
   },
   "inverse": {
+    "_type": "CountStateType",
     "count": 3
   }
 }
diff --git a/tests/results/test_features/general/store-autorun_subscription-000.jsonc b/tests/results/test_features/general/store-autorun_subscription-000.jsonc
@@ -1,10 +1,13 @@
 // store-autorun_subscription-000
 {
   "_id": "e3e70682c2094cac629f6fbed82c07cd",
+  "_type": "StateType",
   "base10": {
+    "_type": "CountStateType",
     "count": 10
   },
   "straight": {
+    "_type": "CountStateType",
     "count": 0
   }
 }