refactor: improve weakref handling in store listeners and event handlers, remove manual weakref handling in SideEffectRunner, optimize Autorun checks and subscription logic

Author: sassanh

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 - refactor: use custom value `NOT_SET = object()` instead of `None` to signal the absence of a value for the `default_value` parameter in `AutorunOptions` and internally in `Autorun` class for properties storing last selector result and last call result
 - build: switch versioning source to `version.py`, support Python 3.14
+- refactor: improve weakref handling in store listeners and event handlers, remove manual `weakref` handling in `SideEffectRunner`, optimize `Autorun` checks and subscription logic
 
 ## Version 0.24.0
 

demo.py

@@ -112,8 +112,8 @@ def inverse_reducer(
 
 reducer, reducer_id = combine_reducers(
     state_type=StateType,
-    action_type=ActionType,  # pyright: ignore [reportArgumentType]
-    event_type=SleepEvent | PrintEvent,  # pyright: ignore [reportArgumentType]
+    action_type=ActionType,  # type: ignore [reportArgumentType]
+    event_type=SleepEvent | PrintEvent,  # type: ignore [reportArgumentType]
     straight=straight_reducer,
     base10=base10_reducer,
 )

pyproject.toml

@@ -92,7 +92,6 @@ profile = "black"
 
 [tool.pyright]
 exclude = ['typings', '.venv']
-filterwarnings = 'error'
 
 [tool.pytest.ini_options]
 log_cli = true

redux/autorun.py

@@ -128,7 +128,7 @@ def __init__(  # noqa: C901, PLR0912
         else:
             self._func = weakref.ref(func, self.unsubscribe)
         self._is_coroutine = (
-            asyncio.coroutines._is_coroutine  # pyright: ignore [reportAttributeAccessIssue]  # noqa: SLF001
+            asyncio.coroutines._is_coroutine  # type: ignore [reportAttributeAccessIssue]  # noqa: SLF001
             if asyncio.iscoroutinefunction(func) and options.auto_await is False
             else None
         )
@@ -231,11 +231,9 @@ def check(
             Args,
             ReturnType,
         ],
-        state: State | None,
+        state: State,
     ) -> bool:
         """Check if the autorun should be called based on the current state."""
-        if state is None:
-            return False
         try:
             selector_result = self._selector(state)
         except AttributeError:
@@ -317,7 +315,7 @@ def __call__(
         if self._should_be_called or args or kwargs or not self._options.memoization:
             self._should_be_called = False
             self.call(*args, **kwargs)
-        return cast('ReturnType', self._latest_value)
+        return self._latest_value
 
     def __repr__(
         self: Autorun[
@@ -349,7 +347,7 @@ def value(
         ],
     ) -> ReturnType:
         """Get the latest value of the autorun function."""
-        return cast('ReturnType', self._latest_value)
+        return self._latest_value
 
     def subscribe(
         self: Autorun[
@@ -379,7 +377,7 @@ def subscribe(
             callback_ref = weakref.ref(callback)
         self._subscriptions.add(callback_ref)
 
-        if initial_run:
+        if initial_run and self.value is not NOT_SET:
             callback(self.value)
 
         def unsubscribe() -> None:

redux/main.py

@@ -3,6 +3,7 @@
 from __future__ import annotations
 
 import asyncio
+import contextlib
 import inspect
 import queue
 import time
@@ -120,19 +121,11 @@ def __init__(
 
     def _call_listeners(self: Store[State, Action, Event], state: State) -> None:
         for listener_ in self._listeners.copy():
-            if isinstance(listener_, weakref.ref):
-                listener = listener_()
-                if listener is None:
-                    msg = (
-                        'Listener has been garbage collected. '
-                        'Consider using `keep_ref=True` if it suits your use case.'
-                    )
-                    raise RuntimeError(msg)
-            else:
-                listener = listener_
-            result = listener(state)
-            if asyncio.iscoroutine(result) and self.store_options.task_creator:
-                self.store_options.task_creator(result)
+            listener = listener_() if isinstance(listener_, weakref.ref) else listener_
+            if listener is not None:
+                result = listener(state)
+                if asyncio.iscoroutine(result) and self.store_options.task_creator:
+                    self.store_options.task_creator(result)
 
     def _run_actions(self: Store[State, Action, Event]) -> None:
         while len(self._actions) > 0:
@@ -248,7 +241,8 @@ def _subscribe(
         """Subscribe to state changes."""
 
         def unsubscribe(_: weakref.ref | None = None) -> None:
-            return self._listeners.remove(listener_ref)
+            with contextlib.suppress(KeyError):
+                self._listeners.remove(listener_ref)
 
         if keep_ref:
             listener_ref = listener
@@ -269,18 +263,19 @@ def subscribe_event(
         keep_ref: bool = True,
     ) -> SubscribeEventCleanup:
         """Subscribe to events."""
+
+        def unsubscribe(_: weakref.ref | None = None) -> None:
+            self._event_handlers[cast('Event', event_type)].discard(handler_ref)
+
         if keep_ref:
             handler_ref = handler
         elif inspect.ismethod(handler):
-            handler_ref = weakref.WeakMethod(handler)
+            handler_ref = weakref.WeakMethod(handler, unsubscribe)
         else:
-            handler_ref = weakref.ref(handler)
+            handler_ref = weakref.ref(handler, unsubscribe)
 
         self._event_handlers[cast('Event', event_type)].add(handler_ref)
 
-        def unsubscribe() -> None:
-            self._event_handlers[cast('Event', event_type)].discard(handler_ref)
-
         return SubscribeEventCleanup(unsubscribe=unsubscribe, handler=handler)
 
     def _wait_for_store_to_finish(self: Store[State, Action, Event]) -> None:
@@ -438,7 +433,7 @@ def wrapper(*args: Args.args, **kwargs: Args.kwargs) -> ReturnType:
 
             signature = signature_without_selector(func)
             wrapped = wraps(cast('Any', func))(wrapper)
-            wrapped.__signature__ = signature  # pyright: ignore [reportAttributeAccessIssue]
+            wrapped.__signature__ = signature  # type: ignore [reportAttributeAccessIssue]
 
             return wrapped
 

redux/side_effect_runner.py

@@ -5,7 +5,6 @@
 import contextlib
 import inspect
 import threading
-import weakref
 from asyncio import Handle, iscoroutine
 from typing import TYPE_CHECKING, Any, Generic, cast
 
@@ -41,13 +40,7 @@ def run(self: SideEffectRunner[Event]) -> None:
             try:
                 if task is None:
                     break
-                event_handler_, event = task
-                if isinstance(event_handler_, weakref.ref):
-                    event_handler = event_handler_()
-                    if event_handler is None:
-                        continue
-                else:
-                    event_handler = event_handler_
+                event_handler, event = task
                 parameters = 1
                 with contextlib.suppress(Exception):
                     parameters = len(

redux_pytest/fixtures/snapshot.py

@@ -17,7 +17,7 @@
 if TYPE_CHECKING:
     from collections.abc import Callable
 
-    from _pytest.fixtures import SubRequest  # pyright: ignore[reportPrivateImportUsage]
+    from _pytest.fixtures import SubRequest  # type: ignore[reportPrivateImportUsage]
 
     from redux.main import Store
 
@@ -102,8 +102,6 @@ def take(
             )
             raise RuntimeError(msg)
 
-        from pathlib import Path
-
         filename = self.get_filename(title)
         path = Path(self.results_dir / filename)
         json_path = path.with_suffix('.jsonc')

tests/test_features.py

@@ -124,8 +124,8 @@ def inverse_reducer(
 def reducer() -> Reducer:
     return combine_reducers(
         state_type=StateType,
-        action_type=ActionType,  # pyright: ignore [reportArgumentType]
-        event_type=SleepEvent | PrintEvent,  # pyright: ignore [reportArgumentType]
+        action_type=ActionType,  # type: ignore [reportArgumentType]
+        event_type=SleepEvent | PrintEvent,  # type: ignore [reportArgumentType]
         straight=straight_reducer,
         base10=base10_reducer,
     )

tests/test_weakref.py

@@ -65,7 +65,7 @@ def method_with_keep_ref(self: AutorunClass, value: int) -> int:
         self.store_snapshot.take(title='autorun_method_with_keep_ref')
         return value
 
-    def method_without_keep_ref(self: AutorunClass, _: int) -> int:
+    def method_without_keep_ref(self: AutorunClass, _: int) -> None:
         pytest.fail('This should never be called')
 
 
@@ -128,7 +128,7 @@ def render_with_keep_ref(value: int) -> int:
         lambda state: state.value,
         options=AutorunOptions(keep_ref=False, initial_call=False),
     )
-    def render_without_keep_ref(_: int) -> int:
+    def render_without_keep_ref(_: int) -> None:
         pytest.fail('This should never be called')
 
     ref = weakref.ref(render_with_keep_ref)