chore: Declaring new base StateChart with new defaults and keeping StateMachine for backwards compatibility

Author: fgmacedo

conftest.py

@@ -6,7 +6,8 @@
 
 @pytest.fixture(autouse=True, scope="session")
 def add_doctest_context(doctest_namespace):  # noqa: PT004
-    from statemachine import State, StateMachine
+    from statemachine import State
+    from statemachine import StateMachine
     from statemachine.utils import run_async_from_sync
 
     class ContribAsyncio:

docs/guards.md

@@ -22,7 +22,7 @@ A conditional transition occurs only if specific conditions or criteria are met.
 
 When a transition is conditional, it includes a condition (also known as a _guard_) that must be satisfied for the transition to take place. If the condition is not met, the transition does not occur, and the state machine remains in its current state or follows an alternative path.
 
-This feature allows for multiple transitions on the same {ref}`event`, with each {ref}`transition` checked in the order they are declared. A condition acts like a predicate (a function that evaluates to true/false) and is checked when a {ref}`statemachine` handles an {ref}`event` with a transition from the current state bound to this event. The first transition that meets the conditions (if any) is executed. If none of the transitions meet the conditions, the state machine either raises an exception or does nothing (see the `allow_event_without_transition` parameter of {ref}`StateMachine`).
+This feature allows for multiple transitions on the same {ref}`event`, with each {ref}`transition` checked in the order they are declared. A condition acts like a predicate (a function that evaluates to true/false) and is checked when a {ref}`statemachine` handles an {ref}`event` with a transition from the current state bound to this event. The first transition that meets the conditions (if any) is executed. If none of the transitions meet the conditions, the state machine either raises an exception or does nothing (see the `allow_event_without_transition` class attribute of {ref}`StateMachine`).
 
 When {ref}`transitions` have guards, it is possible to define two or more transitions for the same {ref}`event` from the same {ref}`state`. When the {ref}`event` occurs, the guarded transitions are checked one by one, and the first transition whose guard is true will be executed, while the others will be ignored.
 

docs/images/order_control_machine_initial.png

@@ -89,7 +89,10 @@ including tolerance to unknown {ref}`event` triggers.
 The default value is ``False``, that keeps the backward compatible behavior of when an
 event does not result in a {ref}`transition`, an exception ``TransitionNotAllowed`` will be raised.
 
-```py
+```
+>>> import pytest
+>>> pytest.skip("Since 3.0.0 `allow_event_without_transition` is now a class attribute.")
+
 >>> sm = ApprovalMachine(allow_event_without_transition=True)
 
 >>> sm.send("unknow_event_name")

docs/images/order_control_machine_initial_300dpi.png

@@ -217,3 +217,12 @@ def on_validate(self, previous_configuration):
         return "congrats!"
 
 ```
+
+
+### Configuring the event without transition behaviour
+
+The `allow_event_without_transition` was previously configured as an init parameter, now it's a class-level
+attribute.
+
+Defaults to `False` in `StateMachine` class to preserve maximum backwards compatibility.
+

docs/images/order_control_machine_processing.png

@@ -1,9 +1,10 @@
 from .event import Event
 from .state import State
+from .statemachine import StateChart
 from .statemachine import StateMachine
 
 __author__ = """Fernando Macedo"""
 __email__ = "fgmacedo@gmail.com"
 __version__ = "2.5.0"
 
-__all__ = ["StateMachine", "State", "Event"]
+__all__ = ["StateChart", "StateMachine", "State", "Event"]