Merge branch 'release/2.5.0'

Author: fgmacedo

.github/workflows/python-package.yml

@@ -15,61 +15,49 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13.0-rc.1"]
+        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - run: git fetch origin develop
     - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v3
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
     - name: Setup Graphviz
-      uses: ts-graphviz/setup-graphviz@v1
-    - name: Install Poetry
-      uses: snok/install-poetry@v1
+      uses: ts-graphviz/setup-graphviz@v2
+    - name: Install uv
+      uses: astral-sh/setup-uv@v3
       with:
-        version: 1.5.1
-        virtualenvs-create: true
-        virtualenvs-in-project: true
-        installer-parallel: true
-    - name: Load cached venv
-      id: cached-poetry-dependencies
-      uses: actions/cache@v3
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
-    - name: Install dependencies
-      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-      run: poetry install --no-interaction --no-root --all-extras
+        enable-cache: true
+        cache-suffix: "python${{ matrix.python-version }}"
+    - name: Install the project
+      run: uv sync --all-extras --dev
     - name: Install old pydot for 3.7 only
       if: matrix.python-version == 3.7
       run: |
-        source .venv/bin/activate
-        pip install pydot==2.0.0
+        uv pip install pydot==2.0.0
       #----------------------------------------------
       #              run ruff
       #----------------------------------------------
     - name: Linter with ruff
-      if: matrix.python-version == 3.12
+      if: matrix.python-version == 3.13
       run: |
-        source .venv/bin/activate
-        ruff check .
-        ruff format --check .
+        uv run ruff check .
+        uv run ruff format --check .
       #----------------------------------------------
       #              run pytest
       #----------------------------------------------
     - name: Test with pytest
       run: |
-        source .venv/bin/activate
-        pytest --cov-report=xml:coverage.xml
-        coverage xml
+        uv run pytest --cov-report=xml:coverage.xml
+        uv run coverage xml
       #----------------------------------------------
       #          upload coverage
       #----------------------------------------------
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v4
-      if: matrix.python-version == 3.12
+      if: matrix.python-version == 3.13
       with:
         token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
         directory: .

.github/workflows/release.yml

@@ -4,51 +4,65 @@ on:
 name: release
 
 jobs:
-  pypi-publish:
-    name: upload release to PyPI
+  release-build:
+    name: Build release artifacts
     runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        python-version: ["3.12"]
 
-        # Specifying a GitHub environment is optional, but strongly encouraged
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - run: git fetch origin develop
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+
+      - name: Setup Graphviz
+        uses: ts-graphviz/setup-graphviz@v2
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Test
+        run: |
+          uv run pytest
+
+      - name: Build
+        run: |
+          uv build
+
+      - name: Upload  dists
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+
+  pypi-publish:
+    # by a dedicated job to publish we avoid the risk of
+    # running code with access to PyPI credentials
+    name: Upload release to PyPI
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
     environment: release
     permissions:
-      # IMPORTANT: this permission is mandatory for trusted publishing
       id-token: write
+
     steps:
-    - uses: actions/checkout@v3
-    - run: git fetch origin develop
-    - name: Set up Python ${{ matrix.python-version }}
-      uses: actions/setup-python@v4
-      with:
-        python-version: ${{ matrix.python-version }}
-    - name: Setup Graphviz
-      uses: ts-graphviz/setup-graphviz@v1
-    - name: Install Poetry
-      uses: snok/install-poetry@v1
-      with:
-        version: 1.5.1
-        virtualenvs-create: true
-        virtualenvs-in-project: true
-        installer-parallel: true
-    - name: Load cached venv
-      id: cached-poetry-dependencies
-      uses: actions/cache@v3
-      with:
-        path: .venv
-        key: venv-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('**/poetry.lock') }}
-    - name: Install dependencies
-      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
-      run: poetry install --no-interaction --no-root --all-extras
-    - name: Test with pytest
-      run: |
-        source .venv/bin/activate
-        pytest
-    - name: Poetry build
-      run: |
-        source .venv/bin/activate
-        poetry build
-    - name: Publish package distributions to PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish package distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v2.3.0
+    rev: v4.6.0
     hooks:
     -   id: check-yaml
     -   id: end-of-file-fixer
@@ -9,7 +9,7 @@ repos:
         exclude: docs/auto_examples
 - repo: https://github.com/charliermarsh/ruff-pre-commit
   # Ruff version.
-  rev: v0.3.7
+  rev: v0.8.1
   hooks:
     # Run the linter.
     - id: ruff
@@ -21,13 +21,13 @@ repos:
   hooks:
   - id: mypy
     name: Mypy
-    entry: poetry run mypy --namespace-packages --explicit-package-bases statemachine/ tests/
+    entry: uv run mypy --namespace-packages --explicit-package-bases statemachine/ tests/
     types: [python]
     language: system
     pass_filenames: false
   - id: pytest
     name: Pytest
-    entry: poetry run pytest
+    entry: uv run pytest
     types: [python]
     language: system
     pass_filenames: false

.readthedocs.yaml

@@ -5,24 +5,18 @@
 # Required
 version: 2
 
-# Set the version of Python and other tools you might need
 build:
-  os: ubuntu-22.04
+  os: "ubuntu-22.04"
   tools:
     python: "3.12"
   apt_packages:
     - graphviz
   jobs:
     post_create_environment:
-      # Install poetry
-      # https://python-poetry.org/docs/#installing-manually
-      - python -m pip install poetry
-      # Tell poetry to not use a virtual environment
-      - poetry config virtualenvs.create false
-    post_install:
-      # Install dependencies with 'docs' dependency group
-      # https://python-poetry.org/docs/managing-dependencies/#dependency-groups
-      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --extras diagrams --with docs
+      - asdf plugin add uv
+      - asdf install uv latest
+      - asdf global uv latest
+      - UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --all-extras --frozen
 
 # Build documentation in the docs/ directory with Sphinx
 sphinx:

README.md

@@ -168,27 +168,27 @@ Easily iterate over all states:
 
 ```py
 >>> [s.id for s in sm.states]
-['green', 'red', 'yellow']
+['green', 'yellow', 'red']
 
 ```
 
 Or over events:
 
 ```py
->>> [t.name for t in sm.events]
+>>> [t.id for t in sm.events]
 ['cycle']
 
 ```
 
-Call an event by its name:
+Call an event by its id:
 
 ```py
 >>> sm.cycle()
 Don't move.
 'Running cycle from yellow to red'
 
 ```
-Or send an event with the event name:
+Or send an event with the event id:
 
 ```py
 >>> sm.send('cycle')

docs/async.md

@@ -47,6 +47,23 @@ Engines are internal and are activated automatically by inspecting the registere
 
 ```
 
+Outer scope
+: The context in which the state machine **instance** is created.
+
+Async callbacks?
+: Indicates whether the state machine has declared asynchronous callbacks or conditions.
+
+Engine
+: The engine that will be utilized.
+
+Creates internal loop
+: Specifies whether the state machine initiates a new event loop if no [asyncio loop is running](https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.get_running_loop).
+
+Reuses external loop
+: Indicates whether the state machine reuses an existing [asyncio loop](https://docs.python.org/3/library/asyncio-eventloop.html#asyncio.get_running_loop) if one is already running.
+
+
+
 ```{note}
 All handlers will run on the same thread they are called. Therefore, mixing synchronous and asynchronous code is not recommended unless you are confident in your implementation.
 ```

docs/contributing.md

@@ -87,7 +87,7 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
 
 1. Install dependencies.
    1. [graphviz](https://graphviz.org/download/#linux)
-   1. [poetry](https://python-poetry.org/docs/#installation)
+   1. [uv](https://docs.astral.sh/uv/getting-started/installation/)
 
 1. Fork the `python-statemachine` repository on GitHub.
 
@@ -96,31 +96,29 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
         git clone https://github.com/YOUR-USERNAME/python-statemachine.git.
 
 
-1. Run `poetry install` once to install all the dependencies and create a virtual environment::
+1. Run `uv sync` once to install all the development dependencies and create a virtual environment::
 
-        poetry install --all-extras
+        uv sync --all-extras
 
-1. Run `poetry shell` to enter the provided virtual
-
-1. Install the pre-commit validations:
+2. Install the pre-commit validations:
 
         pre-commit install
 
-1. Create a branch for local development:
+3. Create a branch for local development:
 
         git checkout -b <name-of-your-bugfix-or-feature>
 
-1. Make changes to the code.
+4. Make changes to the code.
 
-1. Run tests to ensure they pass by running:
+5. Run tests to ensure they pass by running:
 
-        poetry run pytest
+        uv run pytest
 
-1. Update the documentation as needed.
+6. Update the documentation as needed.
 
     Build the documentation:
 
-        poetry run sphinx-build docs docs/_build/html
+        uv run sphinx-build docs docs/_build/html
 
 
     Now you can serve the local documentation using a webserver, like the built-in included
@@ -133,7 +131,7 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
     If you're specially writting documentation, I strongly recommend using `sphinx-autobuild`
     as it improves the workflow watching for file changes and with live reloading:
 
-        poetry run sphinx-autobuild docs docs/_build/html --re-ignore "auto_examples/.*"
+        uv run sphinx-autobuild docs docs/_build/html --re-ignore "auto_examples/.*"
 
     Sometimes you need a full fresh of the files being build for docs, you can safely remove
     all automatically generated files to get a clean state by running: