Skip to main content

Python dependency injection framework

Project description

Dependency Injector is a Python dependency injection framework. It was designed to be unified, developer’s friendly tool for managing any kind of Python objects and their dependencies in formal, pretty way.

Below is a list of some key features and points of Dependency Injector:

  • Easy, smart, pythonic style.
  • Obvious, clear structure.
  • Memory efficiency.
  • Thread safety.
  • Semantic versioning.

Main idea of Dependency Injector is to keep dependencies under control.

Status

PyPi Latest Version Downloads License
Python versions and implementations Supported Python versions Supported Python implementations
Builds and tests coverage Build Status Coverage Status

Installation

Dependency Injector library is available on PyPi:

pip install dependency_injector

Documentation

Dependency Injector documentation is hosted on ReadTheDocs:

Examples

"""Concept example of `Dependency Injector`."""

import sqlite3

from dependency_injector import catalogs
from dependency_injector import providers
from dependency_injector import injections


class UsersService(object):
    """Users service, that has dependency on database."""

    def __init__(self, db):
        """Initializer."""
        self.db = db


class AuthService(object):
    """Auth service, that has dependencies on users service and database."""

    def __init__(self, db, users_service):
        """Initializer."""
        self.db = db
        self.users_service = users_service


class Services(catalogs.DeclarativeCatalog):
    """Catalog of service providers."""

    database = providers.Singleton(sqlite3.connect, ':memory:')
    """:type: providers.Provider -> sqlite3.Connection"""

    users = providers.Factory(UsersService,
                              db=database)
    """:type: providers.Provider -> UsersService"""

    auth = providers.Factory(AuthService,
                             db=database,
                             users_service=users)
    """:type: providers.Provider -> AuthService"""


# Retrieving catalog providers:
users_service = Services.users()
auth_service = Services.auth()

# Making some asserts:
assert users_service.db is auth_service.db is Services.database()
assert isinstance(auth_service.users_service, UsersService)
assert users_service is not Services.users()
assert auth_service is not Services.auth()


# Making some "inline" injections:
@injections.inject(users_service=Services.users)
@injections.inject(auth_service=Services.auth)
@injections.inject(database=Services.database)
def example(users_service, auth_service, database):
    """Example callback."""
    assert users_service.db is auth_service.db
    assert auth_service.db is database
    assert database is Services.database()


# Making a call of decorated callback:
example()


# Overriding auth service provider and making some asserts:
class ExtendedAuthService(AuthService):
    """Extended version of auth service."""

    def __init__(self, db, users_service, ttl):
        """Initializer."""
        self.ttl = ttl
        super(ExtendedAuthService, self).__init__(db=db,
                                                  users_service=users_service)


Services.auth.override(providers.Factory(ExtendedAuthService,
                                         db=Services.database,
                                         users_service=Services.users,
                                         ttl=3600))


auth_service = Services.auth()

assert isinstance(auth_service, ExtendedAuthService)

You can get more Dependency Injector examples in /examples directory on GitHub:

https://github.com/ets-labs/dependency_injector

Feedback

Feel free to post questions, bugs, feature requests, proposals etc. on Dependency Injector GitHub Issues:

https://github.com/ets-labs/dependency_injector/issues

Your feedback is quite important!

Project details


Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
dependency_injector-1.14.5.tar.gz (30.7 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page