Skip to main content

modern-di integration for Typer

Project description

modern-di-typer

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

Modern-DI integration for Typer.

Full guide: Typer integration docs

Installation

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

Usage

import typing
import typer
import modern_di
from modern_di import Scope, providers, Group
from modern_di_typer import FromDI, inject, setup_di


class Dependencies(Group):
    settings = providers.Factory(creator=lambda: {"debug": True})
    service = providers.Factory(scope=Scope.REQUEST, creator=MyService, bound_type=None)


app = typer.Typer()
container = modern_di.Container(groups=[Dependencies], validate=True)
setup_di(app, container)


@app.command()
@inject
def my_command(
    name: typing.Annotated[str, typer.Argument()],
    service: typing.Annotated[MyService, FromDI(Dependencies.service)],
) -> None:
    service.run(name)


if __name__ == "__main__":
    with container:
        app()

Action scope

Scope.ACTION dependencies live below the per-command Scope.REQUEST container. Open one with action_scope(ctx): each with block yields a fresh action-scoped container (a child of the command's request container), so you can open as many as you need within a single command — one per item in a batch, for example.

import typer
from modern_di import Scope, providers, Group
from modern_di_typer import FromDI, action_scope, inject


class Dependencies(Group):
    job = providers.Factory(scope=Scope.ACTION, creator=MyJob, bound_type=None)


@app.command()
@inject
def my_command(ctx: typer.Context) -> None:
    for job_name in job_names:
        with action_scope(ctx) as action:
            action.resolve_provider(Dependencies.job).run()

API

  • setup_di(app, container) — register the container with a Typer app
  • inject — decorator that resolves FromDI-annotated parameters before the command runs; also exposes typer.Context with ctx.obj["di_container"] for manual use
  • FromDI(provider) — marker used in Annotated[T, FromDI(...)]; accepts a provider instance or a type
  • action_scope(ctx) — context manager yielding a fresh Scope.ACTION container (a child of the command's request container); open one per action
  • fetch_di_container(ctx) — returns the app-scoped container from ctx.obj

Used by

  • semvertag — a CLI auto-tagger for GitLab/GitHub that wires its settings, API providers, and version-bump strategies through a modern_di container with modern-di-typer. See semvertag/ioc.py for a real-world setup_di + Group setup.

📦 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.

Project details


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_typer-2.3.0.tar.gz (4.4 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_typer-2.3.0-py3-none-any.whl (4.8 kB view details)

Uploaded Python 3

File details

Details for the file modern_di_typer-2.3.0.tar.gz.

File metadata

  • Download URL: modern_di_typer-2.3.0.tar.gz
  • Upload date:
  • Size: 4.4 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

Hashes for modern_di_typer-2.3.0.tar.gz
Algorithm Hash digest
SHA256 5b2d85441b52d6f6081001feb31ccded49cfbc8263a7299bd92579c5e07ac9a0
MD5 f2bad62750dda83676976cde3e03ed0f
BLAKE2b-256 a1ae05e5b7ef54bd9899706a2e8d0067d097fc5c611a7a954c04f4d77367cf27

See more details on using hashes here.

File details

Details for the file modern_di_typer-2.3.0-py3-none-any.whl.

File metadata

  • Download URL: modern_di_typer-2.3.0-py3-none-any.whl
  • Upload date:
  • Size: 4.8 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

Hashes for modern_di_typer-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7b23848fed457badcdc67c2d34ba9f52d93434df76caf3764c4d9f85df72081
MD5 698547afcb4ad23c1d636a7262e2afa3
BLAKE2b-256 d7f070ab053d912ead5ee1cd13f4ca60e709d5aa542fe84556467810f30df984

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 Pingdom Monitoring Sentry Error logging StatusPage Status page