refactor: move the common code for manipulating the signature of the wrapped functions in WithStore and Autorun to a utility function

Author: sassanh

CHANGELOG.md

@@ -3,6 +3,7 @@
 ## Upcoming
 
 - chore: add badges in `README.md` and classifiers in `pyproject.toml`
+- refactor: move the common code for manipulating the signature of the wrapped functions in `WithStore` and `Autorun` to a utility function
 
 ## Version 0.23.0
 

redux/autorun.py

@@ -27,6 +27,7 @@
     State,
     T,
 )
+from redux.utils import drop_with_store_parameter
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Coroutine, Generator
@@ -83,7 +84,7 @@ class Autorun(
 ):
     """Run a wrapped function in response to specific state changes in the store."""
 
-    def __init__(  # noqa: C901, PLR0912, PLR0915
+    def __init__(  # noqa: C901, PLR0912
         self: Autorun,
         *,
         store: Store[State, Action, Event],
@@ -104,14 +105,7 @@ def __init__(  # noqa: C901, PLR0912, PLR0915
             self.__qualname__ = f'Autorun:{func.__qualname__}'
         else:
             self.__qualname__ = f'Autorun:{func}'
-        signature = inspect.signature(func)
-        parameters = list(signature.parameters.values())
-        if parameters and parameters[0].kind in [
-            inspect.Parameter.POSITIONAL_ONLY,
-            inspect.Parameter.POSITIONAL_OR_KEYWORD,
-        ]:
-            parameters = parameters[1:]
-        self.__signature__ = signature.replace(parameters=parameters)
+        self.__signature__ = drop_with_store_parameter(func)
         self.__module__ = func.__module__
         if (annotations := getattr(func, '__annotations__', None)) is not None:
             self.__annotations__ = annotations

redux/main.py

@@ -55,6 +55,7 @@
     is_state_reducer_result,
 )
 from redux.serialization_mixin import SerializationMixin
+from redux.utils import drop_with_store_parameter
 
 if TYPE_CHECKING:
     from collections.abc import Callable
@@ -395,18 +396,8 @@ def wrapper(*args: Args.args, **kwargs: Args.kwargs) -> ReturnType:
                     raise RuntimeError(msg)
                 return func(selector(self._state), *args, **kwargs)
 
-            signature = inspect.signature(func)
-            parameters = list(signature.parameters.values())
-            if parameters and parameters[0].kind in [
-                inspect.Parameter.POSITIONAL_ONLY,
-                inspect.Parameter.POSITIONAL_OR_KEYWORD,
-            ]:
-                parameters = parameters[1:]
-
             wrapped = wraps(func)(wrapper)
-            wrapped.__signature__ = signature.replace(  # pyright: ignore [reportAttributeAccessIssue]
-                parameters=parameters,
-            )
+            wrapped.__signature__ = drop_with_store_parameter(func)  # pyright: ignore [reportAttributeAccessIssue]
 
             return wrapped
 

redux/utils.py

@@ -0,0 +1,26 @@
+"""Utility functions for the project."""
+
+from __future__ import annotations
+
+import inspect
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+
+def drop_with_store_parameter(func: Callable) -> inspect.Signature:
+    """Drop the parameter associated consumed by the with_store/autorun/view wrapper."""
+    signature = inspect.signature(func)
+    parameters = list(signature.parameters.values())
+    self_parameter: list[inspect.Parameter] = []
+    is_method = parameters and parameters[0].name == 'self'
+    if is_method:
+        self_parameter = [parameters[0]]
+        parameters = parameters[1:]
+    if parameters and parameters[0].kind in [
+        inspect.Parameter.POSITIONAL_ONLY,
+        inspect.Parameter.POSITIONAL_OR_KEYWORD,
+    ]:
+        parameters = parameters[1:]
+    return signature.replace(parameters=self_parameter + parameters)

tests/test_autorun.py

@@ -23,8 +23,6 @@
 from redux.main import Store
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
-
     from pytest_mock import MockerFixture
 
     from redux_pytest.fixtures import StoreSnapshot
@@ -73,10 +71,12 @@ def reducer(
 
 
 @pytest.fixture
-def store() -> Generator[StoreType, None, None]:
+def store() -> StoreType:
     store: StoreType = Store(reducer, options=StoreOptions(auto_init=True))
-    yield store
+    return store
+
 
+def dispatch_actions(store: StoreType) -> None:
     store.dispatch(IncrementAction())
     store.dispatch(IncrementByTwoAction())
     store.dispatch(IncrementAction())
@@ -89,6 +89,8 @@ def _(value: int) -> int:
         store_snapshot.take()
         return value
 
+    dispatch_actions(store)
+
 
 def test_name_attr(store: StoreType) -> None:
     """Test `autorun` decorator name attribute."""
@@ -117,6 +119,8 @@ def __repr__(self) -> str:
 
     assert decorated_instance.__name__ == 'Autorun:Decorated'
 
+    dispatch_actions(store)
+
 
 def test_signature(store: StoreType) -> None:
     """Test `with_state` decorator `__signature__` attribute."""
@@ -178,12 +182,16 @@ def func(
 
     assert signature.return_annotation == 'int'
 
+    dispatch_actions(store)
+
 
 def test_ignore_attribute_error_in_selector(store: StoreType) -> None:
     @store.autorun(lambda state: cast('Any', state).non_existing)
     def _(_: int) -> None:
         pytest.fail('This should never be called')
 
+    dispatch_actions(store)
+
 
 def test_ignore_attribute_error_in_comparator(store: StoreType) -> None:
     @store.autorun(
@@ -193,6 +201,8 @@ def test_ignore_attribute_error_in_comparator(store: StoreType) -> None:
     def _(_: int) -> None:
         pytest.fail('This should never be called')
 
+    dispatch_actions(store)
+
 
 def test_with_comparator(
     store_snapshot: StoreSnapshot,
@@ -206,6 +216,8 @@ def _(value: int) -> int:
         store_snapshot.take()
         return value
 
+    dispatch_actions(store)
+
 
 def test_value_property(store_snapshot: StoreSnapshot, store: StoreType) -> None:
     @store.autorun(lambda state: state.value)
@@ -221,6 +233,8 @@ def check(_: int) -> None:
 
     render.subscribe(check)
 
+    dispatch_actions(store)
+
 
 def test_callability(store_snapshot: StoreSnapshot, store: StoreType) -> None:
     @store.autorun(lambda state: state.value)
@@ -233,6 +247,8 @@ def check(state: StateType) -> None:
 
     store._subscribe(check)  # noqa: SLF001
 
+    dispatch_actions(store)
+
 
 def test_subscription(store_snapshot: StoreSnapshot, store: StoreType) -> None:
     @store.autorun(lambda state: state.value)
@@ -244,6 +260,8 @@ def reaction(_: int) -> None:
 
     render.subscribe(reaction, initial_run=True)
 
+    dispatch_actions(store)
+
 
 def test_unsubscription(store: StoreType) -> None:
     @store.autorun(lambda state: state.value)
@@ -256,6 +274,8 @@ def reaction(_: int) -> None:
     unsubscribe = render.subscribe(reaction, initial_run=False)
     unsubscribe()
 
+    dispatch_actions(store)
+
 
 def test_repr(store: StoreType) -> None:
     @store.autorun(lambda state: state.value)
@@ -274,6 +294,8 @@ def render(value: int) -> int:
         repr(render),
     )
 
+    store.dispatch(FinishAction())
+
 
 call_sequence = [
     # 0
@@ -317,6 +339,8 @@ def render(_: int) -> None: ...
 
     assert render.mock_calls == [call(0), call(1), call(3), call(1)]
 
+    store.dispatch(FinishAction())
+
 
 def test_no_auto_call_and_no_initial_call_with_reactive_set(
     store: StoreType,
@@ -338,6 +362,8 @@ def render(_: int) -> None: ...
 
     assert render.mock_calls == [call(1), call(3), call(1)]
 
+    store.dispatch(FinishAction())
+
 
 def test_with_auto_call_and_initial_call_and_reactive_set(
     store: StoreType,
@@ -369,6 +395,8 @@ def render(_: int) -> None: ...
         call(1),
     ]
 
+    store.dispatch(FinishAction())
+
 
 def test_task_mode_without_arguments(
     store: StoreType,
@@ -392,6 +420,8 @@ def check() -> None:
 
     store.subscribe_event(FinishEvent, check)
 
+    dispatch_actions(store)
+
 
 def test_view_mode_with_arguments_autorun(
     store: StoreType,
@@ -409,3 +439,20 @@ def render(_: int, *, some_other_value: int) -> int:
         return some_other_value
 
     assert render(some_other_value=12345) == 12345
+
+    store.dispatch(FinishAction())
+
+
+def test_methods(store: StoreType) -> None:
+    calls = []
+
+    class SomeClass:
+        def render(self, value: int) -> None:
+            calls.append(value)
+
+    instance = SomeClass()
+    store.autorun(lambda state: state.value)(instance.render)
+
+    dispatch_actions(store)
+
+    assert calls == [0, 1, 3, 4]