modern-di-flask 2.0.0__tar.gz

modern_di_flask-2.0.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: modern-di-flask
+Version: 2.0.0
+Summary: modern-di integration for Flask
+Keywords: dependency-injection,di,ioc-container,modern-di,flask,python
+Author: Artur Shiriev
+Author-email: Artur Shiriev <me@shiriev.ru>
+License-Expression: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3.10
+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: Typing :: Typed
+Classifier: Topic :: Software Development :: Libraries
+Requires-Dist: flask>=3,<4
+Requires-Dist: modern-di>=2.25,<3
+Requires-Python: >=3.10, <4
+Project-URL: Homepage, https://modern-di.modern-python.org
+Project-URL: Documentation, https://modern-di.modern-python.org
+Project-URL: Repository, https://github.com/modern-python/modern-di-flask
+Project-URL: Issues, https://github.com/modern-python/modern-di-flask/issues
+Project-URL: Changelog, https://github.com/modern-python/modern-di-flask/releases
+Description-Content-Type: text/markdown
+
+# modern-di-flask
+
+[Modern-DI](https://github.com/modern-python/modern-di) integration for [Flask](https://flask.palletsprojects.com).
+
+## Quickstart
+
+```python
+import typing
+
+from flask import Flask
+from modern_di import Container, Group, Scope, providers
+from modern_di_flask import FromDI, inject, setup_di
+
+
+class Settings:
+    def __init__(self) -> None:
+        self.greeting = "hello"
+
+
+class Dependencies(Group):
+    settings = providers.Factory(scope=Scope.APP, creator=Settings)
+
+
+app = Flask(__name__)
+
+
+@app.route("/hello/<name>")
+@inject
+def hello(name: str, settings: typing.Annotated[Settings, FromDI(Dependencies.settings)]) -> str:
+    return f"{settings.greeting}, {name}"
+
+
+# call setup_di AFTER registering routes (required for auto_inject)
+setup_di(app, Container(groups=[Dependencies], validate=True))
+```
+
+Pass `auto_inject=True` to `setup_di` to inject every view without a per-view
+`@inject`. See the [documentation](https://modern-di.modern-python.org).

modern_di_flask-2.0.0/README.md

@@ -0,0 +1,38 @@
+# modern-di-flask
+
+[Modern-DI](https://github.com/modern-python/modern-di) integration for [Flask](https://flask.palletsprojects.com).
+
+## Quickstart
+
+```python
+import typing
+
+from flask import Flask
+from modern_di import Container, Group, Scope, providers
+from modern_di_flask import FromDI, inject, setup_di
+
+
+class Settings:
+    def __init__(self) -> None:
+        self.greeting = "hello"
+
+
+class Dependencies(Group):
+    settings = providers.Factory(scope=Scope.APP, creator=Settings)
+
+
+app = Flask(__name__)
+
+
+@app.route("/hello/<name>")
+@inject
+def hello(name: str, settings: typing.Annotated[Settings, FromDI(Dependencies.settings)]) -> str:
+    return f"{settings.greeting}, {name}"
+
+
+# call setup_di AFTER registering routes (required for auto_inject)
+setup_di(app, Container(groups=[Dependencies], validate=True))
+```
+
+Pass `auto_inject=True` to `setup_di` to inject every view without a per-view
+`@inject`. See the [documentation](https://modern-di.modern-python.org).

modern_di_flask-2.0.0/modern_di_flask/__init__.py

@@ -0,0 +1,10 @@
+from modern_di_flask.main import FromDI, fetch_di_container, flask_request_provider, inject, setup_di
+
+
+__all__ = [
+    "FromDI",
+    "fetch_di_container",
+    "flask_request_provider",
+    "inject",
+    "setup_di",
+]

modern_di_flask-2.0.0/modern_di_flask/main.py

@@ -0,0 +1,96 @@
+import dataclasses
+import functools
+import typing
+
+import flask
+from flask import Flask, Request, g
+from modern_di import Container, Scope, providers
+
+
+flask_request_provider = providers.ContextProvider(Request, scope=Scope.REQUEST)
+_CONNECTION_PROVIDERS = (flask_request_provider,)
+
+# Root container on ``app.extensions``; per-request child on ``flask.g``. Named
+# constants keep each writer and reader in provable agreement.
+_ROOT_CONTAINER_KEY = "modern_di_container"
+_CHILD_CONTAINER_ATTR = "modern_di_request_container"
+
+
+def fetch_di_container(app: Flask) -> Container:
+    return typing.cast(Container, app.extensions[_ROOT_CONTAINER_KEY])
+
+
+def _close_request(_exception: BaseException | None) -> None:
+    child: Container | None = getattr(g, _CHILD_CONTAINER_ATTR, None)
+    if child is not None:
+        child.close_sync()
+
+
+def setup_di(app: Flask, container: Container, *, auto_inject: bool = False) -> Container:
+    app.extensions[_ROOT_CONTAINER_KEY] = container
+    container.add_providers(*_CONNECTION_PROVIDERS)
+
+    def _enter_request() -> None:
+        child = container.build_child_container(
+            scope=Scope.REQUEST,
+            context={Request: flask.request._get_current_object()},  # noqa: SLF001  # ty: ignore[unresolved-attribute]
+        )
+        setattr(g, _CHILD_CONTAINER_ATTR, child)
+
+    app.before_request(_enter_request)
+    app.teardown_appcontext(_close_request)
+    if auto_inject:
+        _inject_views(app)
+    return container
+
+
+def _inject_views(app: Flask) -> None:
+    # Flask registers every dispatched view (app routes and blueprint routes,
+    # the latter under dotted endpoints like "bp.view") in ``app.view_functions``
+    # and always dispatches through it, so wrapping that one registry covers all.
+    for endpoint, view in list(app.view_functions.items()):
+        if not getattr(view, "__modern_di_injected__", False):
+            app.view_functions[endpoint] = inject(view)  # ty: ignore[invalid-assignment]
+
+
+T = typing.TypeVar("T")
+T_co = typing.TypeVar("T_co", covariant=True)
+
+
+@dataclasses.dataclass(slots=True, frozen=True)
+class _FromDI(typing.Generic[T_co]):
+    dependency: providers.AbstractProvider[T_co] | type[T_co]
+
+
+def FromDI(dependency: providers.AbstractProvider[T] | type[T], /) -> T:  # noqa: N802
+    return typing.cast(T, _FromDI(dependency))
+
+
+def _parse_inject_params(func: typing.Callable[..., typing.Any]) -> dict[str, _FromDI[typing.Any]]:
+    hints = typing.get_type_hints(func, include_extras=True)
+    di_params: dict[str, _FromDI[typing.Any]] = {}
+    for name, hint in hints.items():
+        if name == "return":
+            continue
+        if typing.get_origin(hint) is typing.Annotated:
+            for meta in typing.get_args(hint)[1:]:
+                if isinstance(meta, _FromDI):
+                    di_params[name] = meta
+                    break
+    return di_params
+
+
+def inject(func: typing.Callable[..., T]) -> typing.Callable[..., T]:
+    di_params = _parse_inject_params(func)
+    if not di_params:
+        func.__modern_di_injected__ = True  # ty: ignore[unresolved-attribute]
+        return func
+
+    @functools.wraps(func)
+    def wrapper(*args: typing.Any, **kwargs: typing.Any) -> T:  # noqa: ANN401
+        child: Container = getattr(g, _CHILD_CONTAINER_ATTR)
+        resolved = {name: child.resolve_dependency(marker.dependency) for name, marker in di_params.items()}
+        return func(*args, **kwargs, **resolved)
+
+    wrapper.__modern_di_injected__ = True  # ty: ignore[unresolved-attribute]
+    return wrapper

modern_di_flask-2.0.0/pyproject.toml

@@ -0,0 +1,81 @@
+[project]
+name = "modern-di-flask"
+description = "modern-di integration for Flask"
+authors = [{ name = "Artur Shiriev", email = "me@shiriev.ru" }]
+requires-python = ">=3.10,<4"
+license = "MIT"
+readme = "README.md"
+keywords = ["dependency-injection", "di", "ioc-container", "modern-di", "flask", "python"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Typing :: Typed",
+    "Topic :: Software Development :: Libraries",
+]
+dependencies = ["flask>=3,<4", "modern-di>=2.25,<3"]
+version = "2.0.0"
+
+[project.urls]
+Homepage = "https://modern-di.modern-python.org"
+Documentation = "https://modern-di.modern-python.org"
+Repository = "https://github.com/modern-python/modern-di-flask"
+Issues = "https://github.com/modern-python/modern-di-flask/issues"
+Changelog = "https://github.com/modern-python/modern-di-flask/releases"
+
+[dependency-groups]
+dev = [
+    "pytest",
+    "pytest-cov",
+]
+lint = [
+    "ty",
+    "ruff",
+    "eof-fixer",
+    "typing-extensions",
+]
+
+[build-system]
+requires = ["uv_build>=0.11,<1.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "modern_di_flask"
+module-root = ""
+
+[tool.ruff]
+fix = false
+unsafe-fixes = true
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.format]
+docstring-code-format = true
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = [
+    "D1", # allow missing docstrings
+    "S101", # allow asserts
+    "TCH", # ignore flake8-type-checking
+    "FBT", # allow boolean args
+    "D203", # "one-blank-line-before-class" conflicting with D211
+    "D213", # "multi-line-summary-second-line" conflicting with D212
+    "COM812", # flake8-commas "Trailing comma missing"
+    "ISC001", # flake8-implicit-str-concat
+    "G004", # allow f-strings in logging
+]
+isort.lines-after-imports = 2
+isort.no-lines-before = ["standard-library", "local-folder"]
+
+[tool.pytest.ini_options]
+addopts = ""
+
+[tool.coverage.report]
+exclude_also = [
+    "if typing.TYPE_CHECKING:",
+]