sqlalchemy-state-machine 1.11.0__tar.gz → 2.0.0__tar.gz

sqlalchemy_state_machine-2.0.0/.github/SECURITY.md

@@ -0,0 +1,8 @@
+# Security Policy
+
+## Supported Versions
+
+We will endeavour to support:
+* the most recent minor release with bug fixes
+* the latest minor release from the last major version
+  for 6 months after a new major version is released with critical bug fixes

sqlalchemy_state_machine-2.0.0/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+  - package-ecosystem: uv
+    directory: /
+    schedule:
+      interval: weekly

sqlalchemy_state_machine-2.0.0/.github/workflows/ci.yml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  quality:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --all-groups --locked
+      - run: uv run --locked ruff format --check src tests examples
+      - run: uv run --locked ruff check src tests examples
+      - run: uv run --locked mypy src
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --all-groups --locked
+      - run: uv run --locked pytest --cov=sqlalchemy_state_machine --cov-report=term-missing

sqlalchemy_state_machine-2.0.0/.github/workflows/publish.yml

@@ -0,0 +1,57 @@
+name: Publish
+
+on:
+  push:
+    tags: ["v*", "[0-9]*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.14"
+      - uses: astral-sh/setup-uv@v7
+      - run: uv sync --all-groups --locked
+      - name: Verify tag matches project version
+        run: |
+          uv run --locked python - <<'PY'
+          import os
+          import tomllib
+
+          with open("pyproject.toml", "rb") as pyproject:
+              version = tomllib.load(pyproject)["project"]["version"]
+
+          tag = os.environ["GITHUB_REF_NAME"]
+          if tag.removeprefix("v") != version:
+              raise SystemExit(
+                  f"Release tag {tag!r} does not match [project].version "
+                  f"{version!r} in pyproject.toml."
+              )
+          PY
+      - run: uv run --locked ruff format --check src tests examples
+      - run: uv run --locked ruff check src tests examples
+      - run: uv run --locked mypy src
+      - run: uv run --locked pytest --cov=sqlalchemy_state_machine --cov-report=term-missing
+      - run: uv build
+      - run: uv run --locked python -m zipfile -t dist/*.whl
+      - uses: actions/upload-artifact@v4
+        with:
+          name: package-distributions
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/sqlalchemy-state-machine
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: package-distributions
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

sqlalchemy_state_machine-2.0.0/.gitignore

@@ -0,0 +1,10 @@
+.venv/
+__pycache__/
+*.py[cod]
+.coverage
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+build/
+dist/
+*.egg-info/

sqlalchemy_state_machine-2.0.0/CHANGELOG.md

@@ -0,0 +1,189 @@
+# Changelog
+
+## 2.0.0 (2026-07-20)
+
+- **Breaking:** Python 3.11+ and SQLAlchemy 2.x rewrite.
+- **Breaking:** Replace the `transitions` integration with explicit `StateMachine`, `Transition`, and `StateMachineMixin` declarations.
+- Add typed validation, callbacks, transition availability inspection, modern packaging, tests, and CI.
+- Remove `StateConfig`, dynamic trigger methods, manual event registration, and legacy Python support.
+
+## 1.11.0 (2024-10-18)
+
+*  Update pipeline [Pavel Liashkov]
+*  Update version [Pavel Liashkov]
+
+
+## 1.10.0 (2023-08-03)
+
+*  Update sqlalchemy requirement from <1.5,>=1.4 to >=1.4,<2.1 [dependabot[bot]]
+*  Update pipeline [Pavel Liashkov]
+*  Update version [Pavel Liashkov]
+
+
+## 1.9.0 (2023-01-19)
+
+*  Update transitions requirement from <0.9,>=0.8 to >=0.8,<0.10 [dependabot[bot]]
+*  Bump version [Pavel Liashkov]
+
+
+## 1.8.0 (2021-07-26)
+
+*  Relax reqs version [Pavel Liashkov]
+
+
+## 1.7.0 (2021-07-23)
+
+*  Bump sqlalchemy from 1.4.18 to 1.4.19 [dependabot[bot]]
+*  Bump sqlalchemy from 1.4.19 to 1.4.22 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.6.0 (2021-06-18)
+
+*  Bump sqlalchemy from 1.4.17 to 1.4.18 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.5.0 (2021-06-04)
+
+*  Bump sqlalchemy from 1.4.15 to 1.4.17 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.4.0 (2021-05-18)
+
+*  Bump sqlalchemy from 1.4.13 to 1.4.15 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.3.0 (2021-05-05)
+
+*  Bump sqlalchemy from 1.4.8 to 1.4.13 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.2.0 (2021-04-16)
+
+*  Bump transitions from 0.8.7 to 0.8.8 [dependabot[bot]]
+*  Bump sqlalchemy from 1.4.5 to 1.4.8 [dependabot[bot]]
+*  Update version.py [Pavel Liashkov]
+
+
+## 1.1.0 (2021-04-05)
+
+*  Bump sqlalchemy from 1.4.0 to 1.4.2 [dependabot[bot]]
+*  Bump sqlalchemy from 1.4.2 to 1.4.5 [dependabot[bot]]
+*  Bump version [Pavel Liashkov]
+
+
+## 1.0.0 (2021-03-17)
+
+*  Add command for check code quality [Pavel Liashkov]
+*  Fix githib workflow [Pavel Liashkov]
+*  Bump sqlalchemy from 1.3.23 to 1.4.0 [dependabot[bot]]
+*  NOTASK: Bump version [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.5.5 (2021-02-20)
+
+*  Bump version [Pavel Liashkov]
+*  Update Makefile [Pavel Liashkov]
+*  Add codecov workflow [Pavel Liashkov]
+*  Add codecov badge [Pavel Liashkov]
+*  Bump transitions from 0.8.6 to 0.8.7 [dependabot[bot]]
+*  Add codecov workflow [Pavel Liashkov]
+*  Add codecov badge [Pavel Liashkov]
+*  Add codecov settings [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.5.4 (2021-02-15)
+
+*  Bump transitions from 0.8.6 to 0.8.7 [dependabot[bot]]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.5.2 (2021-02-02)
+
+*  Bump sqlalchemy from 1.3.22 to 1.3.23 [dependabot[bot]]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.5.1 (2021-02-01)
+
+*  Add download count in readme [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.5.0 (2021-02-01)
+
+*  Fix package format [Pavel Liashkov]
+*  Add licence link to readme [Pavel Liashkov]
+*  Change readme format [Pavel Liashkov]
+*  Add link on security policy [Pavel Liashkov]
+*  NOTASK: Bump version [Pavel Liashkov]
+
+
+## 0.4.0 (2021-01-13)
+
+*  Add state mixin [Pavel Liashkov]
+
+
+## 0.3.3 (2021-01-13)
+
+*  Update readme [Pavel Liashkov]
+
+
+## 0.3.2 (2021-01-13)
+
+*  Fix rst error in readme [Pavel Liashkov]
+
+
+## 0.3.1 (2021-01-13)
+
+*  Fix icon url in readme [Pavel Liashkov]
+
+
+## 0.3.0 (2021-01-13)
+
+*  Fix github actions [Pavel Liashkov]
+*  Add separeted steps lint and tests [Pavel Liashkov]
+*  Rename git action job [Pavel Liashkov]
+*  Update readme [Pavel Liashkov]
+
+
+## 0.2.1 (2021-01-08)
+
+*  Added dependency between jobs in workflow [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.2.0 (2021-01-08)
+
+*  Fix dependabot config [Pavel Liashkov]
+*  Fix python version in pyproject [Pavel Liashkov]
+*  Fix types [Pavel Liashkov]
+*  Add LICENSE, fix setup for pypi [Pavel Liashkov]
+*  Bump version [Pavel Liashkov]
+
+
+## 0.1.6 (2021-01-06)
+
+*  Add config for dependabot [Pavel Liashkov]
+
+
+## 0.1.5 (2021-01-06)
+
+*  Bump version [Pavel Liashkov]
+
+
+## 0.1.3 (2021-01-05)
+
+*  Fix requires [Pavel Liashkov]
+
+
+## 0.1.2 (2021-01-05)
+
+*  Fix version settings [Pavel Liashkov]
+

sqlalchemy_state_machine-2.0.0/Makefile

@@ -0,0 +1,134 @@
+# =============================================================================
+# Project configuration
+# =============================================================================
+PROJECT_DIR := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
+PROJECT_NAME := sqlalchemy-state-machine
+SRC_PATH := src/sqlalchemy_state_machine
+LINT_PATHS := src tests examples
+UV ?= uv
+
+.DEFAULT_GOAL := help
+
+.PHONY: help venv/install/main venv/install/all lint/ruff lint/mypy lint format clean test build sys/changelog sys/tag
+
+# =============================================================================
+# Help
+# =============================================================================
+help: ## Display this help message
+	@awk 'BEGIN { FS = ":.*##"; printf "\nUsage:\n  make <target>\n\nTargets:\n" } /^[a-zA-Z0-9_./-]+:.*##/ { printf "  \033[36m%-24s\033[0m %s\n", $$1, $$2 }' $(MAKEFILE_LIST)
+
+# =============================================================================
+# Environment
+# =============================================================================
+venv/install/main: ## Install main dependencies
+	@echo "==> Installing $(PROJECT_NAME) main dependencies"
+	$(UV) sync --no-group dev
+
+venv/install/all: ## Install all dependency groups
+	@echo "==> Installing $(PROJECT_NAME) with all dependency groups"
+	$(UV) sync --all-groups
+
+# =============================================================================
+# Code quality
+# =============================================================================
+lint/ruff: ## Check formatting and lint with Ruff
+	@echo "==> Checking formatting and linting with Ruff"
+	$(UV) run --locked ruff format --check $(LINT_PATHS)
+	$(UV) run --locked ruff check $(LINT_PATHS)
+
+lint/mypy: ## Type-check the source package with mypy
+	@echo "==> Type-checking $(SRC_PATH) with mypy"
+	$(UV) run --locked mypy $(SRC_PATH)
+
+lint: lint/ruff lint/mypy ## Run all lint checks
+	@echo "==> Lint checks passed"
+
+format: ## Format and auto-fix lint issues
+	@echo "==> Formatting and auto-fixing lint issues"
+	$(UV) run --locked ruff format $(LINT_PATHS)
+	$(UV) run --locked ruff check --fix $(LINT_PATHS)
+
+# =============================================================================
+# Test and build
+# =============================================================================
+test: ## Run the test suite with coverage
+	@echo "==> Testing $(PROJECT_NAME) with coverage"
+	$(UV) run --locked pytest --cov=sqlalchemy_state_machine --cov-report=term-missing
+
+build: ## Build distribution packages
+	@echo "==> Building $(PROJECT_NAME) distribution packages"
+	$(UV) build
+
+clean: ## Remove generated files and caches
+	@echo "==> Removing generated files and caches"
+	rm -rf .coverage .mypy_cache .pytest_cache .ruff_cache build dist
+	find . -type d -name __pycache__ -prune -exec rm -rf {} +
+
+# =============================================================================
+# Release automation
+# =============================================================================
+# Requires mktemp, available on the project's supported macOS and Linux development environments.
+sys/changelog: ## Generate CHANGELOG.md from historical version tags
+	@echo "==> Generating CHANGELOG.md from version tags"
+	@tmp_file=$$(mktemp CHANGELOG.md.XXXXXX) || exit $$?; \
+	cleanup() { rm -f "$$tmp_file"; }; \
+	trap cleanup 0; \
+	trap 'exit 1' HUP INT TERM; \
+	tags="$$( $(UV) run --locked python -c 'import re, subprocess, sys; pattern = re.compile(r"^v?(\d+)\.(\d+)\.(\d+)$$"); raw = subprocess.check_output(["git", "tag"], text=True).splitlines(); tagged = [(tuple(map(int, match.groups())), tag) for tag in raw if (match := pattern.fullmatch(tag))]; len({version for version, _ in tagged}) == len(tagged) or sys.exit("duplicate semantic-version tags are not supported"); tagged.sort(reverse=True); print(" ".join(tag for _, tag in tagged))' )" || exit $$?; \
+	if [ -z "$$tags" ]; then \
+		echo "No semantic-version tags found." >&2; \
+		exit 1; \
+	fi; \
+	{ \
+		printf '# Changelog\n\n'; \
+		set -- $$tags; \
+		newest_tag=$$1; \
+		unreleased=$$(git log --no-merges "$$newest_tag..HEAD" --format='* %s [%an]' --reverse) || exit $$?; \
+		if [ -n "$$unreleased" ]; then \
+			printf '## Unreleased\n\n%s\n\n' "$$unreleased"; \
+		fi; \
+		while [ $$# -gt 0 ]; do \
+			current_tag=$$1; \
+			shift; \
+			older_tag=$${1:-}; \
+			tag_date=$$(git log -1 --format=%as "$$current_tag") || exit $$?; \
+			display_tag=$${current_tag#v}; \
+			printf '## %s (%s)\n\n' "$$display_tag" "$$tag_date"; \
+			if [ -n "$$older_tag" ]; then range="$$older_tag..$$current_tag"; else range="$$current_tag"; fi; \
+			git log --no-merges "$$range" --format='* %s [%an]' --reverse || exit $$?; \
+			printf '\n'; \
+		done; \
+	} > "$$tmp_file" || exit $$?; \
+	if ! mv "$$tmp_file" CHANGELOG.md; then \
+		echo "Unable to replace CHANGELOG.md." >&2; \
+		exit 1; \
+	fi; \
+	trap - 0; \
+	echo "CHANGELOG.md generated successfully."
+
+sys/tag: ## Create and push a vX.Y.Z release tag
+	@read -r -p "Enter tag version (e.g., 2.0.0): " TAG; \
+	if ! printf '%s\n' "$$TAG" | grep -Eq '^[0-9]+\.[0-9]+\.[0-9]+$$'; then \
+		echo "Tag version must use the X.Y.Z format (for example, 2.0.0)" >&2; \
+		exit 1; \
+	fi; \
+	project_version="$$( $(UV) run --locked python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])' )" || exit $$?; \
+	if [ "$$project_version" != "$$TAG" ]; then \
+		echo "Tag version $$TAG does not match pyproject.toml project.version $$project_version" >&2; \
+		exit 1; \
+	fi; \
+	if [ -n "$$(git status --porcelain --untracked-files=all)" ]; then \
+		echo "Worktree must be clean before creating a release tag." >&2; \
+		exit 1; \
+	fi; \
+	if git show-ref --verify --quiet "refs/tags/v$$TAG"; then \
+		echo "Local tag v$$TAG already exists." >&2; \
+		exit 1; \
+	fi; \
+	echo "==> Creating and pushing v$$TAG"; \
+	git tag -a "v$$TAG" -m "Release v$$TAG" || exit $$?; \
+	if ! git push origin "v$$TAG"; then \
+		echo "Push failed; deleting local tag v$$TAG." >&2; \
+		git tag -d "v$$TAG" || exit $$?; \
+		exit 1; \
+	fi

sqlalchemy_state_machine-2.0.0/PKG-INFO

@@ -0,0 +1,159 @@
+Metadata-Version: 2.4
+Name: sqlalchemy-state-machine
+Version: 2.0.0
+Summary: Explicit, typed state transitions for SQLAlchemy models
+Project-URL: Changelog, https://github.com/bigbag/sqlalchemy-state-machine/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/bigbag/sqlalchemy-state-machine
+Project-URL: Issues, https://github.com/bigbag/sqlalchemy-state-machine/issues
+Author-email: Pavel Liashkov <pavel.liashkov@protonmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: sqlalchemy,state-machine,transitions,workflow
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.11
+Requires-Dist: sqlalchemy>=2.0.51
+Description-Content-Type: text/markdown
+
+# sqlalchemy-state-machine
+
+Explicit, typed state transitions for SQLAlchemy models.
+
+## Requirements
+
+- Python 3.11+ (CI validates Python 3.11, 3.12, 3.13, and 3.14)
+- SQLAlchemy 2.x
+
+## Install
+
+```console
+uv add sqlalchemy-state-machine
+```
+
+```console
+pip install sqlalchemy-state-machine
+```
+
+## Quick start
+
+Declare a SQLAlchemy 2.x model and its state machine together:
+
+```python
+from typing import ClassVar
+
+from sqlalchemy import create_engine
+from sqlalchemy.orm import DeclarativeBase, Mapped, Session, mapped_column
+
+from sqlalchemy_state_machine import StateMachine, StateMachineMixin, Transition
+
+
+class Base(DeclarativeBase):
+    pass
+
+
+class Order(StateMachineMixin, Base):
+    __tablename__ = "orders"
+
+    id: Mapped[int] = mapped_column(primary_key=True)
+    status: Mapped[str] = mapped_column(nullable=False)
+
+    state_machine: ClassVar[StateMachine] = StateMachine(
+        state_attribute="status",
+        initial="draft",
+        transitions=(
+            Transition(name="submit", source="draft", target="submitted"),
+            Transition(
+                name="cancel",
+                source=("draft", "submitted"),
+                target="cancelled",
+            ),
+        ),
+    )
+
+
+engine = create_engine("sqlite://")
+Base.metadata.create_all(engine)
+
+with Session(engine) as session:
+    order = Order()
+    assert order.status == "draft"
+    assert order.can_transition("submit")
+    assert order.available_transitions() == ("submit", "cancel")
+    assert order.transition("submit") == "submitted"
+
+    session.add(order)
+    session.commit()
+```
+
+`transition(name)` applies a declared transition and returns its target state.
+`can_transition(name)` reports whether a transition is currently available, and
+`available_transitions()` returns available names in declaration order. Calling
+an unknown or unavailable transition raises `InvalidTransitionError`:
+
+```python
+from sqlalchemy_state_machine import InvalidTransitionError
+
+try:
+    order.transition("submit")
+except InvalidTransitionError:
+    pass
+```
+
+## Callbacks and transactions
+
+A `Transition` can define `before` and `after` callbacks. Both receive
+`(model, transition)`. The `before` callback runs while the model has its
+source state, the state is then changed, and the `after` callback runs with the
+target state. If either callback raises, the model state is restored to its
+original value and the exception is re-raised.
+
+The library changes only the mapped state attribute. It owns no SQLAlchemy
+session `flush`, `commit`, or `rollback`; application code controls transaction
+boundaries.
+
+## Migrating from 1.x
+
+2.0 is a breaking rewrite for Python 3.11+ and SQLAlchemy 2.x.
+
+| 1.x | 2.0 |
+| --- | --- |
+| `StateConfig` | `StateMachine` and `Transition` |
+| `StateMixin` | `StateMachineMixin` |
+| Manual SQLAlchemy init/load events | No longer needed |
+| Dynamic `model.set_sent()` | `model.transition("set_sent")` |
+| Redundant declared states | Inferred from the initial state and transitions |
+| `after_state_change` | Per-transition `before` and `after` callbacks |
+
+The legacy API and its `transitions` dependency were removed; update models to
+the explicit 2.0 API rather than mixing 1.x declarations with 2.0 classes.
+
+## Example
+
+Run the standalone example:
+
+```console
+uv run python examples/basic_usage.py
+```
+
+## Development
+
+```console
+uv sync
+uv run ruff format --check src tests examples
+uv run ruff check src tests examples
+uv run mypy src
+uv run pytest --cov=sqlalchemy_state_machine
+uv build
+```
+
+## License
+
+sqlalchemy-state-machine is distributed under the Apache License 2.0.