ettoreleandrotognoli/python-cdi

=====
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 <CODE_OF_CONDUCT.md>`_.

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)