injector-api 0.0.9

python dependency injection library, BETA

Injector API

The Injector API is a lightweight dependency injection library designed to simplify the management of dependencies in Python projects.

Prerequisites

• Python 3.7 or higher
• A proper environment (virtualenv or conda recommended)

Installation

To install the Injector API, simply run the following pip command:

pip install injector-api

Usage

Configuring injectorConfig.py

After installation, you must configure the library to suit your project. Create a injectorConfig.py at the root of your project. This file should define the following variable:

MODULE_APPLICATION = "your_directory_name_here"

Replace your_directory_name_here with the name of the directory where your module.py resides.

Defining and Registering Dependencies in module.py

The module.py is a key file in the Injector API library structure. Here, you define and register the dependencies you wish to inject into your application.

Dependency Registration

To register dependencies, you first need to import the container from the library, then use the register method. This method takes the interface you wish to implement and its concrete implementation as arguments.

from injector_api.dependency import container

# Your interfaces and classes here

container.register(IExampleService, ExampleServiceImpl1, override=True)
container.register(IExampleService, ExampleServiceImpl2, override=True)
container.register(InterfaceWithoutOtherService, ImplInterface,override=True)

Injecting into Functions and Methods

Once your dependencies are registered in module.py, you can use the @inject decorator to inject these dependencies into functions or methods.

from injector_api.cargaDinamica import inject

@inject({IExampleService: 0})
def some_function(service: IExampleService):
    return service.do_something()

@inject()
def some_function_two(service: InterfaceWithoutOtherService):
    return service.do_something()

In the above example, the IExampleService dependency will be injected into the some_function, allowing you to use its methods and properties.

Location of module.py

Ensure that the module.py file is located in the directory you've specified in injectorConfig.py. This file will be automatically read by the library upon execution to load and manage dependencies.

Security Recommendations

While the Injector API simplifies dependency management, there are potential security risks when using dynamic loading. We recommend the following precautions:

• Always validate dynamically loaded information or modules.
• Avoid loading modules from locations that can be manipulated by untrusted users.
• Use a secure, isolated environment for your application.
• Keep the library and all its dependencies up to date.

Contribute

Contributions are welcome! Please submit pull requests or open issues on our GitHub repository.

License

This library is licensed under the MIT License. See the LICENSE file for details.