python-statemachine 2.3.3__py3-none-any.whl → 2.3.4__py3-none-any.whl

{python_statemachine-2.3.3.dist-info → python_statemachine-2.3.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-statemachine
-Version: 2.3.3
+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.3.dist-info → python_statemachine-2.3.4.dist-info}/RECORD

@@ -1,8 +1,8 @@
-statemachine/__init__.py,sha256=ZOsh7Du9N_DZCAZKm6FHONs0DODQb0w5P-9Vi5ofgTQ,192
-statemachine/callbacks.py,sha256=m9AS3G4qumJBjFwQNJZi3JbWbEOxjcW50H59VC7bLLY,10946
+statemachine/__init__.py,sha256=adVlL_-BcysTOCiwLuk9ETvy23vCnxMDRioFAadkeZ4,192
+statemachine/callbacks.py,sha256=5_WaILrjUvZOYX_LQe4Gd8nsCvkErjw9DaHYG_ggvxs,11101
 statemachine/contrib/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 statemachine/contrib/diagram.py,sha256=JJx52yZqgDNIebvcUJ82IGT4EyerXQmOcF5mR21_kao,7198
-statemachine/dispatcher.py,sha256=oYlld3gvQDn2iXRPjk9ujtd5JnqWHxcft5oV80i-jMY,5175
+statemachine/dispatcher.py,sha256=2DtjCj_kiDF2uk_EEvXxs5NTABOvCr4paxVz77s6mXA,5365
 statemachine/engines/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 statemachine/engines/async_.py,sha256=Z-AS4zQ2xDj2uexJ7fepQTSaw5PjqesemWGXX9g0rpU,5546
 statemachine/engines/sync.py,sha256=bYCyzoYo03LLfxzUl2XyyNlmMmxDLn_w0AMa5IHCF3U,5497
@@ -20,12 +20,12 @@ statemachine/model.py,sha256=OylI3FjMiHpYyDl9mtK1zEJMeSvemaN4giQDonpc8kI,211
 statemachine/registry.py,sha256=HmV9sUGkYVrNUZxJYoZo-trSUis7dIun_WcGktblgc8,922
 statemachine/signature.py,sha256=HwuyWX3p_GZwKKrGbt9wk4-bHpymqs_pgqW7OlDgGRc,7877
 statemachine/state.py,sha256=IKdkMBkXCgcvswMKQZ-hn0-739Hhf6z6q8mSEoevV7o,8262
-statemachine/statemachine.py,sha256=zJeGHQxKItuVsmaLdMwsvRoJ29oSI2Ff3B9pYwVi8H4,11274
-statemachine/states.py,sha256=gkwF9y1x0-t6ULQL0JrJcR1uflHGQNRZoyaMTXrPuKw,4886
+statemachine/statemachine.py,sha256=WgI4LbnOyOBl8OZqBXFRYETtt8rQi0XEhQN-D_2oMFM,11536
+statemachine/states.py,sha256=vpRNjiGmTDHvE0fn0gwdq8-WcG32n4ZiPTU-kgZ73rc,4870
 statemachine/transition.py,sha256=R7gfSZjqR59OIdpKePgdr66zTp5azow-tDqqYJsECR4,4711
 statemachine/transition_list.py,sha256=_tdFD1O7hw8xVAU6nRYmGrj6TCAM0SD-Sa0_DYKa88Y,6034
 statemachine/utils.py,sha256=DpcrGqlbrnT-ogh-BogG0L07EG3KirHOsKORHlspDlI,1041
-python_statemachine-2.3.3.dist-info/LICENSE,sha256=zcP7TsJMqaFxuTvLRZPT7nJl3_ppjxR9Z76BE9pL5zc,1074
-python_statemachine-2.3.3.dist-info/METADATA,sha256=f9c8HTfQptQe4ocTS85DdYpG4ZrXZWi6cDVIIvxoIvo,13932
-python_statemachine-2.3.3.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
-python_statemachine-2.3.3.dist-info/RECORD,,
+python_statemachine-2.3.4.dist-info/LICENSE,sha256=zcP7TsJMqaFxuTvLRZPT7nJl3_ppjxR9Z76BE9pL5zc,1074
+python_statemachine-2.3.4.dist-info/METADATA,sha256=Sn9ueboV6iqunRJjBB5VtyxuD1UJyTk8f002WFzWwM4,13932
+python_statemachine-2.3.4.dist-info/WHEEL,sha256=Zb28QaM1gQi8f4VCBhsUklF61CTlNYfs9YAZn-TOGFk,88
+python_statemachine-2.3.4.dist-info/RECORD,,

statemachine/__init__.py

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

statemachine/callbacks.py

@@ -3,6 +3,7 @@ from bisect import insort
 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
@@ -26,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):

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:

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
@@ -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):

statemachine/states.py

@@ -102,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.