invariants 0.1.0__tar.gz

invariants-0.1.0/.gitignore

@@ -0,0 +1,217 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Sketch visualizer (auto-cloned by `python -m invariants.viz serve`)
+.sketch/
+
+# Cosmic Ray mutation testing
+mutation.sqlite
+mutation-report.html
+
+# Claude files
+.claude/

invariants-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nick Khitrov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

invariants-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.5
+Name: invariants
+Version: 0.1.0
+Summary: Type-safe state modeling for Python — split entity invariants into validated, immutable state classes with Pydantic
+Project-URL: Homepage, https://github.com/nkhitrov/invariants
+Project-URL: Repository, https://github.com/nkhitrov/invariants
+Project-URL: Issues, https://github.com/nkhitrov/invariants/issues
+Author-email: Nick Khitrov <khitrov34@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: immutable,invariants,pydantic,state,state-machine,typing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pydantic>=2.12.4
+Provides-Extra: factories
+Requires-Dist: polyfactory>=3.0.0; extra == 'factories'
+Requires-Dist: sqlalchemy>=2.0.44; extra == 'factories'
+Description-Content-Type: text/markdown
+
+# invariants
+
+[![PyPI](https://img.shields.io/pypi/v/invariants)](https://pypi.org/project/invariants/)
+[![Python](https://img.shields.io/pypi/pyversions/invariants)](https://pypi.org/project/invariants/)
+[![License](https://img.shields.io/github/license/nkhitrov/invariants)](https://github.com/nkhitrov/invariants/blob/main/LICENSE)
+
+Type-safe state modeling for Python. Split entity invariants into separate, validated, immutable state classes using Pydantic.
+
+## Why?
+
+When an entity has multiple states, each state often has different field requirements. Typically, this is modeled with optional fields and runtime checks. **invariants** enforces these constraints at the type level:
+
+- Each state is a separate class with its own field types
+- A metaclass ensures child states override all abstract fields and don't add new ones
+- All states are immutable
+- `StateMachine` defines valid transitions with type-safe signatures
+
+## Installation
+
+```bash
+pip install invariants
+```
+
+## Quick Start
+
+Define a root state with `Statefull` fields (abstract markers), then create concrete states that override them:
+
+```python
+from datetime import datetime
+from typing import Literal
+
+from invariants.state import State, Statefull, StateMachine
+
+
+class LoanState(State):
+    id: int
+    status: Statefull
+    postponement_date: Statefull
+
+
+class ActiveLoan(LoanState):
+    status: Literal["active"] = "active"
+    postponement_date: datetime
+
+
+class ClosedLoan(LoanState):
+    status: Literal["closed"] = "closed"
+    postponement_date: None = None
+
+
+class OverdueLoan(LoanState):
+    status: Literal["overdue"] = "overdue"
+    postponement_date: datetime
+```
+
+The metaclass enforces two rules at class creation time:
+1. Child states **cannot add new fields** — only override parent fields
+2. Child states **must override all `Statefull` fields** with concrete types
+
+Define state transitions with `StateMachine`:
+
+```python
+class CloseLoan(StateMachine[LoanState]):
+    def execute(self, loan: ActiveLoan | OverdueLoan) -> ClosedLoan:
+        return ClosedLoan(id=loan.id)
+
+
+class MakeLoanOverdue(StateMachine[LoanState]):
+    def execute(self, loan: ActiveLoan) -> OverdueLoan:
+        return OverdueLoan(id=loan.id, postponement_date=loan.postponement_date)
+```
+
+The `execute` method signature documents which transitions are valid — from which states to which.
+
+## Nested States
+
+States can contain other states. Use `ContainsOne` to validate that a collection includes at least one instance of a specific type:
+
+```python
+from typing import Annotated, Literal
+from invariants.conditions import ContainsOne
+
+
+class DebtState(State):
+    status: Statefull
+    loans: Statefull
+
+
+class ActiveDebt(DebtState):
+    status: Literal["active"] = "active"
+    loans: Annotated[tuple[ActiveLoan | ClosedLoan, ...], ContainsOne(ActiveLoan)]
+
+
+class ClosedDebt(DebtState):
+    status: Literal["closed"] = "closed"
+    loans: tuple[ClosedLoan, ...]
+
+
+class OverdueDebt(DebtState):
+    status: Literal["overdue"] = "overdue"
+    loans: Annotated[
+        tuple[OverdueLoan | ActiveLoan | ClosedLoan, ...], ContainsOne(OverdueLoan)
+    ]
+```
+
+`ActiveDebt` guarantees at compile time that it only contains active or closed loans, and at runtime that at least one is active.
+
+## Factories (Testing)
+
+Optional integration with [polyfactory](https://github.com/litestar-org/polyfactory) for generating test data. The key idea: **a factory always produces a valid state** — all business invariants are satisfied automatically.
+
+```bash
+pip install invariants[factories]
+```
+
+Define factories for concrete states — the model is inferred from the generic argument:
+
+```python
+from invariants.factories import StateFactory
+
+
+class ActiveLoanFactory(StateFactory[ActiveLoan]): ...
+class ClosedLoanFactory(StateFactory[ClosedLoan]): ...
+class ActiveDebtFactory(StateFactory[ActiveDebt]): ...
+```
+
+When you build a nested state, child entities are generated automatically:
+
+```python
+debt = ActiveDebtFactory.build()
+
+# loans are auto-populated with valid ActiveLoan | ClosedLoan instances
+# ContainsOne(ActiveLoan) is always satisfied — at least one loan is active
+assert any(isinstance(loan, ActiveLoan) for loan in debt.loans)
+```
+
+### SQLAlchemy Integration
+
+`SQLAlchemyStateFactory` maps Pydantic states to ORM models — `build()` returns ORM instances instead of Pydantic models:
+
+```python
+from invariants.factories.sqlalchemy import SQLAlchemyStateFactory
+
+
+class ActiveLoanORMFactory(SQLAlchemyStateFactory[ActiveLoan, LoanORM]): ...
+
+loan = ActiveLoanORMFactory.build()
+assert isinstance(loan, LoanORM)  # ORM instance, not Pydantic model
+```
+
+Both `StateFactory` and `SQLAlchemyStateFactory` are thin wrappers over [polyfactory](https://polyfactory.litestar.dev/) — all interfaces (sessions, persistence, batch creation) work the same as in the polyfactory docs.
+
+## XState Visualization
+
+Generate [XState v5](https://stately.ai/docs/xstate) state machine code from your `StateMachine` subclasses:
+
+```bash
+# Print generated JS — paste it into https://sketch.stately.ai
+python -m invariants.viz print examples.debt
+
+# Start a local Stately Sketch with one document per state machine
+# (clones https://github.com/statelyai/sketch on first run; needs Node.js with pnpm or npx)
+python -m invariants.viz serve examples.debt
+```
+
+`serve` opens each machine in the browser
+
+![img.png](docs/img.png)

invariants-0.1.0/README.md

@@ -0,0 +1,168 @@
+# invariants
+
+[![PyPI](https://img.shields.io/pypi/v/invariants)](https://pypi.org/project/invariants/)
+[![Python](https://img.shields.io/pypi/pyversions/invariants)](https://pypi.org/project/invariants/)
+[![License](https://img.shields.io/github/license/nkhitrov/invariants)](https://github.com/nkhitrov/invariants/blob/main/LICENSE)
+
+Type-safe state modeling for Python. Split entity invariants into separate, validated, immutable state classes using Pydantic.
+
+## Why?
+
+When an entity has multiple states, each state often has different field requirements. Typically, this is modeled with optional fields and runtime checks. **invariants** enforces these constraints at the type level:
+
+- Each state is a separate class with its own field types
+- A metaclass ensures child states override all abstract fields and don't add new ones
+- All states are immutable
+- `StateMachine` defines valid transitions with type-safe signatures
+
+## Installation
+
+```bash
+pip install invariants
+```
+
+## Quick Start
+
+Define a root state with `Statefull` fields (abstract markers), then create concrete states that override them:
+
+```python
+from datetime import datetime
+from typing import Literal
+
+from invariants.state import State, Statefull, StateMachine
+
+
+class LoanState(State):
+    id: int
+    status: Statefull
+    postponement_date: Statefull
+
+
+class ActiveLoan(LoanState):
+    status: Literal["active"] = "active"
+    postponement_date: datetime
+
+
+class ClosedLoan(LoanState):
+    status: Literal["closed"] = "closed"
+    postponement_date: None = None
+
+
+class OverdueLoan(LoanState):
+    status: Literal["overdue"] = "overdue"
+    postponement_date: datetime
+```
+
+The metaclass enforces two rules at class creation time:
+1. Child states **cannot add new fields** — only override parent fields
+2. Child states **must override all `Statefull` fields** with concrete types
+
+Define state transitions with `StateMachine`:
+
+```python
+class CloseLoan(StateMachine[LoanState]):
+    def execute(self, loan: ActiveLoan | OverdueLoan) -> ClosedLoan:
+        return ClosedLoan(id=loan.id)
+
+
+class MakeLoanOverdue(StateMachine[LoanState]):
+    def execute(self, loan: ActiveLoan) -> OverdueLoan:
+        return OverdueLoan(id=loan.id, postponement_date=loan.postponement_date)
+```
+
+The `execute` method signature documents which transitions are valid — from which states to which.
+
+## Nested States
+
+States can contain other states. Use `ContainsOne` to validate that a collection includes at least one instance of a specific type:
+
+```python
+from typing import Annotated, Literal
+from invariants.conditions import ContainsOne
+
+
+class DebtState(State):
+    status: Statefull
+    loans: Statefull
+
+
+class ActiveDebt(DebtState):
+    status: Literal["active"] = "active"
+    loans: Annotated[tuple[ActiveLoan | ClosedLoan, ...], ContainsOne(ActiveLoan)]
+
+
+class ClosedDebt(DebtState):
+    status: Literal["closed"] = "closed"
+    loans: tuple[ClosedLoan, ...]
+
+
+class OverdueDebt(DebtState):
+    status: Literal["overdue"] = "overdue"
+    loans: Annotated[
+        tuple[OverdueLoan | ActiveLoan | ClosedLoan, ...], ContainsOne(OverdueLoan)
+    ]
+```
+
+`ActiveDebt` guarantees at compile time that it only contains active or closed loans, and at runtime that at least one is active.
+
+## Factories (Testing)
+
+Optional integration with [polyfactory](https://github.com/litestar-org/polyfactory) for generating test data. The key idea: **a factory always produces a valid state** — all business invariants are satisfied automatically.
+
+```bash
+pip install invariants[factories]
+```
+
+Define factories for concrete states — the model is inferred from the generic argument:
+
+```python
+from invariants.factories import StateFactory
+
+
+class ActiveLoanFactory(StateFactory[ActiveLoan]): ...
+class ClosedLoanFactory(StateFactory[ClosedLoan]): ...
+class ActiveDebtFactory(StateFactory[ActiveDebt]): ...
+```
+
+When you build a nested state, child entities are generated automatically:
+
+```python
+debt = ActiveDebtFactory.build()
+
+# loans are auto-populated with valid ActiveLoan | ClosedLoan instances
+# ContainsOne(ActiveLoan) is always satisfied — at least one loan is active
+assert any(isinstance(loan, ActiveLoan) for loan in debt.loans)
+```
+
+### SQLAlchemy Integration
+
+`SQLAlchemyStateFactory` maps Pydantic states to ORM models — `build()` returns ORM instances instead of Pydantic models:
+
+```python
+from invariants.factories.sqlalchemy import SQLAlchemyStateFactory
+
+
+class ActiveLoanORMFactory(SQLAlchemyStateFactory[ActiveLoan, LoanORM]): ...
+
+loan = ActiveLoanORMFactory.build()
+assert isinstance(loan, LoanORM)  # ORM instance, not Pydantic model
+```
+
+Both `StateFactory` and `SQLAlchemyStateFactory` are thin wrappers over [polyfactory](https://polyfactory.litestar.dev/) — all interfaces (sessions, persistence, batch creation) work the same as in the polyfactory docs.
+
+## XState Visualization
+
+Generate [XState v5](https://stately.ai/docs/xstate) state machine code from your `StateMachine` subclasses:
+
+```bash
+# Print generated JS — paste it into https://sketch.stately.ai
+python -m invariants.viz print examples.debt
+
+# Start a local Stately Sketch with one document per state machine
+# (clones https://github.com/statelyai/sketch on first run; needs Node.js with pnpm or npx)
+python -m invariants.viz serve examples.debt
+```
+
+`serve` opens each machine in the browser
+
+![img.png](docs/img.png)

invariants-0.1.0/invariants/conditions.py

@@ -0,0 +1,20 @@
+from typing import Any
+
+from pydantic import AfterValidator
+
+
+class ContainsOne(AfterValidator):
+    required_type: type
+
+    def __init__(self, obj: Any):
+        super().__init__(self.validator(obj))
+        object.__setattr__(self, "required_type", obj)
+
+    @staticmethod
+    def validator(obj: Any) -> Any:
+        def validate(value: Any) -> Any:
+            if not any(o for o in value if isinstance(o, obj)):
+                raise ValueError(f"must contains one or more item of type `{obj}`")
+            return value
+
+        return validate

invariants-0.1.0/invariants/factories/__init__.py

@@ -0,0 +1,4 @@
+from invariants.factories.state import StateFactory
+
+
+__all__ = ["StateFactory"]