Skip to main content

Implementation of dependency injection for Python 3

Project description

Build pypi versions codecov license

Implementation of dependency injection for Python 3

Features:

  • types resolution by signature types annotations (type hints)
  • types resolution by class annotations (type hints)
  • types resolution by names and aliases (convention over configuration)
  • unintrusive: builds objects graph without the need to change the source code of classes
  • minimum overhead to obtain services, once the objects graph is built
  • support for singletons, transient, and scoped services

This library is freely inspired by .NET Standard Microsoft.Extensions.DependencyInjection implementation (ref. MSDN, Dependency injection in ASP.NET Core, Using dependency injection in a .Net Core console application). The ContainerProtocol for v2 is inspired by punq.

Installation

pip install neoteroi-di

neoteroi-di is the new version of the library that was previously named rodi. It is currently alpha and still subject to change.

Efficient

neoteroi-di works by inspecting code once at runtime, to generate functions that return instances of desired types - as long as the object graph is not altered. Inspections are done either on constructors (__init__) or class annotations. Validation steps, for example to detect circular dependencies or missing services, are done when building these functions, so additional validation is not needed when activating services.

Flexible

neoteroi-di offers two code APIs:

  • one is kept as generic as possible, using a ContainerProtocol for scenarios in which it is desirable being able to replace neoteroi-di with alternative implementations of dependency injection for Python. The protocol only expects a class being able to register and resolve types, and to tell if a type is configured in it (__contains__). Even if other implementations of DI don´t implement these three methods, it should be easy to use composition to wrap other libraries with a compatible class.
  • one is a more concrete implementation, following the previous implementation in rodi, for scenarios where it's not desirable to consider alternative implementations of dependency injection.

For this reason, the examples report two ways to achieve certain things.

Examples

For examples, refer to the examples folder.

Recommended practices

All services should be configured once, when an application starts, and the object graph should not be altered during normal program execution. Example: if you build a web application, configure the object graph when bootstrapping the application, avoid altering the Container configuration while handling web requests.

Aim at keeping the Container and service graphs abstracted from the front-end layer of your application, and avoid mixing runtime values with container configuration. Example: if you build a web application, avoid if possible relying on the HTTP Request object being a service registered in your container.

Service life style:

  • singleton - instantiated only once per service provider
  • transient - services are instantiated every time they are required
  • scoped - instantiated only once per root service resolution call (e.g. once per web request)

Usage in BlackSheep

neoteroi-di is used in the second version of BlackSheep web framework to implement dependency injection for request handlers.

Documentation

Under construction. 🚧

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

neoteroi_di-0.0.4.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

neoteroi_di-0.0.4-py3-none-any.whl (14.6 kB view details)

Uploaded Python 3

File details

Details for the file neoteroi_di-0.0.4.tar.gz.

File metadata

  • Download URL: neoteroi_di-0.0.4.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.15

File hashes

Hashes for neoteroi_di-0.0.4.tar.gz
Algorithm Hash digest
SHA256 109eff8f72e340bc44088a0799ca06f60f3e33bf4358aba0eb0841e64bb205b3
MD5 ba5d05bfc26813046c6bcbacf8cfc42f
BLAKE2b-256 cd63716fae4d7c71aec3d30e0ae88acb872f87fdfc82962ad6f0a45292c7f5c7

See more details on using hashes here.

File details

Details for the file neoteroi_di-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: neoteroi_di-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 14.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.7.15

File hashes

Hashes for neoteroi_di-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3266b0617cf0005463c5ae34ddfdd83448b2cf1a266ed6f6da25ad0fbb640f80
MD5 40c271f86e93eb5209377584e3ec54cc
BLAKE2b-256 46b20489ca3d2427d21b7f3b7140b9d8e2bb658fd9d804b8471c821dcfce2280

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page