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)
- Regular dependencies (
- 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
- Keep dependency constructors simple and focused
- Use
@cachefor expensive-to-create dependencies that can be reused - Prefer contextual dependencies for resources that need cleanup
- Always wrap contextual dependency usage with
ensure() - 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
Release history Release notifications | RSS feed
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 diwrappers-0.4.1.tar.gz.
File metadata
- Download URL: diwrappers-0.4.1.tar.gz
- Upload date:
- Size: 8.6 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9eb7614fce55fb463dbdd790760824597eb63d61d677cd5d57db96f3ad12cab5
|
|
| MD5 |
96338061b1ed2e601b38911adbaa2d8a
|
|
| BLAKE2b-256 |
222c0791679e2eb66c717b666916eb4c0e3882d8b719c558196880166d45a3a5
|
File details
Details for the file diwrappers-0.4.1-py3-none-any.whl.
File metadata
- Download URL: diwrappers-0.4.1-py3-none-any.whl
- Upload date:
- Size: 10.6 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
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
27f00e329f66986a8820ae361a56d84e3a8e2e842e307f19278a911ef0f3b63b
|
|
| MD5 |
781354722ae15c746707a157a94a93aa
|
|
| BLAKE2b-256 |
eae48a1faa4cfba683929801240f7b77a0c7f598d5e10ee8e348245f45606c4b
|