feat: autorun decorator accepts a default value for when store is not initialized

feat: `autorun` decorator takes its options in its keyword arguments

Author: sassanh

CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 
-## Version 0.9.16
+## Version 0.9.18
+
+- feat: `autorun` decorator accepts a default value for when store is not initialized
+- feat: `autorun` decorator takes its options in its keyword arguments
+
+## Version 0.9.17
 
 - refactor: make `dispatch` accept a `with_state(store)` function as parameter, if
   provided it will dispatch return value of this function

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-redux"
-version = "0.9.16"
+version = "0.9.18"
 description = "Redux implementation for Python"
 authors = ["Sassan Haradji <sassanh@gmail.com>"]
 license = "Apache-2.0"

redux/basic_types.py

@@ -91,11 +91,17 @@ def __call__(
         self: AutorunType,
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], Any] | None = None,
-    ) -> AutorunDecorator[State, SelectorOutput]:
+        *,
+        default_value: AutorunOriginalReturnType | None = None,
+        initial_run: bool = True,
+    ) -> AutorunDecorator[State, SelectorOutput, AutorunOriginalReturnType]:
         ...
 
 
-class AutorunDecorator(Protocol, Generic[State, SelectorOutput]):
+class AutorunDecorator(
+    Protocol,
+    Generic[State, SelectorOutput, AutorunOriginalReturnType],
+):
     def __call__(
         self: AutorunDecorator,
         func: Callable[[SelectorOutput], AutorunOriginalReturnType]
@@ -136,7 +142,8 @@ class Dispatch(Protocol, Generic[State, Action, Event]):
     def __call__(
         self: Dispatch,
         *items: Action | Event | list[Action | Event],
-        with_state: Callable[[State | None], Action | Event | list[Action | Event]],
+        with_state: Callable[[State | None], Action | Event | list[Action | Event]]
+        | None = None,
     ) -> None:
         ...
 

redux/main.py

@@ -163,7 +163,10 @@ def handle_finish_event(_event: Event) -> None:
     def autorun(
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], ComparatorOutput] | None = None,
-    ) -> AutorunDecorator[State, SelectorOutput]:
+        *,
+        default_value: AutorunOriginalReturnType | None = None,
+        initial_run: bool = _options.autorun_initial_run,
+    ) -> AutorunDecorator[State, SelectorOutput, AutorunOriginalReturnType]:
         nonlocal state
 
         def decorator(
@@ -172,7 +175,7 @@ def decorator(
         ) -> AutorunReturnType[AutorunOriginalReturnType]:
             last_selector_result: SelectorOutput | None = None
             last_comparator_result: ComparatorOutput = cast(ComparatorOutput, object())
-            last_value: AutorunOriginalReturnType | None = None
+            last_value: AutorunOriginalReturnType | None = default_value
             subscriptions: list[Callable[[AutorunOriginalReturnType], Any]] = []
 
             def check_and_call(state: State) -> None:
@@ -212,7 +215,7 @@ def check_and_call(state: State) -> None:
                     for subscriber in subscriptions:
                         subscriber(last_value)
 
-            if _options.autorun_initial_run and state is not None:
+            if initial_run and state is not None:
                 check_and_call(state)
 
             subscribe(check_and_call)