Modern-DI integration for Litestar.
Full guide: Litestar integration docs
Usage example: litestar-sqlalchemy-template
Installation
uv add modern-di-litestar # or: pip install modern-di-litestar
Usage
1. Define providers
import dataclasses
from modern_di import Group, Scope, providers
@dataclasses.dataclass(kw_only=True)
class Database:
url: str
@dataclasses.dataclass(kw_only=True)
class UserRepository:
db: Database
class AppDependencies(Group):
database = providers.Factory(creator=Database, kwargs={"url": "sqlite:///app.db"})
user_repo = providers.Factory(scope=Scope.REQUEST, creator=UserRepository, bound_type=None)
2. Wire the plugin
import litestar
from modern_di import Container
from modern_di_litestar import ModernDIPlugin
groups = [AppDependencies]
app = litestar.Litestar(
plugins=[ModernDIPlugin(Container(groups=groups, validate=True), autowired_groups=groups)],
)
Passing autowired_groups to ModernDIPlugin auto-registers each provider as a Litestar dependency keyed by its attribute name (database, user_repo), so routes can declare them directly as parameters.
3. Inject into routes
Using FromDI (explicit, per-route)
from modern_di_litestar import FromDI
@litestar.get(
"/users",
dependencies={"repo": FromDI(AppDependencies.user_repo)},
)
async def list_users(repo: UserRepository) -> list[str]:
...
FromDI accepts either a provider instance (AppDependencies.user_repo) or a type (UserRepository).
Using auto-wired group names (implicit)
When autowired_groups is passed to ModernDIPlugin, provider names become available as route parameters directly:
@litestar.get("/users")
async def list_users(user_repo: UserRepository) -> list[str]:
...
4. Access the raw request or websocket via DI
from modern_di_litestar import litestar_request_provider, litestar_websocket_provider
class AppDependencies(Group):
...
request_method = providers.Factory(
scope=Scope.REQUEST,
creator=lambda request: request.method,
bound_type=None,
)
litestar_request_provider and litestar_websocket_provider are pre-built ContextProvider instances that make the current Request / WebSocket objects resolvable within DI.
5. Sub-request (action) scopes
For work that should live shorter than a request, build a child container inside a route:
@litestar.get("/")
async def handler(di_container: Container) -> None:
action_container = di_container.build_child_container()
result = action_container.resolve_provider(AppDependencies.some_action_scoped_factory)
6. Retrieve the app-level container
from modern_di_litestar import fetch_di_container
container = fetch_di_container(app)
API
| Symbol | Description |
|---|---|
ModernDIPlugin(container, autowired_groups=None) |
Litestar InitPlugin — wires the DI container into app lifecycle |
FromDI(provider) |
Returns a Litestar Provide that resolves a provider per request |
litestar_request_provider |
ContextProvider for the current litestar.Request |
litestar_websocket_provider |
ContextProvider for the current litestar.WebSocket |
fetch_di_container(app) |
Retrieves the root container from app.state |
build_di_container |
Litestar dependency (registered as di_container) — yields a scoped child container per request |
📦 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file modern_di_litestar-2.13.0.tar.gz.
File metadata
- Download URL: modern_di_litestar-2.13.0.tar.gz
- Upload date:
- Size: 5.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
297bff17a745cf15af9469ffb8f5f682fdb9476e286699f6ae4b9f8a87e7b2d6
|
|
| MD5 |
4cad680830f80e07dd3ed4e895fa252c
|
|
| BLAKE2b-256 |
bccdc4f813ffac548ed896b812f514b033ab08e14e44a066231666b9193b6c12
|
File details
Details for the file modern_di_litestar-2.13.0-py3-none-any.whl.
File metadata
- Download URL: modern_di_litestar-2.13.0-py3-none-any.whl
- Upload date:
- Size: 5.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a7f587f4458b7556d9e70e93297abe25cf4e45a8dbb66f0759a40e6b7c17904d
|
|
| MD5 |
b87f4d7c4f0c2fe7555edd6b2bb6a225
|
|
| BLAKE2b-256 |
731ef65f1ec8ffe9899073d302f9de6a336f44c0f4aff7ecf87f1467f09dc46d
|
