refactor: encapsulate autorun options previously provided as multiple keyword arguments, in a single AutorunOptions immutable class

refactor: rename `immediate` to `immediate_run` in autorun subscribers feat: default value of `immediate_run` can be set for all subscribers of an autorun
instance by settings `subscribers_immediate_run` option for the autorun

Author: sassanh

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## Version 0.9.20
+
+- refactor: encapsulate autorun options previously provided as multiple keyword arguments,
+  in a single `AutorunOptions` immutable class
+- refactor: rename `immediate` to `immediate_run` in autorun subscribers
+- feat: default value of `immediate_run` can be set for all subscribers of an autorun
+  instance by settings `subscribers_immediate_run` option for the autorun
+
 ## Version 0.9.19
 
 - feat: add `immediate` parameter to `subscribe` method of `autorun`'s returned value

demo.py

@@ -127,15 +127,13 @@ def main() -> None:
     # Initialization <
     store = create_store(
         reducer,
-        CreateStoreOptions(autorun_initial_run=True),
+        CreateStoreOptions(auto_init=True, threads=2),
     )
 
     def event_handler(event: SleepEvent) -> None:
         time.sleep(event.duration)
 
     store.subscribe_event(SleepEvent, event_handler)
-
-    store.dispatch(InitAction())
     # >
 
     # -----

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-redux"
-version = "0.9.19"
+version = "0.9.20"
 description = "Redux implementation for Python"
 authors = ["Sassan Haradji <sassanh@gmail.com>"]
 license = "Apache-2.0"
@@ -11,6 +11,7 @@ packages = [{ include = "redux" }]
 python = "^3.9"
 python-immutable = "^1.0.0"
 typing-extensions = "^4.9.0"
+pyright = "^1.1.348"
 
 
 [tool.poetry.scripts]
@@ -22,7 +23,7 @@ optional = true
 
 [tool.poetry.group.dev.dependencies]
 poethepoet = "^0.24.3"
-pyright = "^1.1.342"
+pyright = "^1.1.348"
 ruff = "^0.1.9"
 
 [build-system]
@@ -46,3 +47,6 @@ multiline-quotes = "double"
 
 [tool.ruff.format]
 quote-style = 'single'
+
+[tool.isort]
+profile = "black"

pyproject.toml

@@ -1,7 +1,7 @@
 # ruff: noqa: A003, D100, D101, D102, D103, D104, D105, D107
 from __future__ import annotations
 
-from typing import Any, Callable, Generic, Protocol, Sequence, TypeAlias, TypeGuard
+from typing import Any, Callable, Generic, Protocol, TypeAlias, TypeGuard
 
 from immutable import Immutable
 from typing_extensions import TypeVar
@@ -26,21 +26,20 @@ class EventSubscriptionOptions(Immutable):
 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)
 Comparator = Callable[[State], ComparatorOutput]
 EventHandler = Callable[[Event], Any] | Callable[[], Any]
 
 
 class CompleteReducerResult(Immutable, Generic[State, Action, Event]):
     state: State
-    actions: Sequence[Action] | None = None
-    events: Sequence[Event] | None = None
+    actions: list[Action] | None = None
+    events: list[Event] | None = None
 
 
 ReducerResult = CompleteReducerResult[State, Action, Event] | State
 ReducerType = Callable[[State | None, Action], ReducerResult[State, Action, Event]]
 
-AutorunOriginalReturnType = TypeVar('AutorunOriginalReturnType', infer_variance=True)
-
 
 class InitializationActionError(Exception):
     def __init__(self: InitializationActionError, action: BaseAction) -> None:
@@ -80,27 +79,42 @@ def __call__(self: Scheduler, callback: Callable, *, interval: bool) -> None:
 class CreateStoreOptions(Immutable):
     auto_init: bool = False
     threads: int = 5
-    autorun_initial_run: bool = True
     scheduler: Scheduler | None = None
     action_middleware: Callable[[BaseAction], Any] | None = None
     event_middleware: Callable[[BaseEvent], Any] | None = None
 
 
+CreStoreOptions = CreateStoreOptions(auto_init=True)
+
+
+class AutorunOptions(Immutable, Generic[AutorunOriginalReturnType]):
+    default_value: AutorunOriginalReturnType | None = None
+    initial_run: bool = True
+    subscribers_immediate_run: bool = True
+
+
 class AutorunType(Protocol, Generic[State]):
     def __call__(
         self: AutorunType,
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], Any] | None = None,
         *,
-        default_value: AutorunOriginalReturnType | None = None,
-        initial_run: bool = True,
-    ) -> AutorunDecorator[State, SelectorOutput, AutorunOriginalReturnType]:
+        options: AutorunOptions[AutorunOriginalReturnType] | None = None,
+    ) -> AutorunDecorator[
+        State,
+        SelectorOutput,
+        AutorunOriginalReturnType,
+    ]:
         ...
 
 
 class AutorunDecorator(
     Protocol,
-    Generic[State, SelectorOutput, AutorunOriginalReturnType],
+    Generic[
+        State,
+        SelectorOutput,
+        AutorunOriginalReturnType,
+    ],
 ):
     def __call__(
         self: AutorunDecorator,
@@ -110,7 +124,10 @@ def __call__(
         ...
 
 
-class AutorunReturnType(Protocol, Generic[AutorunOriginalReturnType]):
+class AutorunReturnType(
+    Protocol,
+    Generic[AutorunOriginalReturnType],
+):
     def __call__(self: AutorunReturnType) -> AutorunOriginalReturnType:
         ...
 
@@ -122,7 +139,7 @@ def subscribe(
         self: AutorunReturnType,
         callback: Callable[[AutorunOriginalReturnType], Any],
         *,
-        immediate: bool = False,
+        immediate_run: bool | None = None,
     ) -> Callable[[], None]:
         ...
 
@@ -150,7 +167,10 @@ def __call__(
         ...
 
 
-class InitializeStateReturnValue(Immutable, Generic[State, Action, Event]):
+class InitializeStateReturnValue(
+    Immutable,
+    Generic[State, Action, Event],
+):
     dispatch: Dispatch[State, Action, Event]
     subscribe: Callable[[Callable[[State], Any]], Callable[[], None]]
     subscribe_event: EventSubscriber

redux/basic_types.py

@@ -11,6 +11,7 @@
 from .basic_types import (
     Action,
     AutorunDecorator,
+    AutorunOptions,
     AutorunOriginalReturnType,
     AutorunReturnType,
     BaseAction,
@@ -63,7 +64,7 @@ def create_store(
     reducer: ReducerType[State, Action, Event],
     options: CreateStoreOptions | None = None,
 ) -> InitializeStateReturnValue[State, Action, Event]:
-    _options = CreateStoreOptions() if options is None else options
+    store_options = options or CreateStoreOptions()
 
     state: State | None = None
     listeners: set[Callable[[State], Any]] = set()
@@ -76,7 +77,7 @@ def create_store(
     events: list[Event] = []
 
     event_handlers_queue = queue.Queue[tuple[EventHandler[Event], Event] | None]()
-    for _ in range(_options.threads):
+    for _ in range(store_options.threads):
         worker = SideEffectRunnerThread(event_handlers_queue)
         worker.start()
 
@@ -128,15 +129,15 @@ def dispatch(
 
         for item in items:
             if isinstance(item, BaseAction):
-                if _options.action_middleware:
-                    _options.action_middleware(item)
+                if store_options.action_middleware:
+                    store_options.action_middleware(item)
                 actions.append(item)
             if isinstance(item, BaseEvent):
-                if _options.event_middleware:
-                    _options.event_middleware(item)
+                if store_options.event_middleware:
+                    store_options.event_middleware(item)
                 events.append(item)
 
-        if _options.scheduler is None and not is_running.locked():
+        if store_options.scheduler is None and not is_running.locked():
             run()
 
     def subscribe(listener: Callable[[State], Any]) -> Callable[[], None]:
@@ -155,7 +156,7 @@ def subscribe_event(
         )
 
     def handle_finish_event(_event: Event) -> None:
-        for _ in range(_options.threads):
+        for _ in range(store_options.threads):
             event_handlers_queue.put(None)
 
     subscribe_event(cast(type[Event], FinishEvent), handle_finish_event)
@@ -164,9 +165,13 @@ def autorun(
         selector: Callable[[State], SelectorOutput],
         comparator: Callable[[State], ComparatorOutput] | None = None,
         *,
-        default_value: AutorunOriginalReturnType | None = None,
-        initial_run: bool = _options.autorun_initial_run,
-    ) -> AutorunDecorator[State, SelectorOutput, AutorunOriginalReturnType]:
+        options: AutorunOptions[AutorunOriginalReturnType] | None = None,
+    ) -> AutorunDecorator[
+        State,
+        SelectorOutput,
+        AutorunOriginalReturnType,
+    ]:
+        autorun_options = options or AutorunOptions()
         nonlocal state
 
         def decorator(
@@ -175,7 +180,7 @@ def decorator(
         ) -> AutorunReturnType[AutorunOriginalReturnType]:
             last_selector_result: SelectorOutput | None = None
             last_comparator_result: ComparatorOutput = cast(ComparatorOutput, object())
-            last_value: AutorunOriginalReturnType | None = default_value
+            last_value: AutorunOriginalReturnType | None = autorun_options.default_value
             subscriptions: list[Callable[[AutorunOriginalReturnType], Any]] = []
 
             def check_and_call(state: State) -> None:
@@ -215,7 +220,7 @@ def check_and_call(state: State) -> None:
                     for subscriber in subscriptions:
                         subscriber(last_value)
 
-            if initial_run and state is not None:
+            if autorun_options.initial_run and state is not None:
                 check_and_call(state)
 
             subscribe(check_and_call)
@@ -234,11 +239,12 @@ def subscribe(
                     self: Call,
                     callback: Callable[[AutorunOriginalReturnType], Any],
                     *,
-                    immediate: bool = False,
+                    immediate_run: bool
+                    | None = autorun_options.subscribers_immediate_run,
                 ) -> Callable[[], None]:
                     subscriptions.append(callback)
 
-                    if immediate:
+                    if immediate_run:
                         callback(self.value)
 
                     def unsubscribe() -> None:
@@ -250,17 +256,17 @@ def unsubscribe() -> None:
 
         return decorator
 
-    if _options.auto_init:
-        if _options.scheduler:
-            _options.scheduler(
+    if store_options.auto_init:
+        if store_options.scheduler:
+            store_options.scheduler(
                 lambda: dispatch(cast(Action, InitAction())),
                 interval=False,
             )
         else:
             dispatch(cast(Action, InitAction()))
 
-    if _options.scheduler:
-        _options.scheduler(run, interval=True)
+    if store_options.scheduler:
+        store_options.scheduler(run, interval=True)
 
     return InitializeStateReturnValue(
         dispatch=dispatch,