https://github.com/steinitzu/giveme
A simple python dependency injector
https://github.com/steinitzu/giveme
dependency-injection di-framework inversion-of-control python python3-library
Last synced: about 1 month ago
JSON representation
A simple python dependency injector
- Host: GitHub
- URL: https://github.com/steinitzu/giveme
- Owner: steinitzu
- License: mit
- Created: 2017-05-20T21:25:27.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-08-08T20:39:23.000Z (over 1 year ago)
- Last Synced: 2025-03-13T17:05:55.560Z (about 1 month ago)
- Topics: dependency-injection, di-framework, inversion-of-control, python, python3-library
- Language: Python
- Size: 61.5 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
- [Documentation](#org7e529b6)
- [Quick start](#org07a14b0)
- [Install](#orgfce85dd)
- [Changes in version 1.0](#orgd8ed99f)
- [Migrating from <1.0](#org4c92880)
- [Testing](#orgdce1e44)
- [Contributing](#org6ef425e)
[](https://travis-ci.org/steinitzu/giveme)
# Giveme: dependency injection for python
GiveMe is a simple, no-nonsense dependency injection framework for python.
Its features include:
- Simple `register` and `inject` decorators to register dependency factories or classes and inject their return value into other function/method arguments.
- Painfree configuration for singleton and thread local dependencies
- Injected dependencies can always be overridden by manually passed arguments (great for testing)
# Documentation
Examples and API documentation can be found on ReadTheDocs:
# Quick start
```python
from giveme import Injector
injector = Injector()
@injector.register
def magic_number():
return 42
@injector.inject
def multiply(n, magic_number):
return n*magic_number
multiply(2)
```
```python
84
```
GiveMe has many more advanced options, for more examples and full API documentation please visit
# Install
`pip install giveme`
Python3.8 and up are supported.
# Changes in version 1.0
GiveMe has received some improvements in 1.0:
- New `Injector` class with `register` and `inject` decorators as instance methods. To support more than one dependency registry in a project.
- Module level decoraters `giveme.register` and `giveme.inject` have been deprecated, `Injector.register` and `Injector.inject` should be used instead.
- Vastly improved argument binding in `Injector.inject` which acts in accordance to default python argument binding. Better distinction between injected arguments and manually passed arguments.
- `DependencyNotFoundError` thrown from `inject` when an explicitly mapped (e.g. argname='dependencyname') dependency is not registered or passed in manually for easier debugging
- `DependencyNotFoundWarning` raised in ambigious cases where an argument is not explicitly mapped to dependency and not passed in manually.
## Migrating from <1.0
The API is mostly the same. If you were using the module levels decorators in a standard way before:
```python
from giveme import register, inject
@register
def something():
...
@inject
def do_stuff(something):
...
```
The only change you'll have to make is to create an instance of `Injector` and use its instance method decorators instead:
```python
from giveme import Injector
injector = Injector()
@injector.register
def something():
...
@injector.inject
def do_stuff(something):
...
```
# Testing
You can run the included test suite with pytest
1. Clone this repository
2. cd path/to/giveme
3. Install pytest -> `pip install pytest`
4. Run the tests -> `pytest tests.py`
# Contributing
Pull requests are welcome. Please post any bug reports, questions and suggestions to the issue tracker