Skip to main content

An opinionated dependency injection library for Python

Project description

PySyringe - Dependency Injection for Python

Tests Coverage PyPI version Docs

Dependency injection for Python that keeps your domain clean.

Your business logic should not know a DI container exists. No decorators on your classes, no registration boilerplate. PySyringe resolves dependencies through type hints and injects them at the call site --- your HTTP handlers, CLI commands, or message consumers --- so the rest of your code stays framework-free.

✨ Features

  • 🚀 Zero-decorator DI: keep your domain clean; inject only at call sites.
  • 🎯 Explicit injection with Provide[T]: mark exactly which parameters should be injected — no conflicts with framework signatures.
  • 🏭 Factory-based wiring: resolve by return type annotations on your factory.
  • 🧩 Inference-based construction: auto-wire constructor dependencies by type hints.
  • 🧪 Test-friendly overrides: replace any dependency per test with the override(...) context manager — automatic cleanup, even on exceptions.
  • 🔒 Thread- and async-safe overrides: overrides are scoped to the current thread and asyncio task; aliases are global.
  • 🧰 Aliases: map interfaces to implementations without writing factory methods.
  • 📌 Pre-built instances: bind a single object to one or more ports with register_instance(...).
  • Resolution cache: caches factory lookups and constructor introspection (not instances).

Installation

pip install pysyringe

Example

1) Define a factory

from myapp.domain import EmailSenderInterface
from myapp.infra import LoggingEmailSender, SmtpEmailSender


class Factory:
    def __init__(self, environment: str) -> None:
        self.environment = environment

    def get_mailer(self) -> EmailSenderInterface:
        if self.environment == "production":
            return SmtpEmailSender("mta.example.org", 25)
        return LoggingEmailSender()

Factory methods can also receive the container to resolve sub-dependencies. Just add a container: Container parameter:

from pysyringe import Container


class Factory:
    def get_mailer(self, container: Container) -> EmailSenderInterface:
        config = container.provide(AppConfig)
        if config.environment == "production":
            return SmtpEmailSender(config.smtp_host, config.smtp_port)
        return LoggingEmailSender()

The container passes itself automatically when it detects a Container-typed parameter. This means your factory benefits from the container's full resolution capabilities (inference, mocks, overrides, and aliases). Factory methods without a Container parameter continue to work as before.

2) Create the container

from os import getenv
from pysyringe import Container

factory = Factory(getenv("ENVIRONMENT", "development"))
container = Container(factory)

3) Configure aliases

alias(interface, implementation) maps an interface to a concrete class without needing a factory method. The container builds the implementation using constructor introspection, recursively resolving its dependencies.

from myapp.domain import CalendarInterface
from myapp.infra import Calendar

container.alias(CalendarInterface, Calendar)

3.1) Register a pre-built instance

Sometimes you have a single concrete object that satisfies several ports, and you'd rather build it yourself than describe it to the container — typically because its constructor takes runtime values (settings, secrets) that aren't themselves container-resolvable. register_instance(port, instance) binds an existing object to a type; the same instance can be registered for multiple ports.

import os
from myapp.domain import Cache, RateLimiter
from myapp.infra import RedisClient

# RedisClient implements both Cache and RateLimiter; its constructor
# takes runtime values that aren't container-resolvable.
client = RedisClient(url=os.environ["REDIS_URL"], max_connections=20)

container.register_instance(Cache, client)
container.register_instance(RateLimiter, client)

Registrations are process-wide and shared across threads. They take precedence over alias() and factory methods, but override() can still replace them in tests.

4) Inject at the call site

Use @container.inject combined with Provide[T] type markers to indicate which parameters should be injected. Only parameters annotated with Provide[T] are injected; all others are left for the caller. This makes @container.inject safe to use with any framework (Django, Flask, Dramatiq, etc.) since the container never interferes with framework-controlled parameters.

A complete Django example:

# views.py
from django.http import HttpRequest, HttpResponse
from pysyringe import Container, Provide
from myapp.domain import CalendarInterface
from myapp.infra import Calendar

container = Container()
container.alias(CalendarInterface, Calendar)

@container.inject
def get_now(request: HttpRequest, calendar: Provide[CalendarInterface]) -> HttpResponse:
    return HttpResponse(calendar.now().isoformat())

request is provided by Django as usual. calendar is injected by the container. The container only touches what you explicitly mark.

Declare Provide[T] parameters last, after all caller-supplied parameters (as in the example above). Injected values are passed by keyword, so a caller's positional argument would otherwise land in an injected parameter's slot and fail with TypeError.

5) Replace dependencies in tests

Use the override() context manager (or overrides() for multiple at once) to swap dependencies for the duration of a with block. Cleanup is automatic — even if the test raises — so state never leaks between tests.

from pysyringe import Container
from myapp.domain import UserRepository
from myapp.usecases import SignupUserService
from myapp.infra.testing import InMemoryUserRepository


def test_create_user():
    user_repository = InMemoryUserRepository()
    with container.override(UserRepository, user_repository):
        service = container.provide(SignupUserService)
        service.signup("John Doe", "john.doe@example.org")

    assert user_repository.get_by_email("john.doe@example.org")

For shared setup, wrap override() in a pytest fixture and yield from inside the with block:

import pytest


@pytest.fixture
def user_repository():
    repo = InMemoryUserRepository()
    with container.override(UserRepository, repo):
        yield repo


def test_create_user(user_repository):
    service = container.provide(SignupUserService)
    service.signup("John Doe", "john.doe@example.org")

    assert user_repository.get_by_email("john.doe@example.org")

⚡ Resolution cache

PySyringe includes a lightweight resolution cache to speed up dependency resolution without caching instances.

What is cached:

  • A precomputed map of factory methods keyed by their return type (built once at Container initialization) for O(1) lookups.
  • Constructor parameter introspection is LRU-cached to avoid repeated signature parsing and type disambiguation.

What is NOT cached:

  • Resolved instances. The cache accelerates how dependencies are located and wired, not the objects produced.

This means singleton semantics or any custom sharing strategy you define remain unchanged. The cache only reduces overhead during resolution.

🧷 Singleton helpers

PySyringe provides two singleton helpers for use inside your factory methods. Both cache instances keyed by the class and its constructor arguments.

Helper Scope Use case
singleton() Global (shared across threads) Thread-safe resources like connection pools or HTTP clients
thread_local_singleton() Per-thread Resources that are not safe to share, like database sessions

singleton() — shared across all threads

from pysyringe import Container, singleton


class DatabaseClient:
    def __init__(self, connection_string: str) -> None:
        self.connection_string = connection_string


class Factory:
    def get_database_client(self) -> DatabaseClient:
        return singleton(DatabaseClient, "postgresql://localhost:5432/mydb")


container = Container(Factory())

client1 = container.provide(DatabaseClient)
client2 = container.provide(DatabaseClient)
assert client1 is client2  # Same instance, even across threads

Creation is thread-safe: a lock guarantees that concurrent threads calling singleton() for the same key never produce duplicate instances. Note the lock is global, so a slow constructor briefly blocks other singleton creations.

thread_local_singleton() — one instance per thread

from pysyringe import thread_local_singleton


class Factory:
    def get_session(self) -> DatabaseSession:
        return thread_local_singleton(DatabaseSession, "postgresql://localhost:5432/mydb")

Each thread gets its own DatabaseSession instance. Within the same thread, repeated calls return the same object. This is useful for resources that are not thread-safe, such as database sessions.

Note that instances are per-thread, not per-request: servers reuse worker threads, so an instance created while handling one request survives into the next request served by the same thread. Reset any per-request state yourself.

⚠️ Async caveat: the scope is per-thread, not per-task. In an async app all tasks on the same event loop share one thread — and therefore one instance — so thread_local_singleton() degrades to a plain singleton(). Do not use it for per-request state in async servers.

Notes

  • The cache key includes: the class, positional args, and keyword args (order-independent for keywords).
  • Perfect for database connections, HTTP clients, or any resource that should be shared per configuration.

🔒 Thread and async safety

The Container is safe to share across threads and asyncio tasks. Overrides configured via override() / overrides() are stored in context-local storage (contextvars), so a with block in one thread or task does not affect what other threads or tasks see.

  • Shared across all threads: alias(...), register_instance(...), and the factory configuration (methods on your factory used for resolution).
  • Context-local: override(...) and overrides(...) apply only to the calling thread or asyncio task. Tasks spawned inside an override block inherit it.

Implications:

  • A with container.override(SomeType, mock) block in one thread will not change what another thread receives for SomeType.
  • Concurrent asyncio tasks on the same event loop can hold different overrides without interfering.
  • To share a behavior globally across threads, prefer alias(...) or implement a factory method.

⚡ Async support and limitations

@container.inject works on async def functions: the decorated function is still a coroutine function (so framework async detection, e.g. Django's, works), and its dependencies are resolved synchronously each time it is called, before the first await.

Current limitations:

  • Factory methods must be synchronous. An async def (or async generator) factory method raises AsyncFactoryError when the container is constructed — resolution never awaits, so the coroutine would be injected un-awaited. A plain def factory can still build and return async objects (engines, clients, pools).
  • Resolution runs in the event loop. A factory that blocks (opening connections, reading files) blocks the loop while a dependency is being resolved.
  • thread_local_singleton() is per-thread, not per-task. See the caveat in the singleton helpers section.

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

pysyringe-3.0.0rc1.tar.gz (107.1 kB view details)

Uploaded Source

Built Distribution

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

pysyringe-3.0.0rc1-py3-none-any.whl (13.2 kB view details)

Uploaded Python 3

File details

Details for the file pysyringe-3.0.0rc1.tar.gz.

File metadata

  • Download URL: pysyringe-3.0.0rc1.tar.gz
  • Upload date:
  • Size: 107.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pysyringe-3.0.0rc1.tar.gz
Algorithm Hash digest
SHA256 75e6d25eaac0c353998e116c7e73b9c44e3bd5f969daf3eeaf75b5b9766094f1
MD5 b7f1c12ee780fdd12466fb9dabd41b7c
BLAKE2b-256 2c1fcd23551259d5be7c08ee7eeef5bd647e8f4fbdaa0971f622bf9c1ae8be54

See more details on using hashes here.

File details

Details for the file pysyringe-3.0.0rc1-py3-none-any.whl.

File metadata

  • Download URL: pysyringe-3.0.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 13.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for pysyringe-3.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 e3bc5ae42cfc42776adfc4e133ece155695d15eebf590538cf4e1bb7486e7a1b
MD5 b28beef7819ff483c734c1ed6e6e42e5
BLAKE2b-256 50cedac0a58c1fa2fa218aabf6e12ee1fee4b7da0406f156b653eed350594beb

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