csrd-lifespan 0.1.0__tar.gz

csrd_lifespan-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_lifespan-0.1.0/PKG-INFO

@@ -0,0 +1,10 @@
+Metadata-Version: 2.4
+Name: csrd-lifespan
+Version: 0.1.0
+Summary: Lifespan stack utilities 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/lifespan
+Project-URL: Changelog, https://github.com/csrd-api/fastapi-common/blob/main/CHANGELOG.md
+License: MIT
+Requires-Python: >=3.12
+Requires-Dist: fastapi<1,>=0.115

csrd_lifespan-0.1.0/README.md

@@ -0,0 +1,21 @@
+# csrd-lifespan
+
+Composable lifespan stack for FastAPI applications.
+
+**Package**: `csrd.lifespan` · **Import**: `from csrd.lifespan import lifespan_stack`
+
+## What's included
+
+- `lifespan_stack` — register multiple async context managers as a single FastAPI lifespan
+- Merges yielded state dicts from all lifespan functions
+- Supports nested lists of lifespan functions
+
+## Installation
+
+```bash
+uv pip install "csrd-lifespan @ git+ssh://git@github.com/csrd-api/fastapi-common.git#subdirectory=packages/lifespan"
+```
+
+## Dependencies
+
+None (Tier 1 — standalone)

csrd_lifespan-0.1.0/pyproject.toml

@@ -0,0 +1,21 @@
+[project]
+name = "csrd-lifespan"
+version = "0.1.0"
+description = "Lifespan stack utilities for FastAPI"
+license = { text = "MIT" }
+requires-python = ">=3.12"
+dependencies = [
+    "fastapi>=0.115,<1",
+]
+
+[project.urls]
+Repository = "https://github.com/csrd-api/fastapi-common"
+Documentation = "https://github.com/csrd-api/fastapi-common/tree/main/packages/lifespan"
+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"]

csrd_lifespan-0.1.0/src/csrd/lifespan/__init__.py

@@ -0,0 +1,3 @@
+from .lifespan_stack import lifespan_stack
+
+__all__ = ("lifespan_stack",)

csrd_lifespan-0.1.0/src/csrd/lifespan/lifespan_stack.py

@@ -0,0 +1,57 @@
+import warnings
+from collections.abc import AsyncIterator, Callable, Mapping
+from contextlib import AbstractAsyncContextManager, AsyncExitStack, asynccontextmanager
+from typing import Any
+
+from fastapi import FastAPI
+
+LifespanFunction = Callable[[FastAPI], AbstractAsyncContextManager[Mapping[str, Any] | None]]
+
+
+def _callable_name(callable_: Callable[..., Any]) -> str:
+    try:
+        return callable_.__name__
+    except AttributeError:
+        return getattr(type(callable_), "__name__", repr(callable_))
+
+
+def _normalize(
+    functions: tuple[LifespanFunction | list[LifespanFunction], ...],
+) -> list[LifespanFunction]:
+    collector: list[LifespanFunction] = []
+    for function in functions:
+        if isinstance(function, list):
+            collector.extend(function)
+        else:
+            collector.append(function)
+
+    return collector
+
+
+class lifespan_stack:
+    def __init__(self, *lifespan_functions: LifespanFunction | list[LifespanFunction]) -> None:
+        self._lifespan_functions = _normalize(lifespan_functions)
+
+    @asynccontextmanager
+    async def __call__(self, app: FastAPI) -> AsyncIterator[dict[str, Any]]:
+        state: dict[str, Any] = {}
+        async with AsyncExitStack() as exit_stack:
+            for lifespan_function in self._lifespan_functions:
+                result = await exit_stack.enter_async_context(lifespan_function(app))
+
+                # If the lifespan function yielded None then it doesnt need to store anything in state
+                if result is None:
+                    continue
+
+                if isinstance(result, Mapping):
+                    state |= result
+                else:
+                    warnings.warn(
+                        f"Unexpected value from lifespan {_callable_name(lifespan_function)!r}: {result!r}",
+                        stacklevel=2,
+                    )
+
+            yield state
+
+
+__all__ = ("lifespan_stack",)

csrd_lifespan-0.1.0/tests/test_lifespan_stack.py

@@ -0,0 +1,87 @@
+"""Tests for lifespan_stack."""
+
+import warnings
+from contextlib import asynccontextmanager
+
+import pytest
+from fastapi import FastAPI
+
+from csrd.lifespan.lifespan_stack import lifespan_stack
+
+
+@asynccontextmanager
+async def db_lifespan(app: FastAPI):
+    app.state.db = "connected"
+    yield {"db": "connected"}
+    app.state.db = None
+
+
+@asynccontextmanager
+async def cache_lifespan(app: FastAPI):
+    yield {"cache": "ready"}
+
+
+@asynccontextmanager
+async def void_lifespan(app: FastAPI):
+    yield  # yields None — no state to merge
+
+
+@asynccontextmanager
+async def bad_lifespan(app: FastAPI):
+    yield "not_a_mapping"  # should trigger warning
+
+
+class TestLifespanStack:
+    @pytest.mark.asyncio
+    async def test_single_lifespan(self):
+        app = FastAPI()
+        stack = lifespan_stack(db_lifespan)
+        async with stack(app) as state:
+            assert state == {"db": "connected"}
+
+    @pytest.mark.asyncio
+    async def test_multiple_lifespans(self):
+        app = FastAPI()
+        stack = lifespan_stack(db_lifespan, cache_lifespan)
+        async with stack(app) as state:
+            assert state == {"db": "connected", "cache": "ready"}
+
+    @pytest.mark.asyncio
+    async def test_void_lifespan_skipped(self):
+        app = FastAPI()
+        stack = lifespan_stack(void_lifespan, db_lifespan)
+        async with stack(app) as state:
+            assert state == {"db": "connected"}
+
+    @pytest.mark.asyncio
+    async def test_bad_lifespan_warns(self):
+        app = FastAPI()
+        stack = lifespan_stack(bad_lifespan)
+        with warnings.catch_warnings(record=True) as w:
+            warnings.simplefilter("always")
+            async with stack(app) as state:
+                assert state == {}
+            assert len(w) == 1
+            assert "Unexpected value" in str(w[0].message)
+
+    @pytest.mark.asyncio
+    async def test_nested_list_flattening(self):
+        app = FastAPI()
+        stack = lifespan_stack([db_lifespan, cache_lifespan])
+        async with stack(app) as state:
+            assert state == {"db": "connected", "cache": "ready"}
+
+    @pytest.mark.asyncio
+    async def test_empty_stack(self):
+        app = FastAPI()
+        stack = lifespan_stack()
+        async with stack(app) as state:
+            assert state == {}
+
+    @pytest.mark.asyncio
+    async def test_cleanup_runs_on_exit(self):
+        app = FastAPI()
+        stack = lifespan_stack(db_lifespan)
+        async with stack(app):
+            assert app.state.db == "connected"
+        assert app.state.db is None