python-statemachine 2.3.2__tar.gz → 2.3.4__tar.gz

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-statemachine
-Version: 2.3.2
+Version: 2.3.4
 Summary: Python Finite State Machines made easy.
 Home-page: https://github.com/fgmacedo/python-statemachine
 License: MIT

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-statemachine"
-version = "2.3.2"
+version = "2.3.4"
 description = "Python Finite State Machines made easy."
 authors = ["Fernando Macedo <fgmacedo@gmail.com>"]
 maintainers = [
@@ -56,12 +56,13 @@ django = { version = "^5.0.3", python = ">3.10" }
 pytest-django = { version = "^4.8.0", python = ">3.8" }
 
 [tool.poetry.group.docs.dependencies]
-Sphinx = "*"
-sphinx-rtd-theme = "2.0.0"
-myst-parser = "*"
-sphinx-gallery = "*"
-pillow = "*"
-sphinx-autobuild = "*"
+Sphinx = { version = "*", python = ">3.8" }
+myst-parser = { version = "*", python = ">3.8" }
+sphinx-gallery = { version = "*", python = ">3.8" }
+pillow = { version ="*", python = ">3.8" }
+sphinx-autobuild = { version = "*", python = ">3.8" }
+furo = { version = "^2024.5.6", python = ">3.8" }
+sphinx-copybutton = { version = "^0.5.2", python = ">3.8" }
 
 [build-system]
 requires = ["poetry-core"]

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/__init__.py

@@ -3,6 +3,6 @@ from .statemachine import StateMachine
 
 __author__ = """Fernando Macedo"""
 __email__ = "fgmacedo@gmail.com"
-__version__ = "2.3.2"
+__version__ = "2.3.4"
 
 __all__ = ["StateMachine", "State"]

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/callbacks.py

@@ -1,9 +1,9 @@
 import asyncio
 from bisect import insort
-from collections import Counter
 from collections import defaultdict
 from collections import deque
 from enum import IntEnum
+from enum import IntFlag
 from enum import auto
 from inspect import isawaitable
 from inspect import iscoroutinefunction
@@ -27,10 +27,14 @@ class CallbackPriority(IntEnum):
     AFTER = 40
 
 
-class SpecReference(IntEnum):
-    NAME = 1
-    CALLABLE = 2
-    PROPERTY = 3
+class SpecReference(IntFlag):
+    NAME = auto()
+    CALLABLE = auto()
+    PROPERTY = auto()
+
+
+SPECS_ALL = SpecReference.NAME | SpecReference.CALLABLE | SpecReference.PROPERTY
+SPECS_SAFE = SpecReference.NAME
 
 
 class CallbackGroup(IntEnum):
@@ -335,7 +339,7 @@ class CallbacksExecutor:
 class CallbacksRegistry:
     def __init__(self) -> None:
         self._registry: Dict[str, CallbacksExecutor] = defaultdict(CallbacksExecutor)
-        self._method_types: Counter = Counter()
+        self.has_async_callbacks: bool = False
 
     def clear(self):
         self._registry.clear()
@@ -357,6 +361,6 @@ class CallbacksRegistry:
             )
 
     def async_or_sync(self):
-        self._method_types.update(
+        self.has_async_callbacks = any(
             callback._iscoro for executor in self._registry.values() for callback in executor
         )

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/dispatcher.py

@@ -8,8 +8,8 @@ from typing import Iterable
 from typing import Set
 from typing import Tuple
 
-from statemachine.callbacks import SpecReference
-
+from .callbacks import SPECS_ALL
+from .callbacks import SpecReference
 from .signature import SignatureAdapter
 
 if TYPE_CHECKING:
@@ -54,10 +54,18 @@ class Listeners:
         all_attrs = set().union(*(listener.all_attrs for listener in listeners))
         return cls(listeners, all_attrs)
 
-    def resolve(self, specs: "CallbackSpecList", registry):
+    def resolve(
+        self,
+        specs: "CallbackSpecList",
+        registry,
+        allowed_references: SpecReference = SPECS_ALL,
+    ):
         found_convention_specs = specs.conventional_specs & self.all_attrs
         filtered_specs = [
-            spec for spec in specs if not spec.is_convention or spec.func in found_convention_specs
+            spec
+            for spec in specs
+            if spec.reference in allowed_references
+            and (not spec.is_convention or spec.func in found_convention_specs)
         ]
         if not filtered_specs:
             return
@@ -101,7 +109,7 @@ class Listeners:
                 if func is not None and func.__func__ is spec.func:
                     return callable_method(spec.attr_name, func, config.resolver_id)
 
-        return callable_method(spec.func, spec.func, None)
+        return callable_method(spec.attr_name, spec.func, None)
 
     def _search_name(self, name) -> Generator["Callable", None, None]:
         for config in self.items:

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/engines/async_.py

@@ -31,9 +31,9 @@ class AsyncEngine:
         Given how async works on python, there's no built-in way to activate the initial state that
         may depend on async code from the StateMachine.__init__ method.
         """
-        return await self._processing_loop()
+        return await self.processing_loop()
 
-    async def _processing_loop(self):
+    async def processing_loop(self):
         """Process event triggers.
 
         The simplest implementation is the non-RTC (synchronous),

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/engines/sync.py

@@ -29,9 +29,9 @@ class SyncEngine:
         Given how async works on python, there's no built-in way to activate the initial state that
         may depend on async code from the StateMachine.__init__ method.
         """
-        return self._processing_loop()
+        return self.processing_loop()
 
-    def _processing_loop(self):
+    def processing_loop(self):
         """Process event triggers.
 
         The simplest implementation is the non-RTC (synchronous),

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/statemachine.py

@@ -9,11 +9,11 @@ from typing import Any
 from typing import Dict
 from typing import List
 
-from statemachine.graph import iterate_states_and_transitions
-from statemachine.utils import run_async_from_sync
-
+from .callbacks import SPECS_ALL
+from .callbacks import SPECS_SAFE
 from .callbacks import CallbacksExecutor
 from .callbacks import CallbacksRegistry
+from .callbacks import SpecReference
 from .dispatcher import Listener
 from .dispatcher import Listeners
 from .engines.async_ import AsyncEngine
@@ -24,8 +24,10 @@ from .exceptions import InvalidDefinition
 from .exceptions import InvalidStateValue
 from .exceptions import TransitionNotAllowed
 from .factory import StateMachineMetaclass
+from .graph import iterate_states_and_transitions
 from .i18n import _
 from .model import Model
+from .utils import run_async_from_sync
 
 if TYPE_CHECKING:
     from .state import State
@@ -106,7 +108,7 @@ class StateMachine(metaclass=StateMachineMetaclass):
         self._engine = self._get_engine(rtc)
 
     def _get_engine(self, rtc: bool):
-        if self._callbacks_registry._method_types[True] > 0:
+        if self._callbacks_registry.has_async_callbacks:
             return AsyncEngine(self, rtc=rtc)
         else:
             return SyncEngine(self, rtc=rtc)
@@ -118,7 +120,7 @@ class StateMachine(metaclass=StateMachineMetaclass):
         return run_async_from_sync(result)
 
     def _processing_loop(self):
-        return self._engine._processing_loop()
+        return self._engine.processing_loop()
 
     def __init_subclass__(cls, strict_states: bool = False):
         cls._strict_states = strict_states
@@ -177,8 +179,12 @@ class StateMachine(metaclass=StateMachineMetaclass):
                     continue
                 setattr(target, event.name, trigger)
 
-    def _add_listener(self, listeners: "Listeners"):
-        register = partial(listeners.resolve, registry=self._callbacks_registry)
+    def _add_listener(self, listeners: "Listeners", allowed_references: SpecReference = SPECS_ALL):
+        register = partial(
+            listeners.resolve,
+            registry=self._callbacks_registry,
+            allowed_references=allowed_references,
+        )
         for visited in iterate_states_and_transitions(self.states):
             register(visited._specs)
 
@@ -210,7 +216,7 @@ class StateMachine(metaclass=StateMachineMetaclass):
     def add_observer(self, *observers):
         """Add a listener."""
         warnings.warn(
-            """The `add_observer` was rebranded to `add_listener`.""",
+            """Method `add_observer` has been renamed to `add_listener`.""",
             DeprecationWarning,
             stacklevel=2,
         )
@@ -228,7 +234,8 @@ class StateMachine(metaclass=StateMachineMetaclass):
         """
         self._listeners.update({o: None for o in listeners})
         return self._add_listener(
-            Listeners.from_listeners(Listener.from_obj(o) for o in listeners)
+            Listeners.from_listeners(Listener.from_obj(o) for o in listeners),
+            allowed_references=SPECS_SAFE,
         )
 
     def _repr_html_(self):
@@ -303,9 +310,6 @@ class StateMachine(metaclass=StateMachineMetaclass):
     def send(self, event: str, *args, **kwargs):
         """Send an :ref:`Event` to the state machine.
 
-        This is a thin wrapper around :meth:`async_send` to allow synchronous
-        code to send events.
-
         .. seealso::
 
             See: :ref:`triggering events`.

{python_statemachine-2.3.2 → python_statemachine-2.3.4}/statemachine/states.py

@@ -54,7 +54,6 @@ class States:
         return list(self) == list(other)
 
     def __getattr__(self, name: str):
-        name = name.lower()
         if name in self._states:
             return self._states[name]
         raise AttributeError(f"{name} not found in {self.__class__.__name__}")
@@ -81,7 +80,7 @@ class States:
         return self._states.items()
 
     @classmethod
-    def from_enum(cls, enum_type: EnumType, initial, final=None):
+    def from_enum(cls, enum_type: EnumType, initial, final=None, use_enum_instance: bool = False):
         """
         Creates a new instance of the ``States`` class from an enumeration.
 
@@ -103,12 +102,13 @@ class States:
         ...     def on_enter_completed(self):
         ...         print("Completed!")
 
-        .. note::
-            Given that you assign the response of ``States.from_enum`` to a class level
-            variable on your :ref:`StateMachine` you're good to go, you can use any name to assign
-            this response, on this example we used ``_`` to indicate that the name does not matter.
-            The variable of type :ref:`States (class)` will be inspected by the metaclass and the
-            inner :ref:`State` instances assigned to the state machine.
+        .. tip::
+            When you assign the result of ``States.from_enum`` to a class-level variable in your
+            :ref:`StateMachine`, you're all set. You can use any name for this variable. In this
+            example, we used ``_`` to show that the name doesn't matter. The metaclass will inspect
+            the variable of type :ref:`States (class)` and automatically assign the inner
+            :ref:`State` instances to the state machine.
+
 
         Everything else is similar, the ``Enum`` is only used to declare the :ref:`State`
         instances.
@@ -125,12 +125,25 @@ class States:
         True
 
         >>> sm.current_state_value
+        2
+
+        If you need to use the enum instance as the state value, you can set the
+        ``use_enum_instance=True``:
+
+        >>> states = States.from_enum(Status, initial=Status.pending, use_enum_instance=True)
+        >>> states.completed.value
         <Status.completed: 2>
 
+        .. deprecated:: 2.3.3
+
+            On the next major release, the ``use_enum_instance=True`` will be the default.
+
         Args:
             enum_type: An enumeration containing the states of the machine.
             initial: The initial state of the machine.
             final: A set of final states of the machine.
+            use_enum_instance: If ``True``, the value of the state will be the enum item instance,
+                otherwise the enum item value.
 
         Returns:
             A new instance of the :ref:`States (class)`.
@@ -138,7 +151,11 @@ class States:
         final_set = set(ensure_iterable(final))
         return cls(
             {
-                e.name.lower(): State(value=e, initial=e is initial, final=e in final_set)
+                e.name: State(
+                    value=(e if use_enum_instance else e.value),
+                    initial=e is initial,
+                    final=e in final_set,
+                )
                 for e in enum_type
             }
         )