python-statemachine 2.1.2__tar.gz → 2.3.0__tar.gz

{python_statemachine-2.1.2 → python_statemachine-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: python-statemachine
-Version: 2.1.2
+Version: 2.3.0
 Summary: Python Finite State Machines made easy.
 Home-page: https://github.com/fgmacedo/python-statemachine
 License: MIT
@@ -8,7 +8,8 @@ Author: Fernando Macedo
 Author-email: fgmacedo@gmail.com
 Maintainer: Fernando Macedo
 Maintainer-email: fgmacedo@gmail.com
-Requires-Python: >=3.7,<3.13
+Requires-Python: >=3.7
+Classifier: Framework :: AsyncIO
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Natural Language :: English
@@ -26,8 +27,8 @@ Description-Content-Type: text/markdown
 # Python StateMachine
 
 [![pypi](https://img.shields.io/pypi/v/python-statemachine.svg)](https://pypi.python.org/pypi/python-statemachine)
+[![downloads total](https://static.pepy.tech/badge/python-statemachine)](https://pepy.tech/project/python-statemachine)
 [![downloads](https://img.shields.io/pypi/dm/python-statemachine.svg)](https://pypi.python.org/pypi/python-statemachine)
-[![build status](https://github.com/fgmacedo/python-statemachine/actions/workflows/python-package.yml/badge.svg?branch=develop)](https://github.com/fgmacedo/python-statemachine/actions/workflows/python-package.yml?query=branch%3Adevelop)
 [![Coverage report](https://codecov.io/gh/fgmacedo/python-statemachine/branch/develop/graph/badge.svg)](https://codecov.io/gh/fgmacedo/python-statemachine)
 [![Documentation Status](https://readthedocs.org/projects/python-statemachine/badge/?version=latest)](https://python-statemachine.readthedocs.io/en/latest/?badge=latest)
 [![GitHub commits since last release (main)](https://img.shields.io/github/commits-since/fgmacedo/python-statemachine/main/develop)](https://github.com/fgmacedo/python-statemachine/compare/main...develop)
@@ -35,33 +36,43 @@ Description-Content-Type: text/markdown
 
 Python [finite-state machines](https://en.wikipedia.org/wiki/Finite-state_machine) made easy.
 
+<div align="center">
 
-* Free software: MIT license
-* Documentation: https://python-statemachine.readthedocs.io.
+![](https://github.com/fgmacedo/python-statemachine/blob/develop/docs/images/python-statemachine.png?raw=true)
 
+</div>
 
-Welcome to python-statemachine, an intuitive and powerful state machine framework designed for a
-great developer experience.
+Welcome to python-statemachine, an intuitive and powerful state machine library designed for a
+great developer experience. We provide an _pythonic_ and expressive API for implementing state
+machines in sync or asynchonous Python codebases.
 
-🚀 With StateMachine, you can easily create complex, dynamic systems with clean, readable code.
+## Features
 
-💡 Our framework makes it easy to understand and reason about the different states, events and
-transitions in your system, so you can focus on building great products.
+- ✨ **Basic components**: Easily define **States**, **Events**, and **Transitions** to model your logic.
+- ⚙️ **Actions and handlers**: Attach actions and handlers to states, events, and transitions to control behavior dynamically.
+- 🛡️ **Conditional transitions**: Implement **Guards** and **Validators** to conditionally control transitions, ensuring they only occur when specific conditions are met.
+- 🚀 **Full async support**: Enjoy full asynchronous support. Await events, and dispatch callbacks asynchronously for seamless integration with async codebases.
+- 🔄 **Full sync support**: Use the same state machine from synchronous codebases without any modifications.
+- 🎨 **Declarative and simple API**: Utilize a clean, elegant, and readable API to define your state machine, making it easy to maintain and understand.
+- 👀 **Observer pattern support**: Register external and generic objects to watch events and register callbacks.
+- 🔍 **Decoupled design**: Separate concerns with a decoupled "state machine" and "model" design, promoting cleaner architecture and easier maintenance.
+- ✅ **Correctness guarantees**: Ensured correctness with validations at class definition time:
+   - Ensures exactly one `initial` state.
+   - Disallows transitions from `final` states.
+   - Requires ongoing transitions for all non-final states.
+   - Guarantees all non-final states have at least one path to a final state if final states are declared.
+   - Validates the state machine graph representation has a single component.
+- 📦 **Flexible event dispatching**: Dispatch events with any extra data, making it available to all callbacks, including actions and guards.
+- 🔧 **Dependency injection**: Needed parameters are injected into callbacks.
+- 📊 **Graphical representation**: Generate and output graphical representations of state machines. Create diagrams from the command line, at runtime, or even in Jupyter notebooks.
+- 🌍 **Internationalization support**: Provides error messages in different languages, making the library accessible to a global audience.
+- 🛡️ **Robust testing**: Ensured reliability with a codebase that is 100% covered by automated tests, including all docs examples. Releases follow semantic versioning for predictable releases.
+- 🏛️ **Domain model integration**: Seamlessly integrate with domain models using Mixins.
+- 🔧 **Django integration**: Automatically discover state machines in Django applications.
 
-🔒 python-statemachine also provides robust error handling and ensures that your system stays
-in a valid state at all times.
 
 
-A few reasons why you may consider using it:
-
-* 📈 python-statemachine is designed to help you build scalable,
-  maintainable systems that can handle any complexity.
-* 💪 You can easily create and manage multiple state machines within a single application.
-* 🚫 Prevents common mistakes and ensures that your system stays in a valid state at all times.
-
-
-## Getting started
-
+## Installing
 
 To install Python State Machine, run this command in your terminal:
 
@@ -73,6 +84,8 @@ our docs for more details.
 
     pip install python-statemachine[diagrams]
 
+## First example
+
 Define your state machine:
 
 ```py
@@ -90,7 +103,7 @@ Define your state machine:
 ...         | red.to(green)
 ...     )
 ...
-...     def before_cycle(self, event: str, source: State, target: State, message: str = ""):
+...     async def before_cycle(self, event: str, source: State, target: State, message: str = ""):
 ...         message = ". " + message if message else ""
 ...         return f"Running {event} from {source.id} to {target.id}{message}"
 ...
@@ -133,7 +146,27 @@ Then start sending events to your new state machine:
 
 ```
 
-That's it. This is all an external object needs to know about your state machine: How to send events.
+You can use the exactly same state machine from an async codebase:
+
+
+```py
+>>> async def run_sm():
+...    asm = TrafficLightMachine()
+...    results = []
+...    for _i in range(4):
+...        result = await asm.send("cycle")
+...        results.append(result)
+...    return results
+
+>>> asyncio.run(run_sm())
+Don't move.
+Go ahead!
+['Running cycle from green to yellow', 'Running cycle from yellow to red', ...
+
+```
+
+
+**That's it.** This is all an external object needs to know about your state machine: How to send events.
 Ideally, all states, transitions, and actions should be kept internally and not checked externally to avoid unnecessary coupling.
 
 But if your use case needs, you can inspect state machine properties, like the current state:
@@ -220,7 +253,7 @@ callback method.
 Note how `before_cycle` was declared:
 
 ```py
-def before_cycle(self, event: str, source: State, target: State, message: str = ""):
+async def before_cycle(self, event: str, source: State, target: State, message: str = ""):
     message = ". " + message if message else ""
     return f"Running {event} from {source.id} to {target.id}{message}"
 ```
@@ -265,6 +298,34 @@ and in diagrams:
 
 ```
 
+## Async support
+
+We support native coroutine using `asyncio`, enabling seamless integration with asynchronous code.
+There's no change on the public API of the library to work on async codebases.
+
+
+```py
+>>> class AsyncStateMachine(StateMachine):
+...     initial = State('Initial', initial=True)
+...     final = State('Final', final=True)
+...
+...     advance = initial.to(final)
+...
+...     async def on_advance(self):
+...         return 42
+
+>>> async def run_sm():
+...     sm = AsyncStateMachine()
+...     result = await sm.advance()
+...     print(f"Result is {result}")
+...     print(sm.current_state)
+
+>>> asyncio.run(run_sm())
+Result is 42
+Final
+
+```
+
 ## A more useful example
 
 A simple didactic state machine for controlling an `Order`:

{python_statemachine-2.1.2 → python_statemachine-2.3.0}/README.md

@@ -1,8 +1,8 @@
 # Python StateMachine
 
 [![pypi](https://img.shields.io/pypi/v/python-statemachine.svg)](https://pypi.python.org/pypi/python-statemachine)
+[![downloads total](https://static.pepy.tech/badge/python-statemachine)](https://pepy.tech/project/python-statemachine)
 [![downloads](https://img.shields.io/pypi/dm/python-statemachine.svg)](https://pypi.python.org/pypi/python-statemachine)
-[![build status](https://github.com/fgmacedo/python-statemachine/actions/workflows/python-package.yml/badge.svg?branch=develop)](https://github.com/fgmacedo/python-statemachine/actions/workflows/python-package.yml?query=branch%3Adevelop)
 [![Coverage report](https://codecov.io/gh/fgmacedo/python-statemachine/branch/develop/graph/badge.svg)](https://codecov.io/gh/fgmacedo/python-statemachine)
 [![Documentation Status](https://readthedocs.org/projects/python-statemachine/badge/?version=latest)](https://python-statemachine.readthedocs.io/en/latest/?badge=latest)
 [![GitHub commits since last release (main)](https://img.shields.io/github/commits-since/fgmacedo/python-statemachine/main/develop)](https://github.com/fgmacedo/python-statemachine/compare/main...develop)
@@ -10,33 +10,43 @@
 
 Python [finite-state machines](https://en.wikipedia.org/wiki/Finite-state_machine) made easy.
 
+<div align="center">
 
-* Free software: MIT license
-* Documentation: https://python-statemachine.readthedocs.io.
+![](https://github.com/fgmacedo/python-statemachine/blob/develop/docs/images/python-statemachine.png?raw=true)
 
+</div>
 
-Welcome to python-statemachine, an intuitive and powerful state machine framework designed for a
-great developer experience.
+Welcome to python-statemachine, an intuitive and powerful state machine library designed for a
+great developer experience. We provide an _pythonic_ and expressive API for implementing state
+machines in sync or asynchonous Python codebases.
 
-🚀 With StateMachine, you can easily create complex, dynamic systems with clean, readable code.
+## Features
 
-💡 Our framework makes it easy to understand and reason about the different states, events and
-transitions in your system, so you can focus on building great products.
+- ✨ **Basic components**: Easily define **States**, **Events**, and **Transitions** to model your logic.
+- ⚙️ **Actions and handlers**: Attach actions and handlers to states, events, and transitions to control behavior dynamically.
+- 🛡️ **Conditional transitions**: Implement **Guards** and **Validators** to conditionally control transitions, ensuring they only occur when specific conditions are met.
+- 🚀 **Full async support**: Enjoy full asynchronous support. Await events, and dispatch callbacks asynchronously for seamless integration with async codebases.
+- 🔄 **Full sync support**: Use the same state machine from synchronous codebases without any modifications.
+- 🎨 **Declarative and simple API**: Utilize a clean, elegant, and readable API to define your state machine, making it easy to maintain and understand.
+- 👀 **Observer pattern support**: Register external and generic objects to watch events and register callbacks.
+- 🔍 **Decoupled design**: Separate concerns with a decoupled "state machine" and "model" design, promoting cleaner architecture and easier maintenance.
+- ✅ **Correctness guarantees**: Ensured correctness with validations at class definition time:
+   - Ensures exactly one `initial` state.
+   - Disallows transitions from `final` states.
+   - Requires ongoing transitions for all non-final states.
+   - Guarantees all non-final states have at least one path to a final state if final states are declared.
+   - Validates the state machine graph representation has a single component.
+- 📦 **Flexible event dispatching**: Dispatch events with any extra data, making it available to all callbacks, including actions and guards.
+- 🔧 **Dependency injection**: Needed parameters are injected into callbacks.
+- 📊 **Graphical representation**: Generate and output graphical representations of state machines. Create diagrams from the command line, at runtime, or even in Jupyter notebooks.
+- 🌍 **Internationalization support**: Provides error messages in different languages, making the library accessible to a global audience.
+- 🛡️ **Robust testing**: Ensured reliability with a codebase that is 100% covered by automated tests, including all docs examples. Releases follow semantic versioning for predictable releases.
+- 🏛️ **Domain model integration**: Seamlessly integrate with domain models using Mixins.
+- 🔧 **Django integration**: Automatically discover state machines in Django applications.
 
-🔒 python-statemachine also provides robust error handling and ensures that your system stays
-in a valid state at all times.
 
 
-A few reasons why you may consider using it:
-
-* 📈 python-statemachine is designed to help you build scalable,
-  maintainable systems that can handle any complexity.
-* 💪 You can easily create and manage multiple state machines within a single application.
-* 🚫 Prevents common mistakes and ensures that your system stays in a valid state at all times.
-
-
-## Getting started
-
+## Installing
 
 To install Python State Machine, run this command in your terminal:
 
@@ -48,6 +58,8 @@ our docs for more details.
 
     pip install python-statemachine[diagrams]
 
+## First example
+
 Define your state machine:
 
 ```py
@@ -65,7 +77,7 @@ Define your state machine:
 ...         | red.to(green)
 ...     )
 ...
-...     def before_cycle(self, event: str, source: State, target: State, message: str = ""):
+...     async def before_cycle(self, event: str, source: State, target: State, message: str = ""):
 ...         message = ". " + message if message else ""
 ...         return f"Running {event} from {source.id} to {target.id}{message}"
 ...
@@ -108,7 +120,27 @@ Then start sending events to your new state machine:
 
 ```
 
-That's it. This is all an external object needs to know about your state machine: How to send events.
+You can use the exactly same state machine from an async codebase:
+
+
+```py
+>>> async def run_sm():
+...    asm = TrafficLightMachine()
+...    results = []
+...    for _i in range(4):
+...        result = await asm.send("cycle")
+...        results.append(result)
+...    return results
+
+>>> asyncio.run(run_sm())
+Don't move.
+Go ahead!
+['Running cycle from green to yellow', 'Running cycle from yellow to red', ...
+
+```
+
+
+**That's it.** This is all an external object needs to know about your state machine: How to send events.
 Ideally, all states, transitions, and actions should be kept internally and not checked externally to avoid unnecessary coupling.
 
 But if your use case needs, you can inspect state machine properties, like the current state:
@@ -195,7 +227,7 @@ callback method.
 Note how `before_cycle` was declared:
 
 ```py
-def before_cycle(self, event: str, source: State, target: State, message: str = ""):
+async def before_cycle(self, event: str, source: State, target: State, message: str = ""):
     message = ". " + message if message else ""
     return f"Running {event} from {source.id} to {target.id}{message}"
 ```
@@ -240,6 +272,34 @@ and in diagrams:
 
 ```
 
+## Async support
+
+We support native coroutine using `asyncio`, enabling seamless integration with asynchronous code.
+There's no change on the public API of the library to work on async codebases.
+
+
+```py
+>>> class AsyncStateMachine(StateMachine):
+...     initial = State('Initial', initial=True)
+...     final = State('Final', final=True)
+...
+...     advance = initial.to(final)
+...
+...     async def on_advance(self):
+...         return 42
+
+>>> async def run_sm():
+...     sm = AsyncStateMachine()
+...     result = await sm.advance()
+...     print(f"Result is {result}")
+...     print(sm.current_state)
+
+>>> asyncio.run(run_sm())
+Result is 42
+Final
+
+```
+
 ## A more useful example
 
 A simple didactic state machine for controlling an `Order`:

{python_statemachine-2.1.2 → python_statemachine-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "python-statemachine"
-version = "2.1.2"
+version = "2.3.0"
 description = "Python Finite State Machines made easy."
 authors = ["Fernando Macedo <fgmacedo@gmail.com>"]
 maintainers = [
@@ -27,36 +27,38 @@ classifiers = [
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
-    "Topic :: Software Development :: Libraries"
+    "Topic :: Software Development :: Libraries",
+    "Framework :: AsyncIO",
+    "Intended Audience :: Developers",
 ]
 
 [tool.poetry.extras]
 diagrams = ["pydot"]
 
 [tool.poetry.dependencies]
-python = ">=3.7, <3.13"
+python = ">=3.7"
 
 [tool.poetry.group.dev.dependencies]
-pytest = "^7.2.0"
-pytest-cov = "^4.0.0"
-pytest-sugar = "^0.9.6"
-pydot = "^1.4.2"
-ruff = "^0.0.257"
-pre-commit = "^2.21.0"
-mypy = "^0.991"
-black = "^22.12.0"
-pdbpp = "^0.10.3"
+pytest = "*"
+pytest-cov = "*"
+pytest-sugar = "^1.0.0"
+pydot = "^2.0.0"
+ruff = "^0.4.8"
+pre-commit = "*"
+mypy = "*"
 pytest-mock = "^3.10.0"
 pytest-profiling = "^1.7.0"
 pytest-benchmark = "^4.0.0"
+pytest-asyncio = "*"
+sphinx-rtd-theme = "^2.0.0"
 
 [tool.poetry.group.docs.dependencies]
-Sphinx = "4.5.0"
-sphinx-rtd-theme = "1.1.1"
-myst-parser = "^0.18.1"
-sphinx-gallery = "^0.11.1"
-pillow = "^9.4.0"
-sphinx-autobuild = "^2021.3.14"
+Sphinx = "*"
+sphinx-rtd-theme = "2.0.0"
+myst-parser = "*"
+sphinx-gallery = "*"
+pillow = "*"
+sphinx-autobuild = "*"
 
 [build-system]
 requires = ["poetry-core"]
@@ -65,6 +67,10 @@ build-backend = "poetry.core.masonry.api"
 [tool.pytest.ini_options]
 addopts = "--ignore=docs/conf.py --ignore=docs/auto_examples/ --ignore=docs/_build/ --ignore=tests/examples/ --cov --cov-config .coveragerc --doctest-glob='*.md' --doctest-modules --doctest-continue-on-failure --benchmark-autosave"
 doctest_optionflags = "ELLIPSIS IGNORE_EXCEPTION_DETAIL NORMALIZE_WHITESPACE IGNORE_EXCEPTION_DETAIL"
+asyncio_mode = "auto"
+markers = [
+    """slow: marks tests as slow (deselect with '-m "not slow"')""",
+]
 
 [tool.mypy]
 python_version = "3.12"
@@ -91,24 +97,8 @@ max-line-length = 99
 [tool.ruff]
 src = ["statemachine"]
 
-# Enable Pyflakes and pycodestyle rules.
-select = [
-    "E", # pycodestyle errors
-    "W", # pycodestyle warnings
-    "F", # pyflakes
-    "I", # isort
-    "UP", # pyupgrade
-    "C",  # flake8-comprehensions
-    "B",  # flake8-bugbear
-    "PT", # flake8-pytest-style
-]
-ignore = [
-    "UP006", # `use-pep585-annotation` Requires Python3.9+
-    "UP035", # `use-pep585-annotation` Requires Python3.9+
-    "UP038", # `use-pep585-annotation` Requires Python3.9+
-]
-
 line-length = 99
+target-version = "py312"
 
 # Exclude a variety of commonly ignored directories.
 exclude = [
@@ -131,19 +121,41 @@ exclude = [
     "venv",
 ]
 
+[tool.ruff.lint]
+
+# Enable Pyflakes and pycodestyle rules.
+select = [
+    "E", # pycodestyle errors
+    "W", # pycodestyle warnings
+    "F", # pyflakes
+    "I", # isort
+    "UP", # pyupgrade
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+    "PT", # flake8-pytest-style
+]
+ignore = [
+    "UP006", # `use-pep585-annotation` Requires Python3.9+
+    "UP035", # `use-pep585-annotation` Requires Python3.9+
+    "UP038", # `use-pep585-annotation` Requires Python3.9+
+]
+
 # Allow unused variables when underscore-prefixed.
 dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
-# Assume Python 3.11.
-target-version = "py311"
+[tool.ruff.lint.per-file-ignores]
+# Ignore `E402` (import violations) in all `__init__.py` files, and in `path/to/file.py`.
+"__init__.py" = ["E402"]
+"path/to/file.py" = ["E402"]
+"tests/examples/**.py" = ["B018"]
 
-[tool.ruff.mccabe]
+[tool.ruff.lint.mccabe]
 max-complexity = 6
 
-[tool.ruff.isort]
+[tool.ruff.lint.isort]
 force-single-line = true
 
-[tool.ruff.pydocstyle]
+[tool.ruff.lint.pydocstyle]
 # Use Google-style docstrings.
 convention = "google"
 

{python_statemachine-2.1.2 → python_statemachine-2.3.0}/statemachine/__init__.py

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