https://github.com/ettoreleandrotognoli/python-cdi
Python Code Dependency Injection Library
https://github.com/ettoreleandrotognoli/python-cdi
cdi dependency-injection di injection python
Last synced: 5 months ago
JSON representation
Python Code Dependency Injection Library
- Host: GitHub
- URL: https://github.com/ettoreleandrotognoli/python-cdi
- Owner: ettoreleandrotognoli
- License: bsd-3-clause
- Created: 2017-01-24T03:36:50.000Z (over 8 years ago)
- Default Branch: main
- Last Pushed: 2023-02-08T04:41:01.000Z (over 2 years ago)
- Last Synced: 2025-05-07T22:46:40.084Z (5 months ago)
- Topics: cdi, dependency-injection, di, injection, python
- Language: Python
- Homepage:
- Size: 135 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 10
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
=====
PyCDI
=====
.. image:: https://travis-ci.org/ettoreleandrotognoli/python-cdi.svg?branch=master
:target: https://travis-ci.org/ettoreleandrotognoli/python-cdi
.. image:: https://codecov.io/gh/ettoreleandrotognoli/python-cdi/branch/master/graph/badge.svg
:target: https://codecov.io/gh/ettoreleandrotognoli/python-cdi
.. image:: https://badge.fury.io/py/pycdi.svg
:target: https://badge.fury.io/py/pycdi
.. image:: https://img.shields.io/pypi/dm/pycdi.svg
:target: https://pypi.python.org/pypi/pycdi#downloads
.. image:: https://api.codeclimate.com/v1/badges/b17d7c12edab60606f4c/maintainability
:target: https://codeclimate.com/github/ettoreleandrotognoli/python-cdi/maintainability
:alt: Maintainability
.. image:: https://api.codeclimate.com/v1/badges/b17d7c12edab60606f4c/test_coverage
:target: https://codeclimate.com/github/ettoreleandrotognoli/python-cdi/test_coverage
:alt: Test Coverage
.. image:: https://www.codefactor.io/repository/github/ettoreleandrotognoli/python-cdi/badge
:target: https://www.codefactor.io/repository/github/ettoreleandrotognoli/python-cdi
:alt: CodeFactor
A simple Python CDI ( Code Dependency Injection) Library.
See the `code of conduct `_.
Install
-------
Install stable pycdi
.. code-block:: shell
pip install pycdi
Install latest pycdi
.. code-block:: shell
pip install git+https://github.com/ettoreleandrotognoli/python-cdi
Usage
-----
Python2 & Python3
~~~~~~~~~~~~~~~~~
You can see more examples in the examples folder (examples/common).
.. code-block:: python
import logging
from logging import Logger
from pycdi import Inject, Singleton, Producer
from pycdi.shortcuts import call
@Producer(str, _context='app_name')
def get_app_name():
return 'PyCDI'
@Singleton(produce_type=Logger)
@Inject(app_name=str, _context='app_name')
def get_logger(app_name):
return logging.getLogger(app_name)
@Inject(name=(str, 'app_name'), logger=Logger)
def main(name, logger):
logger.info('I\'m starting...')
print('Hello World!!!\nI\'m a example of %s' % name)
logger.debug('I\'m finishing...')
call(main)
Python 3
~~~~~~~~
With Python 3 it is possible to define the types of injection with Python type hints.
You can see more examples in the examples folder( examples/py3/ ).
.. code-block:: python
import logging
from logging import Logger
from pycdi import Inject, Singleton, Producer
from pycdi.shortcuts import call
@Producer(_context='app_name')
def get_app_name() -> str:
return 'PyCDI'
@Singleton()
@Inject(logger_name='app_name')
def get_logger(logger_name: str) -> Logger:
return logging.getLogger(logger_name)
@Inject(name='app_name')
def main(name: str, logger: Logger):
logger.info('I\'m starting...')
print('Hello World!!!\nI\'m an example of %s' % name)
logger.debug('I\'m finishing...')
call(main)