Skip to main content

A code generator for dependency injection (DI) in Python which is based on the mediator and factory patterns

Project description

Reactor DI for Python

CI Coverage Status PyPI version Python versions License: MIT

A code generator for dependency injection (DI) in Python which is based on the mediator and factory patterns.

Features

  • Two powerful decorators: @module and @law_of_demeter
  • Code generation approach: Generates DI code rather than runtime injection
  • Mediator pattern: Central coordination of dependencies
  • Factory pattern: Object creation abstraction
  • Type-safe: Full type hint support
  • Lazy dependency resolution: Dependencies resolved individually on first access, supporting deferred initialization patterns (e.g., async context managers)
  • TYPE_CHECKING compatible: Works with if TYPE_CHECKING: imports for circular dependency avoidance
  • Pydantic compatible: Works with Pydantic BaseSettings/BaseModel annotation-only fields
  • Python 3.8+ support: Tested on Python 3.8 through 3.14

Installation

pip install reactor-di

Quick Start

from reactor_di import module, law_of_demeter, CachingStrategy

class DatabaseConfig:
    host = "localhost"
    port = 5432
    timeout = 30

@law_of_demeter("_config")
class DatabaseService:
    _config: DatabaseConfig
    _host: str      # Forwarded from config.host
    _port: int      # Forwarded from config.port
    _timeout: int   # Forwarded from config.timeout
    
    def connect(self) -> str:
        return f"Connected to {self._host}:{self._port} (timeout: {self._timeout}s)"

# Module: Automatic DI: Implements annotations as @cached_property functions
@module(CachingStrategy.NOT_THREAD_SAFE)
class AppModule:
    config: DatabaseConfig      # Directly instantiated
    database: DatabaseService   # Synthesized with dependencies

# Usage
app = AppModule()
db_service = app.database
print(db_service.connect())  # → "Connected to localhost:5432 (timeout: 30s)"

# Properties are cleanly forwarded
print(db_service._host)      # → "localhost" (from config.host)
print(db_service._timeout)   # → 30 (from config.timeout)

Examples

The examples/ directory contains testable examples that demonstrate all the features shown in this README:

  • quick_start.py - The complete Quick Start example above, converted to testable format
  • quick_start_advanced.py - Advanced quick start with inheritance patterns
  • caching_strategy.py - Demonstrates CachingStrategy.DISABLED, CachingStrategy.NOT_THREAD_SAFE, and CachingStrategy.THREAD_SAFE
  • stacked_decorators.py - Shows using multiple @law_of_demeter decorators on the same class
  • custom_prefix.py - Demonstrates custom prefix options (prefix='', prefix='cfg_', etc.)
  • side_effects.py - Tests side effect isolation during decoration

Running Examples

# Run all examples as tests
uv run pytest examples/

# Run a specific example
uv run pytest examples/quick_start.py

All examples are automatically tested as part of the CI pipeline to ensure they stay current with the codebase.

Tests

The tests/ directory contains regression and unit tests (38 tests):

  • test_module_integration.py - Module + law_of_demeter integration with annotation-only configs (Pydantic compatibility)
  • test_lazy_resolution.py - Lazy per-attribute resolution with deferred initialization patterns
  • test_forward_ref.py - TYPE_CHECKING forward reference handling in module factory
  • test_pure_hasattr.py - Comprehensive tests for the pure_hasattr utility (14 tests)
  • test_thread_safe.py - Thread-safe caching strategy with concurrent access tests (7 tests)
  • test_law_of_demeter.py - Law of Demeter decorator tests
  • test_side_effects.py - Side effects isolation during decoration
# Run all tests (examples + regression tests)
uv run pytest

# Run only regression tests
uv run pytest tests/

Architecture

Reactor DI uses a code generation approach with clean separation of concerns:

  • module.py - The @module decorator for dependency injection containers
  • law_of_demeter.py - The @law_of_demeter decorator for property forwarding
  • caching.py - Caching strategies (CachingStrategy.DISABLED, CachingStrategy.NOT_THREAD_SAFE, CachingStrategy.THREAD_SAFE)
  • type_utils.py - Simplified type checking utilities (Python 3.8+ stable APIs)

The decorators work together through simple hasattr checks - @law_of_demeter creates forwarding properties that @module recognizes as already implemented, enabling clean cooperation without complex validation logic.

Advanced Usage

Caching Strategies

from reactor_di import module, CachingStrategy

# No caching - components created fresh each time
@module(CachingStrategy.DISABLED)
class DevModule:
    service: MyService

# Cached components - same instance returned (not thread-safe)
@module(CachingStrategy.NOT_THREAD_SAFE)
class ProdModule:
    service: MyService

# Cached components - same instance returned (thread-safe, uses locking)
@module(CachingStrategy.THREAD_SAFE)
class ThreadSafeProdModule:
    service: MyService

Multiple Decorator Integration

@law_of_demeter("_config")    # Creates forwarding properties
@law_of_demeter("_module")    # Auto-setup: self._config = self._module.config
class ResourceController:
    def __init__(self, module):
        self._module = module
        # Decorator automatically sets up: self._config = module.config
    
    # From _config
    _timeout: int
    _is_dry_run: bool
    
    # From _module  
    _api: object
    _namespace: str

Custom Prefixes

# No prefix - direct forwarding
@law_of_demeter('config', prefix='')
class DirectController:
    timeout: int        # → config.timeout
    is_dry_run: bool    # → config.is_dry_run

# Custom prefix
@law_of_demeter('config', prefix='cfg_')
class PrefixController:
    cfg_timeout: int        # → config.timeout
    cfg_is_dry_run: bool    # → config.is_dry_run

API Reference

Core Decorators

@module(strategy: CachingStrategy = CachingStrategy.DISABLED)

Creates a dependency injection module that automatically instantiates and provides dependencies.

Parameters:

  • strategy: Caching strategy for component instances
    • CachingStrategy.DISABLED: Create new instances each time (default)
    • CachingStrategy.NOT_THREAD_SAFE: Cache instances (not thread-safe)
    • CachingStrategy.THREAD_SAFE: Cache instances with per-instance locking (thread-safe)

Usage:

@module(CachingStrategy.NOT_THREAD_SAFE)
class AppModule:
    config: Config
    service: Service  # Automatically injected with dependencies

@law_of_demeter(base_ref: str, prefix: str = "_")

Creates property forwarding from a base reference to avoid Law of Demeter violations.

Parameters:

  • base_ref: Name of the base object attribute to forward from
  • prefix: Prefix for forwarded property names (default: "_")

Usage:

@law_of_demeter("_config")
class Service:
    _timeout: int     # Forwards to _config.timeout
    _host: str        # Forwards to _config.host

Type Utilities

The simplified type utilities leverage Python 3.8+ stable type hint APIs:

get_alternative_names(name: str, prefix: str = "_") -> List[str]

Generates alternative names for dependency mapping (e.g., _configconfig).

has_constructor_assignment(class_type: Type[Any], attr_name: str) -> bool

Detects if a constructor assigns to an attribute using regex source analysis.

is_primitive_type(attr_type: Type[Any]) -> bool

Identifies primitive types (int, str, bool, etc.) that shouldn't be auto-instantiated.

pure_hasattr(obj: Any, attr_name: str) -> bool

Checks if an attribute exists without side effects like triggering descriptors or properties. Used internally to avoid premature evaluation during dependency resolution.

Enums

CachingStrategy

Component caching strategies for the @module decorator.

  • DISABLED = "disabled": No caching, create new instances each time
  • NOT_THREAD_SAFE = "not_thread_safe": Cache instances (not thread-safe)
  • THREAD_SAFE = "thread_safe": Cache instances with per-instance locking (thread-safe)

Development

This project uses modern Python tooling and best practices:

Setup

  1. Clone the repository
  2. Install dependencies:
    uv sync
    

Running Tests

# Run all tests (60 tests: 22 examples + 38 regression/unit tests)
uv run pytest

# Run tests with coverage and HTML/terminal reports
uv run pytest --cov

# Run example tests only
uv run pytest examples/                     # Run all examples as tests (22 tests)
uv run pytest examples/caching_strategy.py  # Caching strategy examples (5 tests)
uv run pytest examples/custom_prefix.py     # Custom prefix examples (6 tests)
uv run pytest examples/quick_start.py       # Quick start examples (4 tests)

# Run regression/unit tests only
uv run pytest tests/                        # Run all regression tests (38 tests)

Debugging in PyCharm

The project is optimized for fast development and debugging:

  1. Default: Tests run without coverage for fast feedback and debugging
  2. Coverage analysis: Use --cov flag when you need coverage reports
  3. Coverage threshold: Set to 90% to maintain high code quality (when coverage is enabled)

This configuration ensures breakpoints work reliably and tests run quickly during development.

Code Quality

# Run linting
uv run ruff check src tests examples
uv run black --check src tests examples

# Run type checking
uv run mypy src

# Fix formatting
uv run black src tests examples

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Add tests for new functionality with meaningful assertions
  5. Ensure all tests pass and 90% coverage is maintained
  6. Verify realistic code scenarios rather than mocking impossible edge cases
  7. Submit a pull request

License

This project is licensed under the MIT License - see the LICENSE file for details.

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

reactor_di-0.2.1.tar.gz (100.0 kB view details)

Uploaded Source

Built Distribution

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

reactor_di-0.2.1-py3-none-any.whl (14.5 kB view details)

Uploaded Python 3

File details

Details for the file reactor_di-0.2.1.tar.gz.

File metadata

  • Download URL: reactor_di-0.2.1.tar.gz
  • Upload date:
  • Size: 100.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","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 reactor_di-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cf90cd2d938b3bad38a804d447ee7ac4d55acbe9ccf23da52136c88e56cc8b6e
MD5 05d9e1cc2d95a3fecf083e6914501e37
BLAKE2b-256 0bd2286369001da9743866a2a38a9afa485ceba4caa6904864b38f4b8b4e4a72

See more details on using hashes here.

File details

Details for the file reactor_di-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: reactor_di-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 14.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.10 {"installer":{"name":"uv","version":"0.10.10","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 reactor_di-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 acb9e503e549c0cbc446bbd21d3be3b7cfda308acc6c321d98e42cfea6f4b904
MD5 ef0394b5963e44e61c125885b03bd0b7
BLAKE2b-256 4d66a4954d2b28db5f7b26e98b2d87ca00551c0b2ff9151b5d97d52413bbe0ed

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