python-redux 0.19.1__tar.gz → 0.19.2.dev2250307103575157485__tar.gz

{python_redux-0.19.1 → python_redux-0.19.2.dev2250307103575157485}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-redux
-Version: 0.19.1
+Version: 0.19.2.dev2250307103575157485
 Summary: Redux implementation for Python
 Project-URL: homepage, https://github.com/sassanh/python-redux/
 Project-URL: repository, https://github.com/sassanh/python-redux/

{python_redux-0.19.1 → python_redux-0.19.2.dev2250307103575157485}/redux/_version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '0.19.1'
-__version_tuple__ = version_tuple = (0, 19, 1)
+__version__ = version = '0.19.2.dev2250307103575157485'
+__version_tuple__ = version_tuple = (0, 19, 2, 'dev2250307103575157485')

{python_redux-0.19.1 → python_redux-0.19.2.dev2250307103575157485}/redux/autorun.py

@@ -17,11 +17,11 @@ from typing import (
 
 from redux.basic_types import (
     Action,
-    AutorunArgs,
+    Args,
     AutorunOptions,
-    AutorunOriginalReturnType,
     ComparatorOutput,
     Event,
+    ReturnType,
     SelectorOutput,
     State,
 )
@@ -58,8 +58,8 @@ class Autorun(
         Event,
         SelectorOutput,
         ComparatorOutput,
-        AutorunOriginalReturnType,
-        AutorunArgs,
+        ReturnType,
+        Args,
     ],
 ):
     def __init__(
@@ -69,10 +69,10 @@ class Autorun(
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], Any] | None,
         func: Callable[
-            Concatenate[SelectorOutput, AutorunArgs],
-            AutorunOriginalReturnType,
+            Concatenate[SelectorOutput, Args],
+            ReturnType,
         ],
-        options: AutorunOptions[AutorunOriginalReturnType],
+        options: AutorunOptions[ReturnType],
     ) -> None:
         self.__name__ = func.__name__
         self._store = store
@@ -109,10 +109,9 @@ class Autorun(
             self._latest_value = Future()
             self._latest_value.set_result(options.default_value)
         else:
-            self._latest_value: AutorunOriginalReturnType = options.default_value
+            self._latest_value: ReturnType = options.default_value
         self._subscriptions: set[
-            Callable[[AutorunOriginalReturnType], Any]
-            | weakref.ref[Callable[[AutorunOriginalReturnType], Any]]
+            Callable[[ReturnType], Any] | weakref.ref[Callable[[ReturnType], Any]]
         ] = set()
 
         if self._check(store._state) and self._options.initial_call:  # noqa: SLF001
@@ -137,8 +136,8 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
     ) -> None:
         for subscriber_ in self._subscriptions.copy():
@@ -158,8 +157,8 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
         task: Task,
         *,
@@ -179,8 +178,8 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
         state: State | None,
     ) -> bool:
@@ -211,16 +210,16 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
-        *args: AutorunArgs.args,
-        **kwargs: AutorunArgs.kwargs,
+        *args: Args.args,
+        **kwargs: Args.kwargs,
     ) -> None:
         self._should_be_called = False
         func = self._func() if isinstance(self._func, weakref.ref) else self._func
         if func and self._last_selector_result is not None:
-            value: AutorunOriginalReturnType = func(
+            value: ReturnType = func(
                 self._last_selector_result,
                 *args,
                 **kwargs,
@@ -229,7 +228,7 @@ class Autorun(
             if iscoroutine(value) and create_task:
                 if self._options.auto_await:
                     future = Future()
-                    self._latest_value = cast(AutorunOriginalReturnType, future)
+                    self._latest_value = cast(ReturnType, future)
                     create_task(
                         value,
                         callback=functools.partial(
@@ -245,7 +244,7 @@ class Autorun(
                     ):
                         self._latest_value.close()
                     self._latest_value = cast(
-                        AutorunOriginalReturnType,
+                        ReturnType,
                         AwaitableWrapper(value),
                     )
             else:
@@ -259,16 +258,17 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
-        *args: AutorunArgs.args,
-        **kwargs: AutorunArgs.kwargs,
-    ) -> AutorunOriginalReturnType:
+        *args: Args.args,
+        **kwargs: Args.kwargs,
+    ) -> ReturnType:
         state = self._store._state  # noqa: SLF001
-        if self._check(state) or self._should_be_called or args or kwargs:
+        self._check(state)
+        if self._should_be_called or args or kwargs or not self._options.memoization:
             self._call(*args, **kwargs)
-        return cast(AutorunOriginalReturnType, self._latest_value)
+        return cast(ReturnType, self._latest_value)
 
     def __repr__(
         self: Autorun[
@@ -277,8 +277,8 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
     ) -> str:
         return (
@@ -294,11 +294,11 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
-    ) -> AutorunOriginalReturnType:
-        return cast(AutorunOriginalReturnType, self._latest_value)
+    ) -> ReturnType:
+        return cast(ReturnType, self._latest_value)
 
     def subscribe(
         self: Autorun[
@@ -307,10 +307,10 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
-        callback: Callable[[AutorunOriginalReturnType], Any],
+        callback: Callable[[ReturnType], Any],
         *,
         initial_run: bool | None = None,
         keep_ref: bool | None = None,
@@ -343,8 +343,8 @@ class Autorun(
             Event,
             SelectorOutput,
             ComparatorOutput,
-            AutorunOriginalReturnType,
-            AutorunArgs,
+            ReturnType,
+            Args,
         ],
     ) -> inspect.Signature:
         return self._signature

{python_redux-0.19.1 → python_redux-0.19.2.dev2250307103575157485}/redux/basic_types.py

@@ -42,12 +42,10 @@ Event = TypeVar('Event', bound=BaseEvent | None, infer_variance=True)
 Event2 = TypeVar('Event2', bound=BaseEvent, infer_variance=True)
 SelectorOutput = TypeVar('SelectorOutput', infer_variance=True)
 ComparatorOutput = TypeVar('ComparatorOutput', infer_variance=True)
-AutorunOriginalReturnType = TypeVar('AutorunOriginalReturnType', infer_variance=True)
-ViewOriginalReturnType = TypeVar('ViewOriginalReturnType', infer_variance=True)
+ReturnType = TypeVar('ReturnType', infer_variance=True)
 Comparator = Callable[[State], ComparatorOutput]
 EventHandler = Callable[[Event], Any] | Callable[[], Any]
-AutorunArgs = ParamSpec('AutorunArgs')
-ViewArgs = ParamSpec('ViewArgs')
+Args = ParamSpec('Args')
 Payload = TypeVar('Payload', bound=Any, default=None)
 
 
@@ -129,36 +127,37 @@ class CreateStoreOptions(Immutable, Generic[Action, Event]):
 # Autorun
 
 
-class AutorunOptions(Immutable, Generic[AutorunOriginalReturnType]):
-    default_value: AutorunOriginalReturnType | None = None
+class AutorunOptions(Immutable, Generic[ReturnType]):
+    default_value: ReturnType | None = None
     auto_await: bool = True
     initial_call: bool = True
     reactive: bool = True
+    memoization: bool = True
     keep_ref: bool = True
     subscribers_initial_run: bool = True
     subscribers_keep_ref: bool = True
 
 
-AutorunOptionsWithDefault = AutorunOptions[AutorunOriginalReturnType]
+AutorunOptionsWithDefault = AutorunOptions[ReturnType]
 AutorunOptionsWithoutDefault = AutorunOptions[Never]
 
 
 class AutorunReturnType(
     Protocol,
-    Generic[AutorunOriginalReturnType, AutorunArgs],
+    Generic[ReturnType, Args],
 ):
     def __call__(
         self: AutorunReturnType,
-        *args: AutorunArgs.args,
-        **kwargs: AutorunArgs.kwargs,
-    ) -> AutorunOriginalReturnType: ...
+        *args: Args.args,
+        **kwargs: Args.kwargs,
+    ) -> ReturnType: ...
 
     @property
-    def value(self: AutorunReturnType) -> AutorunOriginalReturnType: ...
+    def value(self: AutorunReturnType) -> ReturnType: ...
 
     def subscribe(
         self: AutorunReturnType,
-        callback: Callable[[AutorunOriginalReturnType], Any],
+        callback: Callable[[ReturnType], Any],
         *,
         initial_run: bool | None = None,
         keep_ref: bool | None = None,
@@ -171,67 +170,68 @@ class AutorunReturnType(
 
 class AutorunDecorator(
     Protocol,
-    Generic[SelectorOutput, AutorunOriginalReturnType],
+    Generic[SelectorOutput, ReturnType],
 ):
     @overload
     def __call__(
         self: AutorunDecorator,
         func: Callable[
-            Concatenate[SelectorOutput, AutorunArgs],
-            AutorunOriginalReturnType,
+            Concatenate[SelectorOutput, Args],
+            ReturnType,
         ],
-    ) -> AutorunReturnType[AutorunOriginalReturnType, AutorunArgs]: ...
+    ) -> AutorunReturnType[ReturnType, Args]: ...
 
     @overload
     def __call__(
         self: AutorunDecorator,
         func: Callable[
-            Concatenate[SelectorOutput, AutorunArgs],
-            Awaitable[AutorunOriginalReturnType],
+            Concatenate[SelectorOutput, Args],
+            Awaitable[ReturnType],
         ],
-    ) -> AutorunReturnType[Awaitable[AutorunOriginalReturnType], AutorunArgs]: ...
+    ) -> AutorunReturnType[Awaitable[ReturnType], Args]: ...
 
 
 class UnknownAutorunDecorator(Protocol, Generic[SelectorOutput]):
     def __call__(
         self: UnknownAutorunDecorator,
         func: Callable[
-            Concatenate[SelectorOutput, AutorunArgs],
-            AutorunOriginalReturnType,
+            Concatenate[SelectorOutput, Args],
+            ReturnType,
         ],
-    ) -> AutorunReturnType[AutorunOriginalReturnType, AutorunArgs]: ...
+    ) -> AutorunReturnType[ReturnType, Args]: ...
 
 
 # View
 
 
-class ViewOptions(Immutable, Generic[ViewOriginalReturnType]):
-    default_value: ViewOriginalReturnType | None = None
+class ViewOptions(Immutable, Generic[ReturnType]):
+    default_value: ReturnType | None = None
+    memoization: bool = True
     keep_ref: bool = True
     subscribers_initial_run: bool = True
     subscribers_keep_ref: bool = True
 
 
-ViewOptionsWithDefault = ViewOptions[ViewOriginalReturnType]
+ViewOptionsWithDefault = ViewOptions[ReturnType]
 ViewOptionsWithoutDefault = ViewOptions[Never]
 
 
 class ViewReturnType(
     Protocol,
-    Generic[ViewOriginalReturnType, ViewArgs],
+    Generic[ReturnType, Args],
 ):
     def __call__(
         self: ViewReturnType,
-        *args: ViewArgs.args,
-        **kwargs: ViewArgs.kwargs,
-    ) -> ViewOriginalReturnType: ...
+        *args: Args.args,
+        **kwargs: Args.kwargs,
+    ) -> ReturnType: ...
 
     @property
-    def value(self: ViewReturnType) -> ViewOriginalReturnType: ...
+    def value(self: ViewReturnType) -> ReturnType: ...
 
     def subscribe(
         self: ViewReturnType,
-        callback: Callable[[ViewOriginalReturnType], Any],
+        callback: Callable[[ReturnType], Any],
         *,
         initial_run: bool | None = None,
         keep_ref: bool | None = None,
@@ -242,35 +242,48 @@ class ViewReturnType(
 
 class ViewDecorator(
     Protocol,
-    Generic[SelectorOutput, ViewOriginalReturnType],
+    Generic[SelectorOutput, ReturnType],
 ):
     @overload
     def __call__(
         self: ViewDecorator,
         func: Callable[
-            Concatenate[SelectorOutput, ViewArgs],
-            ViewOriginalReturnType,
+            Concatenate[SelectorOutput, Args],
+            ReturnType,
         ],
-    ) -> ViewReturnType[ViewOriginalReturnType, ViewArgs]: ...
+    ) -> ViewReturnType[ReturnType, Args]: ...
 
     @overload
     def __call__(
         self: ViewDecorator,
         func: Callable[
-            Concatenate[SelectorOutput, ViewArgs],
-            Awaitable[ViewOriginalReturnType],
+            Concatenate[SelectorOutput, Args],
+            Awaitable[ReturnType],
         ],
-    ) -> ViewReturnType[Awaitable[ViewOriginalReturnType], ViewArgs]: ...
+    ) -> ViewReturnType[Awaitable[ReturnType], Args]: ...
 
 
 class UnknownViewDecorator(Protocol, Generic[SelectorOutput]):
     def __call__(
         self: UnknownViewDecorator,
         func: Callable[
-            Concatenate[SelectorOutput, ViewArgs],
-            ViewOriginalReturnType,
+            Concatenate[SelectorOutput, Args],
+            ReturnType,
         ],
-    ) -> ViewReturnType[ViewOriginalReturnType, ViewArgs]: ...
+    ) -> ViewReturnType[ReturnType, Args]: ...
+
+
+# With Store
+
+
+class WithStateDecorator(
+    Protocol,
+    Generic[SelectorOutput],
+):
+    def __call__(
+        self: WithStateDecorator,
+        func: Callable[Concatenate[SelectorOutput, Args], ReturnType],
+    ) -> Callable[Args, ReturnType]: ...
 
 
 class EventSubscriber(Protocol):

{python_redux-0.19.1 → python_redux-0.19.2.dev2250307103575157485}/redux/main.py

@@ -7,9 +7,10 @@ import inspect
 import queue
 import weakref
 from collections import defaultdict
-from collections.abc import Awaitable, Callable
+from collections.abc import Callable
 from threading import Lock, Thread
 from typing import (
+    TYPE_CHECKING,
     Any,
     Concatenate,
     Generic,
@@ -21,12 +22,11 @@ from redux.autorun import Autorun
 from redux.basic_types import (
     Action,
     ActionMiddleware,
-    AutorunArgs,
+    Args,
     AutorunDecorator,
     AutorunOptions,
     AutorunOptionsWithDefault,
     AutorunOptionsWithoutDefault,
-    AutorunOriginalReturnType,
     AutorunReturnType,
     AwaitableOrNot,
     BaseAction,
@@ -42,24 +42,27 @@ from redux.basic_types import (
     FinishEvent,
     InitAction,
     ReducerType,
+    ReturnType,
     SelectorOutput,
     SnapshotAtom,
     State,
     UnknownAutorunDecorator,
     UnknownViewDecorator,
-    ViewArgs,
     ViewDecorator,
     ViewOptions,
     ViewOptionsWithDefault,
     ViewOptionsWithoutDefault,
-    ViewOriginalReturnType,
     ViewReturnType,
+    WithStateDecorator,
     is_complete_reducer_result,
     is_state_reducer_result,
 )
 from redux.serialization_mixin import SerializationMixin
 from redux.side_effect_runner import SideEffectRunnerThread
 
+if TYPE_CHECKING:
+    from collections.abc import Awaitable
+
 
 class Store(Generic[State, Action, Event], SerializationMixin):
     """Redux store for managing state and side effects."""
@@ -307,16 +310,16 @@ class Store(Generic[State, Action, Event], SerializationMixin):
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], ComparatorOutput] | None = None,
         *,
-        options: AutorunOptionsWithDefault[AutorunOriginalReturnType],
-    ) -> AutorunDecorator[SelectorOutput, AutorunOriginalReturnType]: ...
+        options: AutorunOptionsWithDefault[ReturnType],
+    ) -> AutorunDecorator[SelectorOutput, ReturnType]: ...
     def autorun(
         self: Store[State, Action, Event],
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], ComparatorOutput] | None = None,
         *,
-        options: AutorunOptions[AutorunOriginalReturnType] | None = None,
+        options: AutorunOptions[ReturnType] | None = None,
     ) -> (
-        AutorunDecorator[SelectorOutput, AutorunOriginalReturnType]
+        AutorunDecorator[SelectorOutput, ReturnType]
         | UnknownAutorunDecorator[SelectorOutput]
     ):
         """Create a new autorun, reflecting on state changes."""
@@ -324,23 +327,23 @@ class Store(Generic[State, Action, Event], SerializationMixin):
         @overload
         def decorator(
             func: Callable[
-                Concatenate[SelectorOutput, AutorunArgs],
-                AutorunOriginalReturnType,
+                Concatenate[SelectorOutput, Args],
+                ReturnType,
             ],
-        ) -> AutorunReturnType[AutorunOriginalReturnType, AutorunArgs]: ...
+        ) -> AutorunReturnType[ReturnType, Args]: ...
         @overload
         def decorator(
             func: Callable[
-                Concatenate[SelectorOutput, AutorunArgs],
-                Awaitable[AutorunOriginalReturnType],
+                Concatenate[SelectorOutput, Args],
+                Awaitable[ReturnType],
             ],
-        ) -> AutorunReturnType[Awaitable[AutorunOriginalReturnType], AutorunArgs]: ...
+        ) -> AutorunReturnType[Awaitable[ReturnType], Args]: ...
         def decorator(
             func: Callable[
-                Concatenate[SelectorOutput, AutorunArgs],
-                AwaitableOrNot[AutorunOriginalReturnType],
+                Concatenate[SelectorOutput, Args],
+                AwaitableOrNot[ReturnType],
             ],
-        ) -> AutorunReturnType[AwaitableOrNot[AutorunOriginalReturnType], AutorunArgs]:
+        ) -> AutorunReturnType[AwaitableOrNot[ReturnType], Args]:
             return Autorun(
                 store=self,
                 selector=selector,
@@ -363,40 +366,39 @@ class Store(Generic[State, Action, Event], SerializationMixin):
         self: Store[State, Action, Event],
         selector: Callable[[State], SelectorOutput],
         *,
-        options: ViewOptionsWithDefault[ViewOriginalReturnType],
-    ) -> ViewDecorator[SelectorOutput, ViewOriginalReturnType]: ...
+        options: ViewOptionsWithDefault[ReturnType],
+    ) -> ViewDecorator[SelectorOutput, ReturnType]: ...
     def view(
         self: Store[State, Action, Event],
         selector: Callable[[State], SelectorOutput],
         *,
-        options: ViewOptions[ViewOriginalReturnType] | None = None,
+        options: ViewOptions[ReturnType] | None = None,
     ) -> (
-        ViewDecorator[SelectorOutput, ViewOriginalReturnType]
-        | UnknownViewDecorator[SelectorOutput]
+        ViewDecorator[SelectorOutput, ReturnType] | UnknownViewDecorator[SelectorOutput]
     ):
         """Create a new view, throttling calls for unchanged selector results."""
 
         @overload
         def decorator(
             func: Callable[
-                Concatenate[SelectorOutput, ViewArgs],
-                ViewOriginalReturnType,
+                Concatenate[SelectorOutput, Args],
+                ReturnType,
             ],
-        ) -> ViewReturnType[ViewOriginalReturnType, ViewArgs]: ...
+        ) -> ViewReturnType[ReturnType, Args]: ...
         @overload
         def decorator(
             func: Callable[
-                Concatenate[SelectorOutput, ViewArgs],
-                Awaitable[ViewOriginalReturnType],
+                Concatenate[SelectorOutput, Args],
+                Awaitable[ReturnType],
             ],
-        ) -> ViewReturnType[Awaitable[ViewOriginalReturnType], ViewArgs]: ...
+        ) -> ViewReturnType[Awaitable[ReturnType], Args]: ...
 
         def decorator(
             func: Callable[
-                Concatenate[SelectorOutput, ViewArgs],
-                AwaitableOrNot[ViewOriginalReturnType],
+                Concatenate[SelectorOutput, Args],
+                AwaitableOrNot[ReturnType],
             ],
-        ) -> ViewReturnType[AwaitableOrNot[ViewOriginalReturnType], ViewArgs]:
+        ) -> ViewReturnType[AwaitableOrNot[ReturnType], Args]:
             _options = options or ViewOptions()
             return Autorun(
                 store=self,
@@ -408,6 +410,7 @@ class Store(Generic[State, Action, Event], SerializationMixin):
                     auto_await=True,
                     initial_call=False,
                     reactive=False,
+                    memoization=_options.memoization,
                     keep_ref=_options.keep_ref,
                     subscribers_initial_run=_options.subscribers_initial_run,
                     subscribers_keep_ref=_options.subscribers_keep_ref,
@@ -416,6 +419,36 @@ class Store(Generic[State, Action, Event], SerializationMixin):
 
         return decorator
 
+    def with_state(
+        self: Store[State, Action, Event],
+        selector: Callable[[State], SelectorOutput],
+    ) -> WithStateDecorator[SelectorOutput]:
+        """Wrap a function, passing the result of the selector as its first argument.
+
+        Note that it has zero reactivity, it just runs the function with the result
+        of the selector whenever it is called explicitly. To make it reactive, use
+        `autorun` instead.
+
+        This is mostly for improving code oragnization and readability. Directly Using
+        `store._state` is also possible.
+        """
+
+        def decorator(
+            func: Callable[
+                Concatenate[SelectorOutput, Args],
+                ReturnType,
+            ],
+        ) -> Callable[Args, ReturnType]:
+            def wrapper(*args: Args.args, **kwargs: Args.kwargs) -> ReturnType:
+                if self._state is None:
+                    msg = 'Store has not been initialized yet.'
+                    raise RuntimeError(msg)
+                return func(selector(self._state), *args, **kwargs)
+
+            return wrapper
+
+        return decorator
+
     @property
     def snapshot(self: Store[State, Action, Event]) -> SnapshotAtom:
         """Return a snapshot of the current state of the store."""