Merge branch 'release/3.1.0' into develop

Author: fgmacedo

docs/releases/3.1.0.md

@@ -1,6 +1,6 @@
 # StateChart 3.1.0
 
-*Not released yet*
+*May 15, 2026*
 
 ## What's new in 3.1.0
 
@@ -205,3 +205,21 @@ fixes [#610](https://github.com/fgmacedo/python-statemachine/issues/610).
   fixes [#606](https://github.com/fgmacedo/python-statemachine/issues/606).
 
 ## Misc in 3.1.0
+
+- Internal refactor of `Configuration` to always normalize to `OrderedSet` internally, with
+  two boundary helpers (`_read_from_model` / `_write_to_model`) confining the
+  `None | scalar | OrderedSet` trichotomy to the model edge. Public API is unchanged.
+  [#599](https://github.com/fgmacedo/python-statemachine/pull/599).
+
+- Reduced allocation overhead in `Configuration.add()` / `discard()` by mutating the
+  `OrderedSet` in place and writing back via the setter, removing the ~4–5% overhead
+  introduced by the persistence fix in [#596](https://github.com/fgmacedo/python-statemachine/pull/596).
+
+- Diagram module restructured into a package and doctests in `docs/diagram.md` replaced by
+  the new Sphinx directive; a pre-commit hook now keeps generated diagrams in sync.
+  [#589](https://github.com/fgmacedo/python-statemachine/pull/589),
+  [#590](https://github.com/fgmacedo/python-statemachine/pull/590).
+
+- Bumped the minimum `pydot` version to `4.0.1` for the `diagrams` optional extra, plus a
+  general refresh of dev dependencies (ruff, pytest-cov, pytest-asyncio, Django, furo, etc.).
+  [#608](https://github.com/fgmacedo/python-statemachine/pull/608).

statemachine/locale/en/LC_MESSAGES/statemachine.po

@@ -3,9 +3,9 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version:  3.0.0\n"
+"Project-Id-Version:  3.1.0\n"
 "Report-Msgid-Bugs-To: fgmacedo@gmail.com\n"
-"POT-Creation-Date: 2026-02-24 14:31-0300\n"
+"POT-Creation-Date: 2026-05-15 12:08-0300\n"
 "PO-Revision-Date: 2026-02-24 14:31-0300\n"
 "Last-Translator: Fernando Macedo <fgmacedo@gmail.com>\n"
 "Language: en\n"
@@ -14,113 +14,139 @@ msgstr ""
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
-"Generated-By: Babel 2.16.0\n"
+"Generated-By: Babel 2.18.0\n"
 
 #: statemachine/callbacks.py:404 statemachine/callbacks.py:409
+#, python-brace-format
 msgid "Did not found name '{}' from model or statemachine"
 msgstr "Did not found name '{}' from model or statemachine"
 
+#: statemachine/configuration.py:121
+msgid ""
+"There's no current state set. In async code, did you activate the initial"
+" state? (e.g., `await sm.activate_initial_state()`)"
+msgstr ""
+"There's no current state set. In async code, did you activate the initial"
+" state? (e.g., `await sm.activate_initial_state()`)"
+
 #: statemachine/dispatcher.py:126
+#, python-brace-format
 msgid "Failed to parse boolean expression '{}'"
 msgstr "Failed to parse boolean expression '{}'"
 
-#: statemachine/event.py:121
+#: statemachine/event.py:95
+#, python-brace-format
+msgid ""
+"Event() received a non-string 'id' ({cls_name}). To combine multiple "
+"transitions under one event, use the | operator: t1 | t2."
+msgstr ""
+"Event() received a non-string 'id' ({cls_name}). To combine multiple "
+"transitions under one event, use the | operator: t1 | t2."
+
+#: statemachine/event.py:131
+#, python-brace-format
 msgid "Cannot add callback '{}' to an event with no transitions."
 msgstr "Cannot add callback '{}' to an event with no transitions."
 
-#: statemachine/event.py:154
+#: statemachine/event.py:164
+#, python-brace-format
 msgid "Event {} cannot be called without a SM instance"
 msgstr "Event {} cannot be called without a SM instance"
 
 #: statemachine/exceptions.py:25
+#, python-brace-format
 msgid "{!r} is not a valid state value."
 msgstr "{!r} is not a valid state value."
 
 #: statemachine/exceptions.py:40
+#, python-brace-format
 msgid "Can't {} when in {}."
 msgstr "Can't {} when in {}."
 
-#: statemachine/factory.py:79
+#: statemachine/factory.py:81
+#, python-brace-format
 msgid ""
 "There should be one and only one initial state. Your currently have "
 "these: {0}"
 msgstr ""
 "There should be one and only one initial state. Your currently have "
 "these: {0}"
 
-#: statemachine/factory.py:160
+#: statemachine/factory.py:198
+#, python-brace-format
 msgid ""
 "There should be one and only one initial state. You currently have these:"
 " {!r}"
 msgstr ""
 "There should be one and only one initial state. You currently have these:"
 " {!r}"
 
-#: statemachine/factory.py:176
+#: statemachine/factory.py:213
+#, python-brace-format
 msgid "Cannot declare transitions from final state. Invalid state(s): {}"
 msgstr "Cannot declare transitions from final state. Invalid state(s): {}"
 
-#: statemachine/factory.py:187
+#: statemachine/factory.py:225
+#, python-brace-format
 msgid ""
 "All non-final states should have at least one outgoing transition. These "
 "states have no outgoing transition: {!r}"
 msgstr ""
 "All non-final states should have at least one outgoing transition. These "
 "states have no outgoing transition: {!r}"
 
-#: statemachine/factory.py:201
+#: statemachine/factory.py:239
+#, python-brace-format
 msgid ""
 "All non-final states should have at least one path to a final state. "
 "These states have no path to a final state: {!r}"
 msgstr ""
 "All non-final states should have at least one path to a final state. "
 "These states have no path to a final state: {!r}"
 
-#: statemachine/factory.py:214
+#: statemachine/factory.py:252
+#, python-brace-format
 msgid ""
 "There are unreachable states. The statemachine graph should have a single"
 " component. Disconnected states: {}"
 msgstr ""
 "There are unreachable states. The statemachine graph should have a single"
 " component. Disconnected states: {}"
 
-#: statemachine/factory.py:251
+#: statemachine/factory.py:289
+#, python-brace-format
 msgid ""
 "Invalid entry in 'listeners': {!r}. Expected a class, callable, or "
 "listener instance."
 msgstr ""
 "Invalid entry in 'listeners': {!r}. Expected a class, callable, or "
 "listener instance."
 
-#: statemachine/factory.py:351
+#: statemachine/factory.py:388
+#, python-brace-format
 msgid "An event in the '{}' has no id."
 msgstr "An event in the '{}' has no id."
 
 #: statemachine/mixins.py:28
+#, python-brace-format
 msgid "{!r} is not a valid state machine name."
 msgstr "{!r} is not a valid state machine name."
 
-#: statemachine/state.py:246
+#: statemachine/state.py:250
 msgid "'donedata' can only be specified on final states."
 msgstr "'donedata' can only be specified on final states."
 
-#: statemachine/state.py:304
-msgid "State overriding is not allowed. Trying to add '{}' to {}"
-msgstr "State overriding is not allowed. Trying to add '{}' to {}"
-
-#: statemachine/statemachine.py:158
+#: statemachine/statemachine.py:169
 msgid "There are no states or transitions."
 msgstr "There are no states or transitions."
 
-#: statemachine/statemachine.py:431
-msgid ""
-"There's no current state set. In async code, did you activate the initial"
-" state? (e.g., `await sm.activate_initial_state()`)"
-msgstr ""
-"There's no current state set. In async code, did you activate the initial"
-" state? (e.g., `await sm.activate_initial_state()`)"
+#: statemachine/statemachine.py:239
+#, python-brace-format
+msgid "State overriding is not allowed. Trying to add '{}' to {}"
+msgstr "State overriding is not allowed. Trying to add '{}' to {}"
 
-#: statemachine/transition.py:74
+#: statemachine/transition.py:75
+#, python-brace-format
 msgid ""
 "Not a valid internal transition from source {source!r}, target {target!r}"
 " should be self or a descendant."
@@ -129,5 +155,6 @@ msgstr ""
 " should be self or a descendant."
 
 #: statemachine/transition_mixin.py:19
+#, python-brace-format
 msgid "{} only supports the decorator syntax to register callbacks."
 msgstr "{} only supports the decorator syntax to register callbacks."