Skip to main content

modern-di-starlette

PyPI version Supported Python versions Downloads Coverage CI License GitHub stars uv Ruff ty

Modern-DI integration for Starlette.

Full guide: Starlette integration docs

Usage example: examples/

Installation

uv add modern-di-starlette      # or: pip install modern-di-starlette

Usage

setup_di registers the container, composes the lifespan, and installs middleware that builds a per-connection child container. Decorate an endpoint with @inject and mark parameters with FromDI to receive resolved dependencies. Starlette has no native DI, so @inject is required (there is no Depends).

import dataclasses
import typing

from modern_di import Container, Group, Scope, providers
from modern_di_starlette import FromDI, inject, setup_di
from starlette.applications import Starlette
from starlette.requests import Request
from starlette.responses import JSONResponse
from starlette.routing import Route


@dataclasses.dataclass(kw_only=True)
class Settings:
    debug: bool = True


@dataclasses.dataclass(kw_only=True)
class UserService:
    settings: Settings  # auto-injected by type


class Dependencies(Group):
    settings = providers.Factory(scope=Scope.APP, creator=Settings)
    user_service = providers.Factory(scope=Scope.REQUEST, creator=UserService)


@inject
async def homepage(
    request: Request,
    service: typing.Annotated[UserService, FromDI(Dependencies.user_service)],
) -> JSONResponse:
    return JSONResponse({"debug": service.settings.debug})


app = Starlette(routes=[Route("/", homepage)])
container = Container(groups=[Dependencies], validate=True)
setup_di(app, container)

An HTTP request opens a Scope.REQUEST child container; a WebSocket connection opens a Scope.SESSION one, both built by the middleware before your handler runs. The connection starlette.requests.Request / starlette.websockets.WebSocket are resolvable within DI via the pre-built starlette_request_provider / starlette_websocket_provider context providers.

API

Symbol Description
setup_di(app, container) Registers the container on app.state, composes the lifespan (opens/closes the container), and installs the middleware that builds a per-connection child container; returns the container
FromDI(dependency) Inert marker (used with @inject) that resolves a provider or type from the per-connection child container
inject(handler) Decorator for an async def handler taking a Request or WebSocket; resolves its FromDI-annotated parameters
fetch_di_container(app) Returns the root Container stored on app.state
starlette_request_provider ContextProvider for starlette.requests.Request (REQUEST scope), auto-registered
starlette_websocket_provider ContextProvider for starlette.websockets.WebSocket (SESSION scope), auto-registered

📦 PyPI

📝 License

Part of modern-python

Built on modern-di, a dependency-injection framework with IoC container and scopes.

Browse the full list of templates and libraries in modern-python — see the org profile for the categorized index.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

modern_di_starlette-3.1.0.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

modern_di_starlette-3.1.0-py3-none-any.whl (5.4 kB view details)

Uploaded Python 3

File details

Details for the file modern_di_starlette-3.1.0.tar.gz.

File metadata

  • Download URL: modern_di_starlette-3.1.0.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for modern_di_starlette-3.1.0.tar.gz
Algorithm Hash digest
SHA256 87002697891aa5f198a66b0b55fdefe6b69cee5e7df3e14ff87ec4ac6ff2bbd7
MD5 4ac8f3569afa5ee156435e939497cf52
BLAKE2b-256 db45369dbc587e312b1d3251139f6589489060291e3b5e417b320884b2521974

See more details on using hashes here.

File details

Details for the file modern_di_starlette-3.1.0-py3-none-any.whl.

File metadata

  • Download URL: modern_di_starlette-3.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.11.32 {"installer":{"name":"uv","version":"0.11.32","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for modern_di_starlette-3.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8e3c583384000001128d3232fb02586c764996c00f2e1de50ae6c77292af3fa8
MD5 d820198d8878993b197b47898bd14b14
BLAKE2b-256 9062fc025966fe3b9a9b0a2873fd4ef56b3915f9b5455ca0357221d41b811aa3

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page