antidote 0.3.0

Transparent dependency injection.

Antidote is a dependency injection micro framework for Python 3.4+. It provides simple decorators to declare services and to inject those automatically based on type hints.

Why ?

In short antidote avoids you the hassle of instantiating and managing your services. You declare them at their definition, and inject them wherever needed with simple decorators, which do not change how you interact with your objects. Unit testing is not impacted as one can override any injection and control the available dependencies easily.

For the longer version: https://antidote.readthedocs.io/en/latest/why.html

Features Highlight

• Dependencies bound through type hints and optionally from variable names and/or mapping.

• Integrates well with any code, injected functions can be called as usual with all their arguments.

• Integration with the attrs package (>= v17.1).

• Thread-safe and limited performance impact (see injection benchmark).

• Dependency cycle detection.

• Other dependencies, such as configuration parameters, can be easily added.

• Easily extendable.

Installation

To install Antidote, simply run this command:

pip install antidote

Quick Start

Let’s suppose you have database class from an external library and you wrap it with a custom class for easier usage. Antidote can do all the wiring for you:

from antidote import antidote, Dependency as Dy
from operator import getitem


class Database:
    """
    Class from an external library.
    """
    def __init__(self, *args, **kwargs):
        """ Initializes the database. """

config = {
    'db': {
        'host': 'host',
        'user': 'user',
        'port': '5432',
        'password': 'password',
    }
}

# Add configuration parameters.
antidote.register_parameters(config, getter=getitem, prefix='conf:',
                             split='.')

# Declare a factory which should be called to instantiate Database.
# Variables names are used here for injection. A dictionary mapping
# arguments name to their dependency could also have been used.
@antidote.factory(arg_map=('conf:db.host', 'conf:db.port',
                           'conf:db.user', 'conf:db.password'))
def database_factory(db_host, db_port, db_user,
                     db_password) -> Database:
    """
    Configure your database.
    """
    return Database(
        host=db_host,
        port=int(db_port),
        user=db_user,
        password=db_password
    )

# Declare DatabaseWrapper as a service to be injected.
@antidote.register
class DatabaseWrapper:
    """
    Your class to manage the database.
    """

    # Dependencies of __init__() are injected by default when
    # registering a service.
    def __init__(self, db: Database):
        self.db = db


@antidote.inject
def f(db: DatabaseWrapper):
    """ Do something with your database. """

# Can be called without arguments now.
f()

# You can still explicitly pass the arguments to override
# injection.
f(DatabaseWrapper(database_factory(
    db_host=config['db']['host'],
    db_port=config['db']['port'],
    db_user=config['db']['user'],
    db_password=config['db']['password']
)))

Documentation

The documentation is available at https://antidote.readthedocs.io/.

Injection benchmark is available at injection benchmarks.

Bug Reports / Feature Requests

Any feedback is always welcome, feel free to submit issues and enhancement requests ! :) For any questions, open an issue on Github.

How to Contribute

1. Check for open issues or open a fresh issue to start a discussion around a feature or a bug.

2. Fork the repo on GitHub. Run the tests to confirm they all pass on your machine. If you cannot find why it fails, open an issue.

3. Start making your changes to the master branch.

4. Writes tests which shows that your code is working as intended. (This also means 100% coverage.)

5. Send a pull request.

Be sure to merge the latest from “upstream” before making a pull request!

Pull requests should avoid to:

• make it harder to integrate Antidote into existing code.

• break backwards compatibility.

• create features difficult to understand for an IDE, such as converting a string dependency id to a non singleton object somehow. An user may do this, but antidote shouldn’t.

Pull requests will not be accepted if:

• classes and non trivial functions have not docstrings documenting their behavior.

• tests do not cover all of code changes.

Do not hesitate to send a pull request, even if incomplete, to get early feedback ! :)

TODO

This actually more of a roadmap of features. Those marked with a “(?)” may not be implemented.

• tags to filter services and retrieve a list of them.

• Add a proper way to test with injector.bind + mocking utility.

• Add possibility for a factory to be aware of the injected variable’s name annotation. And take it into account for the dependency hash if, and only if, it is specified. (?)

• way to restrict services availability, either through tags, different containers or injectors, etc… (?)

• proxies (?)

• rework of register_parameters to something like getter to provide a way of getting remote parameters. (?)