csrd-versioning 0.1.0__tar.gz

csrd_versioning-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__/
+
+*.db
+
+
+# Import linter cache
+.import_linter_cache/
+
+# IDE
+.idea/
+.idea/*

csrd_versioning-0.1.0/PKG-INFO

@@ -0,0 +1,15 @@
+Metadata-Version: 2.4
+Name: csrd-versioning
+Version: 0.1.0
+Summary: API versioning, dispatch, docs, and actuator for FastAPI
+Project-URL: Repository, https://github.com/csrd-api/fastapi-common
+Project-URL: Documentation, https://github.com/csrd-api/fastapi-common/tree/main/packages/versioning
+Project-URL: Changelog, https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: csrd-context
+Requires-Dist: csrd-models
+Requires-Dist: fastapi<1,>=0.115
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic-settings<3,>=2
+Requires-Dist: pydantic<3,>=2

csrd_versioning-0.1.0/README.md

@@ -0,0 +1,55 @@
+# csrd-versioning
+
+API versioning, dispatch, docs, and actuator for FastAPI.
+
+**Package**: `csrd.versioning` · **Import**: `from csrd.versioning import create_versioned_app, configure_versioned_api`
+
+## What's included
+
+- **Version dispatch** — raw ASGI middleware for version-aware routing (streaming/SSE safe)
+- **Swagger UI** — custom docs with version picker, dark mode, SRI hashes, plugin system
+- **Actuator** — Spring Boot-style management endpoints (health, info, env)
+- **Exception handlers** — structured `APIErrorResponse` JSON for HTTP and validation errors
+- **Dependency wiring** — auto path-param injection, bearer guard opt-out
+
+## Installation
+
+```bash
+uv pip install "csrd-versioning @ git+ssh://git@github.com/csrd-api/fastapi-common.git#subdirectory=packages/versioning"
+```
+
+## Quick start
+
+```python
+from enum import Enum
+from fastapi import FastAPI
+from csrd.versioning import create_versioned_app
+
+class Versions(Enum):
+    Unversioned = "Unversioned"
+    V1 = "2025-06-20"
+
+unv = FastAPI()
+v1 = FastAPI()
+
+app = create_versioned_app(
+    {Versions.Unversioned: unv, Versions.V1: v1},
+    prefix="api",
+)
+```
+
+## Security notes
+
+- **`/actuator/env`**: The `ShowValues.ALWAYS` setting exposes environment variable values. Use `ShowValues.NEVER` (default) in production to redact sensitive data.
+- **CORS**: Add `CORSMiddleware` **before** calling `configure_versioned_api`. The version dispatch middleware must be the outermost middleware. Example:
+
+```python
+app = FastAPI()
+app.add_middleware(CORSMiddleware, allow_origins=["*"], ...)
+configure_versioned_api(app, version_mapping, ...)
+```
+
+## Dependencies
+
+- `csrd-models`, `csrd-context` (Tier 3 — depends on Tier 1 packages)
+- For JWT auth, use [`csrd-auth`](../auth/README.md) alongside this package

csrd_versioning-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "csrd-versioning"
+version = "0.1.0"
+description = "API versioning, dispatch, docs, and actuator for FastAPI"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi>=0.115,<1",
+    "httpx>=0.27,<1",
+    "pydantic>=2,<3",
+    "pydantic-settings>=2,<3",
+    "csrd-context",
+    "csrd-models",
+]
+
+[project.urls]
+Repository = "https://github.com/csrd-api/fastapi-common"
+Documentation = "https://github.com/csrd-api/fastapi-common/tree/main/packages/versioning"
+Changelog = "https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/csrd"]
+
+[tool.uv.sources]
+csrd-context = { workspace = true }
+csrd-models = { workspace = true }

csrd_versioning-0.1.0/src/csrd/versioning/__init__.py

@@ -0,0 +1,99 @@
+"""API versioning, dispatch, docs, and actuator for FastAPI."""
+
+from ._constants import (
+    API_VERSION_HEADER_NAME,
+    APP_ID_HEADER_NAME,
+    AUTH_HEADER_NAME,
+    HIT_ID_HEADER_NAME,
+    HTTP_METHODS,
+    UNVERSIONED,
+    UNVERSIONED_DISPLAY_LABEL,
+    VERSIONING_SETTINGS_STATE_KEY,
+)
+from ._core import (
+    map_version_path,
+    normalize_prefix,
+    normalize_unversioned_label,
+    normalize_version,
+    resolve_prefix,
+    resolve_version,
+    validate_version_mapping_keys,
+)
+from ._dependencies import (
+    ApiVersionDep,
+    AppIdDep,
+    HitIdDep,
+    param_factory,
+    uuid_id_factory,
+)
+from ._fastapi_types import (
+    ExceptionHandlerProvider,
+    ExHandler,
+    Middleware,
+    NormalizedDependencySpec,
+    PathParamDependencies,
+    PathParamDependencySpec,
+    VersionedAppConfigurer,
+    VersionedAppLifespan,
+)
+from ._helpers import (
+    HeadersGetter,
+    find_bearer,
+    find_token,
+)
+from ._orchestration import (
+    configure_versioned_api,
+    create_versioned_app,
+    default_exception_handlers_provider,
+    get_current_user_claims,
+)
+from ._settings import VersioningSettings, load_app_name, load_versioning_settings
+from ._swagger_ui_version import SWAGGER_UI_VERSION
+from ._types import VersionedAppState, VersionKey, VersionMap
+from .actuator import register_actuator_router
+
+__all__ = (
+    "API_VERSION_HEADER_NAME",
+    "APP_ID_HEADER_NAME",
+    "AUTH_HEADER_NAME",
+    "HIT_ID_HEADER_NAME",
+    "HTTP_METHODS",
+    "SWAGGER_UI_VERSION",
+    "UNVERSIONED",
+    "UNVERSIONED_DISPLAY_LABEL",
+    "VERSIONING_SETTINGS_STATE_KEY",
+    "ApiVersionDep",
+    "AppIdDep",
+    "ExHandler",
+    "ExceptionHandlerProvider",
+    "HeadersGetter",
+    "HitIdDep",
+    "Middleware",
+    "NormalizedDependencySpec",
+    "PathParamDependencies",
+    "PathParamDependencySpec",
+    "VersionKey",
+    "VersionMap",
+    "VersionedAppConfigurer",
+    "VersionedAppLifespan",
+    "VersionedAppState",
+    "VersioningSettings",
+    "configure_versioned_api",
+    "create_versioned_app",
+    "default_exception_handlers_provider",
+    "find_bearer",
+    "find_token",
+    "get_current_user_claims",
+    "load_app_name",
+    "load_versioning_settings",
+    "map_version_path",
+    "normalize_prefix",
+    "normalize_unversioned_label",
+    "normalize_version",
+    "param_factory",
+    "register_actuator_router",
+    "resolve_prefix",
+    "resolve_version",
+    "uuid_id_factory",
+    "validate_version_mapping_keys",
+)

csrd_versioning-0.1.0/src/csrd/versioning/_constants.py

@@ -0,0 +1,28 @@
+from csrd.context._constants import APP_ID_HEADER_NAME, HIT_ID_HEADER_NAME
+
+AUTH_HEADER_NAME = "authorization"
+API_VERSION_HEADER_NAME = "x-api-version"
+VERSIONING_SETTINGS_STATE_KEY = "_versioning_settings"
+UNVERSIONED_DISPLAY_LABEL = "Unversioned"
+UNVERSIONED = "unv"
+"""Sentinel for unversioned routes in version mappings.
+
+Use as a key in ``version_mapping`` or as the ``default_version`` argument
+to indicate routes that do not belong to any numbered API version.
+This is the canonical normalized form — ``normalize_version(None)``
+and ``normalize_version("unversioned")`` both produce this value.
+"""
+
+HTTP_METHODS = frozenset({"get", "post", "put", "delete", "patch", "options", "head"})
+
+
+__all__ = (
+    "API_VERSION_HEADER_NAME",
+    "APP_ID_HEADER_NAME",
+    "AUTH_HEADER_NAME",
+    "HIT_ID_HEADER_NAME",
+    "HTTP_METHODS",
+    "UNVERSIONED",
+    "UNVERSIONED_DISPLAY_LABEL",
+    "VERSIONING_SETTINGS_STATE_KEY",
+)

csrd_versioning-0.1.0/src/csrd/versioning/_core.py

@@ -0,0 +1,240 @@
+import logging
+import re
+from enum import Enum
+
+from ._constants import UNVERSIONED_DISPLAY_LABEL
+from ._types import VersionKey, VersionMap
+
+logger = logging.getLogger(__name__)
+
+_UNVERSIONED_ALIASES: frozenset[str] = frozenset({"null", "unv", "none", "unversioned"})
+
+
+def normalize_version(version: VersionKey) -> str:
+    """Normalize version-like values to lowercase canonical routing keys.
+
+    - ``Enum`` members are unwrapped via ``.value`` before normalization.
+    - ``None``, empty strings, whitespace-only strings, and the aliases
+      ``"null"``, ``"unv"``, ``"none"``, ``"unversioned"`` (case-insensitive)
+      all normalize to ``"unv"``.
+    - All other values are stripped, then lowercased via ``str(version).lower()``,
+      including bare integers (e.g. ``3`` → ``"3"``).
+    """
+    if isinstance(version, Enum):
+        version = version.value
+    stringified = str(version).strip() if version is not None else ""
+    if version is None or not stringified or stringified.lower() in _UNVERSIONED_ALIASES:
+        return "unv"
+    return stringified.lower()
+
+
+def normalize_prefix(prefix: str) -> str:
+    """Return an API prefix guaranteed to start with ``/``.
+
+    Raises ``ValueError`` for empty strings — use ``"/"`` explicitly
+    if you intend to match all paths.
+    """
+    if not prefix:
+        raise ValueError("prefix must not be empty; pass '/' explicitly to match all paths")
+    normalized = prefix if prefix.startswith("/") else f"/{prefix}"
+    if normalized != "/":
+        normalized = normalized.rstrip("/")
+    return normalized
+
+
+def normalize_unversioned_label(version: VersionKey) -> str:
+    """Map unversioned-like keys to a stable display label."""
+    normalized = normalize_version(version)
+    if normalized == "unv":
+        return UNVERSIONED_DISPLAY_LABEL
+    return normalized
+
+
+def validate_version_mapping_keys(version_mapping: VersionMap) -> None:
+    """Ensure version keys do not collide after normalization."""
+    seen: dict[str, str] = {}
+    for key in version_mapping:
+        normalized = normalize_version(key)
+        if normalized in seen:
+            existing_key = seen[normalized]
+            raise ValueError(
+                "Duplicate version keys after normalization: "
+                f"{existing_key!r} and {key!r} both normalize to '{normalized}'."
+            )
+        seen[normalized] = str(key)
+
+
+def _latest_mapped_version(version_values: list[str]) -> str:
+    """Pick the latest mapped version deterministically.
+
+    Comparison uses only numeric segments (e.g. ``"v2"`` → ``(2,)``).
+    Non-numeric characters between digits are ignored, so versions
+    like ``"v1a2"`` and ``"v1b1"`` are compared as ``(1, 2)`` vs ``(1, 1)``.
+    """
+    candidates = [v for v in version_values if v != "unv"]
+    if not candidates:
+        return "unv"
+
+    numeric_candidates = [v for v in candidates if re.search(r"\d", v)]
+    if numeric_candidates:
+        return max(
+            numeric_candidates,
+            key=lambda value: (tuple(int(x) for x in re.findall(r"\d+", value)), value),
+        )
+
+    return sorted(candidates)[-1]
+
+
+def _default_mapped_version(
+    *, version_values: set[str], default_version: VersionKey | None
+) -> str | None:
+    """Return a normalized default version only when it exists in the mapping."""
+    if default_version is None:
+        return None
+
+    normalized_default = normalize_version(default_version)
+    if normalized_default in version_values:
+        return normalized_default
+
+    return None
+
+
+def _resolve_missing_requested_version(
+    *,
+    version_values: set[str],
+    mapped_default: str | None,
+) -> str:
+    """Resolve version when the request does not include a version header."""
+    if "unv" in version_values:
+        return "unv"
+
+    if mapped_default is not None:
+        return mapped_default
+
+    return _latest_mapped_version(list(version_values))
+
+
+def _resolve_unknown_requested_version(
+    *,
+    version_values: set[str],
+    mapped_default: str | None,
+) -> str:
+    """Resolve version when the request header is present but not mapped."""
+    if mapped_default is not None:
+        return mapped_default
+
+    if "unv" in version_values:
+        return "unv"
+
+    return _latest_mapped_version(list(version_values))
+
+
+def resolve_version(
+    *,
+    requested_version: str | None,
+    version_mapping: VersionMap | None = None,
+    default_version: VersionKey | None = None,
+    strict: bool = False,
+) -> str:
+    """Resolve request version using explicit, deterministic fallback precedence.
+
+    Fallback order when the requested version is not in *version_mapping*:
+
+    1. *default_version* (if provided and present in the mapping)
+    2. ``"unv"`` (if present in the mapping)
+    3. Latest numeric version
+
+    When *strict* is ``True``, an unrecognised requested version raises
+    ``ValueError`` instead of falling back.  Missing headers (``None``)
+    still fall back normally — strict mode only rejects explicit but
+    unknown version values.
+
+    .. important::
+
+    Raises ``ValueError`` if *version_mapping* keys collide after
+    normalization (e.g. ``None`` and ``"unversioned"`` both normalize
+    to ``"unv"``).
+    """
+    if version_mapping is None:
+        if requested_version is None:
+            return "unv"
+        return normalize_version(requested_version)
+
+    version_values = {normalize_version(key) for key in version_mapping}
+    if len(version_values) < len(version_mapping):
+        validate_version_mapping_keys(version_mapping)
+    mapped_default = _default_mapped_version(
+        version_values=version_values,
+        default_version=default_version,
+    )
+    requested_normalized = (
+        normalize_version(requested_version) if requested_version is not None else None
+    )
+
+    if requested_normalized in version_values:
+        return requested_normalized
+
+    if requested_normalized is None:
+        return _resolve_missing_requested_version(
+            version_values=version_values,
+            mapped_default=mapped_default,
+        )
+
+    if strict:
+        raise ValueError(
+            f"Requested API version {requested_normalized!r} is not available. "
+            f"Available versions: {', '.join(sorted(version_values))}"
+        )
+
+    resolved = _resolve_unknown_requested_version(
+        version_values=version_values,
+        mapped_default=mapped_default,
+    )
+    logger.warning(
+        "Requested API version %r is not mapped (available: %s); falling back to %r",
+        requested_normalized,
+        ", ".join(sorted(version_values)),
+        resolved,
+    )
+    return resolved
+
+
+def map_version_path(path: str, *, version: str, prefix: str) -> str:
+    """Rewrite an incoming path to include resolved version under the API prefix.
+
+    The prefix precondition is also enforced upstream by the dispatch guard
+    ``_should_dispatch_request``, but the check here is intentional
+    defense-in-depth — do not remove it.
+    """
+    if prefix == "/":
+        if not path.startswith("/"):
+            raise ValueError(f"path {path!r} does not start with prefix {prefix!r}")
+    elif not (path == prefix or path.startswith(f"{prefix}/")):
+        raise ValueError(f"path {path!r} does not start with prefix {prefix!r}")
+    normalized_version = normalize_version(version)
+    remainder = path[len(prefix) :]
+    if remainder and not remainder.startswith("/"):
+        remainder = f"/{remainder}"
+    # Normalize bare trailing slash so /api/ behaves identically to /api.
+    if remainder == "/":
+        remainder = ""
+    return f"{prefix.rstrip('/')}/{normalized_version}{remainder}"
+
+
+def resolve_prefix(prefix: str | None) -> str:
+    """Return normalized API prefix, defaulting to `/api`."""
+    if prefix is None:
+        prefix = "/api"
+
+    return normalize_prefix(prefix)
+
+
+__all__ = (
+    "map_version_path",
+    "normalize_prefix",
+    "normalize_unversioned_label",
+    "normalize_version",
+    "resolve_prefix",
+    "resolve_version",
+    "validate_version_mapping_keys",
+)