Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/allrod5/injectable

Python Dependency Injection for Humans™
https://github.com/allrod5/injectable

autowired autowiring circular-dependencies dependency-injection for-humans injection ioc lazy-evaluation micro-framework python

Last synced: about 1 month ago
JSON representation

Python Dependency Injection for Humans™

Host: GitHub
URL: https://github.com/allrod5/injectable
Owner: roo-oliv
License: mit
Created: 2018-02-04T20:26:28.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-08-05T15:13:11.000Z (about 2 months ago)
Last Synced: 2024-08-06T13:35:48.949Z (about 1 month ago)
Topics: autowired, autowiring, circular-dependencies, dependency-injection, for-humans, injection, ioc, lazy-evaluation, micro-framework, python
Language: Python
Homepage: https://injectable.readthedocs.io
Size: 1.09 MB
Stars: 111
Watchers: 4
Forks: 9
Open Issues: 4
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.rst
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.rst

Awesome Lists containing this project

awesome-dependency-injection-in-python - injectable - Python Dependency Injection for Humans™. [🐍, MIT License]. (Software / DI Frameworks / Containers)

README

        .. _injectable:

.. role:: python(code)

   :language: python

Injectable: Dependency Injection for Humans™

============================================

`Usage Examples 🚩 `_ | `Developer Reference 👩‍💻 `_ | `Authors 👫 `_

.. start-badges

.. list-table::

    :stub-columns: 1

    * - license

      - |license|

    * - docs

      - |docs|

    * - tests

      - |build| |coveralls| |reliability| |security| |black| |flake8|

    * - package

      - |version| |wheel| |supported-versions| |supported-implementations| |platforms| |downloads|

.. |docs| image:: https://readthedocs.org/projects/pip/badge/?version=latest&style=plastic

    :target: https://injectable.readthedocs.io/en/latest/

    :alt: Documentation

.. |build| image:: https://github.com/roo-oliv/injectable/actions/workflows/build.yml/badge.svg

    :alt: Build Status

    :target: https://github.com/roo-oliv/injectable/actions/workflows/build.yml

.. |coveralls| image:: https://coveralls.io/repos/github/allrod5/injectable/badge.svg?branch=master

    :alt: Coverage Status

    :target: https://coveralls.io/github/allrod5/injectable?branch=master

.. |reliability| image:: https://sonarcloud.io/api/project_badges/measure?project=roo-oliv_injectable&metric=reliability_rating

    :alt: Reliability Rating

    :target: https://sonarcloud.io/dashboard?id=roo-oliv_injectable

.. |security| image:: https://sonarcloud.io/api/project_badges/measure?project=roo-oliv_injectable&metric=security_rating

    :alt: Security Rating

    :target: https://sonarcloud.io/dashboard?id=roo-oliv_injectable

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :alt: Code Style

    :target: https://github.com/psf/black

.. |flake8| image:: https://img.shields.io/badge/standards-flake8-blue

    :alt: Standards

    :target: https://flake8.pycqa.org/en/latest/

.. |version| image:: https://img.shields.io/pypi/v/injectable.svg

    :alt: PyPI Package latest release

    :target: https://pypi.org/project/injectable

.. |wheel| image:: https://img.shields.io/pypi/wheel/injectable.svg

    :alt: PyPI Wheel

    :target: https://pypi.org/project/injectable

.. |supported-versions| image:: https://img.shields.io/pypi/pyversions/injectable.svg

    :alt: Supported versions

    :target: https://pypi.org/project/injectable

.. |supported-implementations| image:: https://img.shields.io/pypi/implementation/injectable.svg

    :alt: Supported implementations

    :target: https://pypi.org/project/injectable

.. |license| image:: https://img.shields.io/github/license/roo-oliv/injectable

    :alt: GitHub license

    :target: https://github.com/roo-oliv/injectable/blob/master/LICENSE

.. |platforms| image:: https://img.shields.io/badge/platforms-windows%20%7C%20macos%20%7C%20linux-lightgrey

    :alt: Supported Platforms

    :target: https://github.com/roo-oliv/injectable/blob/master/.github/workflows/build.yml#L11

.. |downloads| image:: https://pepy.tech/badge/injectable/month

    :alt: Downloads per Month

    :target: https://pepy.tech/project/injectable/month

.. end-badges

**Injectable** is an elegant and simple Dependency Injection framework built with Heart

and designed for Humans.

.. list-table::

    :header-rows: 0

    * - .. code:: python

            from typing import Annotated, List

            from injectable import Autowired, autowired

            from models import Database

            from messaging import Broker

            class Service:

                @autowired

                def __init__(

                    self,

                    database: Annotated[Database, Autowired],

                    brokers: Annotated[List[Broker], Autowired],

                ):

                    pending = database.get_pending_messages()

                    for broker in brokers:

                        broker.send_pending(pending)

        .. code:: python

            from abc import ABC

            class Broker(ABC):

                def send_pending(messages):

                    ...

      - .. code:: python

            from injectable import injectable

            @injectable

            class Database:

                ...

        .. code:: python

            from messaging import Broker

            from injectable import injectable

            @injectable

            class KafkaProducer(Broker):

                ...

        .. code:: python

            from messaging import Broker

            from injectable import injectable

            @injectable

            class SQSProducer(Broker):

                ...

Features you'll love ❤️

-----------------------

* **Autowiring**: injection is

  transparent to the function. Just decorate the function with :python:`@autowired` and annotate

  parameters with :python:`Autowired`, that's it.

  `see an example `__

* **Automatic dependency discovery**: just call :python:`load_injection_container()` at

  the root of your project or pass the root path as an argument. All classes decorated

  with :python:`@injectable` will be automatically discovered and ready for injection.

  `see reference `__

* **Qualifier overloading**: declare as many injectables as you like for a single

  qualifier or extending the same base class. You can inject all of them just by

  specifying a :python:`typing.List` to :python:`Autowired`:

  :python:`deps: Annotated[List["qualifier"], Autowired]`.

  `see an example `__

* **Transparent lazy initialization**: passing the argument :python:`lazy=True` for

  :python:`Autowired` will make your dependency to be initialized only when actually used, all

  in a transparent fashion.

  `see an example `__

* **Singletons**: decorate your class with :python:`@injectable(singleton=True)` and only a

  single instance will be initialized and shared for injection.

  `see an example `__

* **Namespaces**: specify different namespaces for injectables as in

  :python:`@injectable(namespace="foo")` and then just use them when annotating your

  parameters as in :python:`dep: Annotated[..., Autowired(namespace="foo")]`.

  `see an example `__

* **Linters friendly**: :python:`Autowired` is carefully designed to comply with static linter

  analysis such as PyCharm's to preserve the parameter original type hint.

These are just a few cool and carefully built features for you. Check out our `docs

`_!