fix: add __qualname__ to WithStore instances so that they play nice when passed as a function to something assuming they are normal functions and have a __qualname__ attribute

Author: sassanh

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## Upcoming
+
+- fix: add `__qualname__`, `__annotations__`, `__module__`, `__defaults__` and `__kwdefaults__` to `Autorun` and `WithStore` instances so that they play nice when passed as a function to something assuming they are normal function having these properties.
+
 ## Version 0.22.1
 
 - fix: add `__name__` to `WithStore` instances so that they play nice when passed as a function to something assuming they are functions and have a `__name__` attribute

redux/autorun.py

@@ -71,7 +71,7 @@ class Autorun(
 ):
     """Run a wrapped function in response to specific state changes in the store."""
 
-    def __init__(
+    def __init__(  # noqa: C901, PLR0912
         self: Autorun,
         *,
         store: Store[State, Action, Event],
@@ -88,18 +88,31 @@ def __init__(
             self.__name__ = f'Autorun:{func.__name__}'
         else:
             self.__name__ = f'Autorun:{func}'
-        self._store = store
-        self._selector = selector
-        self._comparator = comparator
-        self._should_be_called = False
+        if hasattr(func, '__qualname__'):
+            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__ = signature.replace(parameters=parameters)
+        self.__module__ = func.__module__
+        if (annotations := getattr(func, '__annotations__', None)) is not None:
+            self.__annotations__ = annotations
+        if (defaults := getattr(func, '__defaults__', None)) is not None:
+            self.__defaults__ = defaults
+        if (kwdefaults := getattr(func, '__kwdefaults__', None)) is not None:
+            self.__kwdefaults__ = kwdefaults
+
+        self._store = store
+        self._selector = selector
+        self._comparator = comparator
+        self._should_be_called = False
+
         if options.keep_ref:
             self._func = func
         elif inspect.ismethod(func):
@@ -370,18 +383,3 @@ def unsubscribe() -> None:
             self._subscriptions.discard(callback_ref)
 
         return unsubscribe
-
-    @property
-    def __signature__(
-        self: Autorun[
-            State,
-            Action,
-            Event,
-            SelectorOutput,
-            ComparatorOutput,
-            Args,
-            ReturnType,
-        ],
-    ) -> inspect.Signature:
-        """Get the signature of the wrapped function."""
-        return self._signature

redux/with_state.py

@@ -31,17 +31,29 @@ def __init__(
             self.__name__ = f'WithState:{func.__name__}'
         else:
             self.__name__ = f'WithState:{func}'
-        self._store = store
-        self._selector = selector
-        self._func = func
+        if hasattr(func, '__qualname__'):
+            self.__qualname__ = f'WithState:{func.__qualname__}'
+        else:
+            self.__qualname__ = f'WithState:{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__ = signature.replace(parameters=parameters)
+        self.__module__ = func.__module__
+        if (annotations := getattr(func, '__annotations__', None)) is not None:
+            self.__annotations__ = annotations
+        if (defaults := getattr(func, '__defaults__', None)) is not None:
+            self.__defaults__ = defaults
+        if (kwdefaults := getattr(func, '__kwdefaults__', None)) is not None:
+            self.__kwdefaults__ = kwdefaults
+
+        self._store = store
+        self._selector = selector
+        self._func = func
 
     def __call__(
         self: WithState[
@@ -73,17 +85,3 @@ def __repr__(
     ) -> str:
         """Return the string representation of the WithState instance."""
         return super().__repr__() + f'(func: {self._func})'
-
-    @property
-    def __signature__(
-        self: WithState[
-            State,
-            Action,
-            Event,
-            SelectorOutput,
-            ReturnType,
-            Args,
-        ],
-    ) -> inspect.Signature:
-        """Get the signature of the wrapped function."""
-        return self._signature

tests/test_autorun.py

@@ -1,6 +1,7 @@
 # ruff: noqa: D100, D101, D102, D103, D104, D107
 from __future__ import annotations
 
+import inspect
 import re
 from dataclasses import replace
 from typing import TYPE_CHECKING, Any, cast
@@ -89,14 +90,15 @@ def _(value: int) -> int:
         return value
 
 
-def test_name(store: StoreType) -> None:
+def test_name_attr(store: StoreType) -> None:
     """Test `autorun` decorator name attribute."""
 
     @store.autorun(lambda state: state.value)
     def decorated(value: int) -> int:
         return value
 
     assert decorated.__name__ == 'Autorun:decorated'
+    assert decorated.__qualname__ == 'Autorun:test_name_attr.<locals>.decorated'
 
     inline_decorated = store.autorun(lambda state: state.value)(
         lambda value: value,
@@ -116,6 +118,67 @@ def __repr__(self) -> str:
     assert decorated_instance.__name__ == 'Autorun:Decorated'
 
 
+def test_signature(store: StoreType) -> None:
+    """Test `with_state` decorator `__signature__` attribute."""
+
+    @store.autorun(
+        lambda state: state.value,
+        options=AutorunOptions(
+            initial_call=False,
+            reactive=False,
+        ),
+    )
+    def func(
+        value: int,
+        some_positional_parameter: str,
+        some_positional_parameter_with_default: int = 0,
+        *,
+        some_keyword_parameter: bool,
+        some_keyword_parameter_with_default: int = 1,
+    ) -> int:
+        _ = (
+            some_positional_parameter,
+            some_positional_parameter_with_default,
+            some_keyword_parameter,
+            some_keyword_parameter_with_default,
+        )
+        return value
+
+    signature = inspect.signature(func)
+    assert len(signature.parameters) == 4
+
+    assert 'some_positional_parameter' in signature.parameters
+    assert (
+        signature.parameters['some_positional_parameter'].default
+        is inspect.Parameter.empty
+    )
+    assert signature.parameters['some_positional_parameter'].annotation == 'str'
+
+    assert 'some_positional_parameter_with_default' in signature.parameters
+    assert signature.parameters['some_positional_parameter_with_default'].default == 0
+    assert (
+        signature.parameters['some_positional_parameter_with_default'].annotation
+        == 'int'
+    )
+
+    assert 'some_keyword_parameter' in signature.parameters
+    assert (
+        signature.parameters['some_keyword_parameter'].default
+        is inspect.Parameter.empty
+    )
+    assert signature.parameters['some_keyword_parameter'].annotation == 'bool'
+
+    assert 'some_keyword_parameter_with_default' in signature.parameters
+    assert signature.parameters['some_keyword_parameter_with_default'].default == 1
+    assert (
+        signature.parameters['some_keyword_parameter_with_default'].annotation == 'int'
+    )
+
+    assert 'value' not in signature.parameters
+
+    assert signature.return_annotation == 'int'
+
+
 def test_ignore_attribute_error_in_selector(store: StoreType) -> None:
     @store.autorun(lambda state: cast('Any', state).non_existing)
     def _(_: int) -> None:

tests/test_with_state.py

@@ -64,6 +64,7 @@ def decorated(value: int) -> int:
         return value
 
     assert decorated.__name__ == 'WithState:decorated'
+    assert decorated.__qualname__ == 'WithState:test_name_attr.<locals>.decorated'
 
     inline_decorated = store.with_state(lambda state: state.value)(
         lambda value: value,