Skip to main content

A lightweight, intuitive dependency injection library for Python that makes testing and dependency management a breeze.

Project description

DIWrappers

A lightweight, type-safe dependency injection library for Python that supports synchronous, asynchronous, and contextual dependencies.

Features

  • Type-safe dependency injection with Python type hints
  • Three injection patterns:
    • Regular dependencies (@dependency)
    • Async dependencies (@async_dependency)
    • Contextual dependencies (@contextual_dependency)
  • Testing utilities for mocking dependencies
  • Support for singleton dependencies via @cache
  • Minimal boilerplate and intuitive API

Installation

pip install diwrappers

Usage

Basic Dependency Injection

from diwrappers import dependency

@dependency
def api_token() -> str:
    return "your-api-token"

@api_token.inject
def make_request(api_token: str, endpoint: str):
    return f"Calling {endpoint} with token {api_token}"

# The api_token will be automatically injected
result = make_request("/users")

Async Dependencies

For dependencies that require asynchronous initialization:

from diwrappers import async_dependency

@async_dependency
async def database():
    connection = await establish_db_connection()
    return connection

@database.inject
async def get_user(db, user_id: int):
    return await db.query(f"SELECT * FROM users WHERE id = {user_id}")

# Use with async/await
user = await get_user(123)

Contextual Dependencies

For dependencies that need proper resource management:

from diwrappers import contextual_dependency
import contextlib

@contextual_dependency
@contextlib.contextmanager
def db_transaction():
    transaction = start_transaction()
    try:
        yield transaction
        transaction.commit()
    except:
        transaction.rollback()
        raise

@db_transaction.inject
def update_user(transaction, user_id: int, data: dict):
    transaction.execute("UPDATE users SET ...", data)

# Must be wrapped in ensure() to properly manage the context
@db_transaction.ensure
def main():
    update_user(123, {"name": "New Name"})

Testing

The library provides utilities for mocking dependencies in tests:

Using fake_value

@dependency
def current_time() -> float:
    return time.time()

# In tests
with current_time.fake_value(1234567890.0):
    assert get_timestamp() == 1234567890.0

Using faker

@dependency
def random_id() -> str:
    return str(uuid.uuid4())

@random_id.faker
def fixed_id():
    return "test-id-123"

# In tests
with fixed_id():
    assert create_resource().id == "test-id-123"

Singleton Dependencies

To create singleton dependencies that are cached for the lifetime of the program:

from functools import cache

@dependency
@cache
def config():
    return load_config_from_file()

Type Safety

The library leverages Python's type hints to ensure type safety:

@dependency
def logger() -> Logger:
    return Logger()

@logger.inject
def process_data(logger: Logger, data: dict) -> None:
    logger.info(f"Processing {data}")  # Type-checked by your IDE/mypy

Best Practices

  1. Keep dependency constructors simple and focused
  2. Use @cache for expensive-to-create dependencies that can be reused
  3. Prefer contextual dependencies for resources that need cleanup
  4. Always wrap contextual dependency usage with ensure()
  5. Use async dependencies for I/O-bound operations

Contributing

Contributions are welcome! Please feel free to 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

diwrappers-0.5.0.tar.gz (11.0 kB view details)

Uploaded Source

Built Distribution

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

diwrappers-0.5.0-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

Details for the file diwrappers-0.5.0.tar.gz.

File metadata

  • Download URL: diwrappers-0.5.0.tar.gz
  • Upload date:
  • Size: 11.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/6.8.0-1017-azure

File hashes

Hashes for diwrappers-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a0f4397fefb7760e77fda6e31bb9e140c57d02172b56ca8186059024f27c7cf9
MD5 6755c14a849ae23ae35faf91cb8cae6f
BLAKE2b-256 0b48a9f00ad4efb47d47ec156739b854a9b8485473e748021861ca9ba2435c8b

See more details on using hashes here.

File details

Details for the file diwrappers-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: diwrappers-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 13.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.12.8 Linux/6.8.0-1017-azure

File hashes

Hashes for diwrappers-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b57ee18a7563af5ee1cc130e20800cdf51d796f6b152dd42ca682d5cabe2464
MD5 1f33a2d3fdbb00d9a895ac8c985a71c8
BLAKE2b-256 6c2f1e5e243975558394664d7f491a14b171a94724970dc3992b1d71a95e0be3

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