| Name | dilib JSON |
| Version |
1.1.0
JSON |
| download |
| home_page | None |
| Summary | Dependency injection (DI) library for Python |
| upload_time | 2025-10-20 21:17:32 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License. |
| keywords |
dependency injection
design patterns
di
inversion of control
ioc
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# dilib
Dependency injection (DI) library for Python
[](https://badge.fury.io/py/dilib)
[](https://pypi.python.org/pypi/dilib/)
[](https://github.com/ansatzcapital/dilib)
## Installation
`dilib` is available on [PyPI](https://pypi.org/project/dilib/):
```bash
pip install dilib
```
## Documentation
Documentation, design principles, and patterns are available [here](https://ansatzcapital.github.io/dilib).
Examples are available [here](https://github.com/ansatzcapital/dilib/tree/main/examples).
## About DI
[Dependency injection](https://en.wikipedia.org/wiki/Dependency_injection)
can be thought of as a **software engineering pattern**
as well as a **framework**. The goal is to describe and instantiate objects
in a more composable, modular, and uniform way.
The **pattern** is: when creating objects, always express what you depend on,
and let someone else give you those dependencies. (This is sometimes
referred to as the "Hollywood principle": "Don't call us; we'll call you." 😎)
The **framework** is meant to ease the inevitable boilerplate
that occurs when following this pattern, and `dilib` is one such framework.
It makes it easier to describe a large graph of dependent objects
and then instantiate only the objects you need as you need them.
## Quick Start
The framework takes a 3-step approach to configuring and instantiating objects.
Think of it like [mise en place](https://en.wikipedia.org/wiki/Mise_en_place),
a method of cooking where you prepare everything in its place
before taking actions.
The 3 steps are:
1. 🥣 **Prepare:** Describe the recipe of how objects are to be created and how
they depend on each via **specs** inside **configs**
2. 🔄 **Replace:** Optionally, perturb the configs
3. 🔥 **Create:** Create the **container**, which lazily instantiates only the
objects needed per user request
These are the 3 major components needed for these 3 steps:
- **Specs**: These are the recipes that
describe how to instantiate the object when needed later. Common specs
include:
- `dilib.Object(obj)`: Pass through precreated object (often used
for primitive config values).
- `dilib.Prototype(cls, *args, **kwargs)`: Whenever the container
is asked to create this object, call `cls(*args, **kwargs)`
each time (with no caching).
- `dilib.Singleton(cls, *args, **kwargs)`: Same as `Prototype`,
except the result is cached per config field per container.
- `dilib.Forward(other_spec)`: Forward this request to another spec.
Think of it like a [mux](https://en.wikipedia.org/wiki/Multiplexer)
or control switch.
- For more, see [Overview](https://ansatzcapital.github.io/dilib/latest/overview.html).
- `dilib.Config`: Configs give names to specs and also provide a
way to describe how the specs depend on each other. Configs can nest
and reference each other via **child configs**, defined in the same
syntax as specs. Configs can be arbitrarily perturbed programmatically.
- `dilib.Container`: This is the chef, i.e., the object retriever.
It's in charge of *materializing*/*instantiating* the aforementioned
delayed specs into actual instances and caching these objects when required,
(i.e., in the case of `dilib.Singleton`).
```python
from __future__ import annotations
import abc
import dataclasses
import dilib
# API
class Engine(abc.ABC):
pass
# An implementation of the engine API that makes network calls
@dataclasses.dataclass(frozen=True)
class DBEngine(Engine):
address: str
token: str | None = None
# An implementation of the engine API designed for testing
class MockEngine(Engine):
pass
# An object that depends on having an instance of an `Engine`
@dataclasses.dataclass(frozen=True)
class Car:
# Takes an `Engine` instance via "constructor injection"
engine: Engine
class EngineConfig(dilib.Config):
# Glboal inputs are provided by the config **user**
db_address = dilib.GlobalInput(str, default="some-db-address")
# Local inputs are provided by downstream config **author**
token_prefix = dilib.LocalInput(str)
# Simple primitives must be wrapped in `Object`
token_suffix = dilib.Object(".bar")
# Because this lambda is wrapped in a `Prototype`, it will
# only be called if required. Note how specs depend on other specs
# explicitly via named aliases.
token = dilib.Prototype(lambda x, y: x + y, x=token_prefix, y=token_suffix)
# `Singleton` is very much like `Prototype`, except the container
# will cache this instance by the key `db_engine0`
db_engine0 = dilib.Singleton(DBEngine, db_address, token=token)
# Alternate engine spec
db_engine1 = dilib.Singleton(DBEngine, db_address)
# Forward spec resolution to the target spec.
# Note how we widen the type of the object from `DBEngine` to `Engine`.
engine: Engine = dilib.Forward(db_engine0)
class CarConfig(dilib.Config):
# Configs can depend on other configs. Here, `CarConfig`
# depends on an `EngineConfig` (with local input value set).
engine_config = EngineConfig(token_prefix="baz")
# The idea is to reach into child configs and get whatever objects you
# need from there
car = dilib.Singleton(Car, engine_config.engine)
# Get instance of root config (with global input value set)
car_config = dilib.get_config(CarConfig, db_address="another-db-address")
# Perturb here as you'd like. Note that the new object
# doesn't need to have been set up by the config author beforehand.
car_config.engine_config.engine = dilib.Singleton(MockEngine)
# Create container from config
container = dilib.get_container(car_config)
# Retrieve objects from container (some of which are cached inside),
# all with IDE auto-complete and static type checking
assert container.config.engine_config.db_address == "another-db-address"
assert isinstance(container.config.engine_config.engine, MockEngine)
assert isinstance(container.config.car, Car)
assert container.config.car is container.car # Because it's a Singleton
```
Notes:
- `Car` *takes in* an `Engine` via its constructor
(known as ["constructor injection"](https://en.wikipedia.org/wiki/Dependency_injection#Constructor_injection)),
instead of making or getting one within itself.
- For this to work, `Car` cannot make any assumptions about
*what kind* of `Engine` it received. Different engines have different
constructor params but have the [same API and semantics](https://en.wikipedia.org/wiki/Liskov_substitution_principle).
- Both config wiring and `container.config` calls are all statically
type safe, meaning you should see auto-complete in your IDE and
everything should pass `mypy` and `pyright` checking.
## Features
### Overview
* 📇 **Global addressability:** `dilib` provides a way to map a
unique name to an object instance. E.g., with Python, you can come up
with a fully-qualified name of a class or symbol
(just `module_a.module_b.SomeClass`), but there is no natural parallel
for object *instances* (without resorting to global variables).
* ⧴ **Delayed instantiation:** If you're describing a very large graph
of objects, it's useful to delay instantiation such that you create
only the exact subgraph of objects required to fulfill the user's request
on the container. It's especially important that these instantiations
(which can have expensive compute or IO calls) not be done at import time.
* 🔄 **Ability to perturb with self-consistency guarantee:** Delayed
instantiation also provides a guarantee of self-consistency. If two or more
objects depend on a parameter, and that parameter is perturbed, you almost
certainly want both objects to see only the new value. By having a linear
set of steps to take--create config, perturb config, create container
(which *freezes* the config from further perturbations automatically)--you
know that all instantiations are performed exactly
after all perturbations have been performed.
See [below](#perturb-config-fields-with-ease).
* 🛠️ **Static auto-complete and type safety**: All attrs available
on a `container.config`, as well as specs and child configs,
are available statically to both the IDE and
any standard type checker like `mypy` and `pyright`.
Equivalent dynamic attrs for IPython/Jupyter sessions are also available.
All calls to specs like `dilib.Singleton`
are annotated with `ParamSpec`s, so static type checkers should
alert you if you get arg names wrong or mismatches in types.
* 🚫🌎 **Discourages global state:** Often, implementations
of the [singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern)
come with the baggage of global state. However, with `dilib`
(and DI in general), the lifecycle of an object is managed by the
authors of the config/bindings, not by the downstream clients of the object.
Thus, we can achieve a singleton lifecycle
with respect to all the objects in the *container*, instead of
with respect to all the objects in the *process*.
* ⌨️ **Optionally easier syntax:** If you don't mind "polluting" your object
model with references to the DI framework, you can opt into the easier
syntax mode, writing `MockEngine()` instead of `dilib.Singleton(MockEngine)`.
See [Easier syntax](https://ansatzcapital.github.io/dilib/latest/patterns.html#easier-syntax).
### Perturb Config Fields with Ease
A major goal of `dilib` is the ability to perturb any config field
and have a guarantee that, when instantiated, all objects that depend on
that field will see the same perturbed value.
This enables the user to easily perform param scans, integration tests,
meta-optimizers, and more, even with params that are deeply
embedded in the system. Furthermore, these can be performed in the
same process, side-by-side. E.g.:
```python
def get_container(
db_address: str = "db-address",
perturb_func: Callable[[CarConfig], None] | None = None,
) -> dilib.Container[CarConfig]:
"""Helper for users to get container instance.
This should only be called at the application level, never by
a function in a library.
"""
config = dilib.get_config(CarConfig, db_address=db_address)
if perturb_func is not None:
perturb_func(config)
return dilib.get_container(config)
def perturb_func_a(config: CarConfig) -> None:
config.engine_config.token = "a"
def perturb_func_b(config: CarConfig) -> None:
config.engine_config.token = "b"
# Create multiple containers for each perturbation
container_a = get_container(perturb_func=perturb_func_a)
container_b = get_container(perturb_func=perturb_func_b)
# Get cars corresponding to each perturbation, all in the same process space.
# No matter what object we get from `container_a`, it will only have been
# created using objects that have seen `token = "a"` perturbation.
car_a = container_a.config.car
car_b = container_a.config.car
```
Raw data
{
"_id": null,
"home_page": null,
"name": "dilib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "dependency injection, design patterns, di, inversion of control, ioc",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d7/e5/11685eba469e5fa98d2ea17cb077c425e122eb76aba83b36e70a3c395a38/dilib-1.1.0.tar.gz",
"platform": null,
"description": "# dilib\n\nDependency injection (DI) library for Python\n\n[](https://badge.fury.io/py/dilib)\n[](https://pypi.python.org/pypi/dilib/)\n[](https://github.com/ansatzcapital/dilib)\n\n## Installation\n\n`dilib` is available on [PyPI](https://pypi.org/project/dilib/):\n\n```bash\npip install dilib\n```\n\n## Documentation\n\nDocumentation, design principles, and patterns are available [here](https://ansatzcapital.github.io/dilib).\n\nExamples are available [here](https://github.com/ansatzcapital/dilib/tree/main/examples).\n\n## About DI\n\n[Dependency injection](https://en.wikipedia.org/wiki/Dependency_injection)\ncan be thought of as a **software engineering pattern**\nas well as a **framework**. The goal is to describe and instantiate objects\nin a more composable, modular, and uniform way.\n\nThe **pattern** is: when creating objects, always express what you depend on,\nand let someone else give you those dependencies. (This is sometimes\nreferred to as the \"Hollywood principle\": \"Don't call us; we'll call you.\" \ud83d\ude0e)\n\nThe **framework** is meant to ease the inevitable boilerplate\nthat occurs when following this pattern, and `dilib` is one such framework.\nIt makes it easier to describe a large graph of dependent objects\nand then instantiate only the objects you need as you need them.\n\n## Quick Start\n\nThe framework takes a 3-step approach to configuring and instantiating objects.\nThink of it like [mise en place](https://en.wikipedia.org/wiki/Mise_en_place),\na method of cooking where you prepare everything in its place\nbefore taking actions.\n\nThe 3 steps are:\n\n1. \ud83e\udd63 **Prepare:** Describe the recipe of how objects are to be created and how\nthey depend on each via **specs** inside **configs**\n2. \ud83d\udd04 **Replace:** Optionally, perturb the configs\n3. \ud83d\udd25 **Create:** Create the **container**, which lazily instantiates only the\nobjects needed per user request\n\nThese are the 3 major components needed for these 3 steps:\n\n- **Specs**: These are the recipes that\ndescribe how to instantiate the object when needed later. Common specs\ninclude:\n - `dilib.Object(obj)`: Pass through precreated object (often used\n for primitive config values).\n - `dilib.Prototype(cls, *args, **kwargs)`: Whenever the container\n is asked to create this object, call `cls(*args, **kwargs)`\n each time (with no caching).\n - `dilib.Singleton(cls, *args, **kwargs)`: Same as `Prototype`,\n except the result is cached per config field per container.\n - `dilib.Forward(other_spec)`: Forward this request to another spec.\n Think of it like a [mux](https://en.wikipedia.org/wiki/Multiplexer)\n or control switch.\n - For more, see [Overview](https://ansatzcapital.github.io/dilib/latest/overview.html).\n- `dilib.Config`: Configs give names to specs and also provide a\nway to describe how the specs depend on each other. Configs can nest\nand reference each other via **child configs**, defined in the same\nsyntax as specs. Configs can be arbitrarily perturbed programmatically.\n- `dilib.Container`: This is the chef, i.e., the object retriever.\nIt's in charge of *materializing*/*instantiating* the aforementioned\ndelayed specs into actual instances and caching\u00a0these objects when required,\n(i.e., in the case of `dilib.Singleton`).\n\n```python\nfrom __future__ import annotations\n\nimport abc\nimport dataclasses\n\nimport dilib\n\n\n# API\nclass Engine(abc.ABC):\n pass\n\n\n# An implementation of the engine API that makes network calls\n@dataclasses.dataclass(frozen=True)\nclass DBEngine(Engine):\n address: str\n token: str | None = None\n\n\n# An implementation of the engine API designed for testing\nclass MockEngine(Engine):\n pass\n\n\n# An object that depends on having an instance of an `Engine`\n@dataclasses.dataclass(frozen=True)\nclass Car:\n # Takes an `Engine` instance via \"constructor injection\"\n engine: Engine\n\n\nclass EngineConfig(dilib.Config):\n # Glboal inputs are provided by the config **user**\n db_address = dilib.GlobalInput(str, default=\"some-db-address\")\n\n # Local inputs are provided by downstream config **author**\n token_prefix = dilib.LocalInput(str)\n\n # Simple primitives must be wrapped in `Object`\n token_suffix = dilib.Object(\".bar\")\n\n # Because this lambda is wrapped in a `Prototype`, it will\n # only be called if required. Note how specs depend on other specs\n # explicitly via named aliases.\n token = dilib.Prototype(lambda x, y: x + y, x=token_prefix, y=token_suffix)\n\n # `Singleton` is very much like `Prototype`, except the container\n # will cache this instance by the key `db_engine0`\n db_engine0 = dilib.Singleton(DBEngine, db_address, token=token)\n\n # Alternate engine spec\n db_engine1 = dilib.Singleton(DBEngine, db_address)\n\n # Forward spec resolution to the target spec.\n # Note how we widen the type of the object from `DBEngine` to `Engine`.\n engine: Engine = dilib.Forward(db_engine0)\n\n\nclass CarConfig(dilib.Config):\n # Configs can depend on other configs. Here, `CarConfig`\n # depends on an `EngineConfig` (with local input value set).\n engine_config = EngineConfig(token_prefix=\"baz\")\n\n # The idea is to reach into child configs and get whatever objects you\n # need from there\n car = dilib.Singleton(Car, engine_config.engine)\n\n\n# Get instance of root config (with global input value set)\ncar_config = dilib.get_config(CarConfig, db_address=\"another-db-address\")\n\n# Perturb here as you'd like. Note that the new object\n# doesn't need to have been set up by the config author beforehand.\ncar_config.engine_config.engine = dilib.Singleton(MockEngine)\n\n# Create container from config\ncontainer = dilib.get_container(car_config)\n\n# Retrieve objects from container (some of which are cached inside),\n# all with IDE auto-complete and static type checking\nassert container.config.engine_config.db_address == \"another-db-address\"\nassert isinstance(container.config.engine_config.engine, MockEngine)\nassert isinstance(container.config.car, Car)\nassert container.config.car is container.car # Because it's a Singleton\n```\n\nNotes:\n\n- `Car` *takes in* an `Engine` via its constructor\n(known as [\"constructor injection\"](https://en.wikipedia.org/wiki/Dependency_injection#Constructor_injection)),\ninstead of making or getting one within itself.\n- For this to work, `Car` cannot make any assumptions about\n*what kind* of `Engine` it received. Different engines have different\nconstructor params but have the [same API and semantics](https://en.wikipedia.org/wiki/Liskov_substitution_principle).\n- Both config wiring and `container.config` calls are all statically\ntype safe, meaning you should see auto-complete in your IDE and\neverything should pass `mypy` and `pyright` checking.\n\n## Features\n\n### Overview\n\n* \ud83d\udcc7 **Global addressability:** `dilib` provides a way to map a\nunique name to an object instance. E.g., with Python, you can come up\nwith a fully-qualified name of a class or symbol\n(just `module_a.module_b.SomeClass`), but there is no natural parallel\nfor object *instances* (without resorting to global variables).\n* \u29f4 **Delayed instantiation:** If you're describing a very large graph\nof objects, it's useful to delay instantiation such that you create\nonly the exact subgraph of objects required to fulfill the user's request\non the container. It's especially important that these instantiations\n(which can have expensive compute or IO calls) not be done at import time.\n* \ud83d\udd04 **Ability to perturb with self-consistency guarantee:** Delayed\ninstantiation also provides a guarantee of self-consistency. If two or more\nobjects depend on a parameter, and that parameter is perturbed, you almost\ncertainly want both objects to see only the new value. By having a linear\nset of steps to take--create config, perturb config, create container\n(which *freezes* the config from further perturbations automatically)--you\nknow that all instantiations are performed exactly\nafter all perturbations have been performed.\nSee [below](#perturb-config-fields-with-ease).\n* \ud83d\udee0\ufe0f **Static auto-complete and type safety**: All attrs available\non a `container.config`, as well as specs and child configs,\nare available statically to both the IDE and\nany standard type checker like `mypy` and `pyright`.\nEquivalent dynamic attrs for IPython/Jupyter sessions are also available.\nAll calls to specs like `dilib.Singleton`\nare annotated with `ParamSpec`s, so static type checkers should\nalert you if you get arg names wrong or mismatches in types.\n* \ud83d\udeab\ud83c\udf0e **Discourages global state:** Often, implementations\nof the [singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern)\ncome with the baggage of global state. However, with `dilib`\n(and DI in general), the lifecycle of an object is managed by the\nauthors of the config/bindings, not by the downstream clients of the object.\nThus, we can achieve a singleton lifecycle\nwith respect to all the objects in the *container*, instead of\nwith respect to all the objects in the *process*.\n* \u2328\ufe0f **Optionally easier syntax:** If you don't mind \"polluting\" your object\nmodel with references to the DI framework, you can opt into the easier\nsyntax mode, writing `MockEngine()` instead of `dilib.Singleton(MockEngine)`.\nSee [Easier syntax](https://ansatzcapital.github.io/dilib/latest/patterns.html#easier-syntax).\n\n### Perturb Config Fields with Ease\n\nA major goal of `dilib` is the ability to perturb any config field\nand have a guarantee that, when instantiated, all objects that depend on\nthat field will see the same perturbed value.\n\nThis enables the user to easily perform param scans, integration tests,\nmeta-optimizers, and more, even with params that are deeply\nembedded in the system. Furthermore, these can be performed in the\nsame process, side-by-side. E.g.:\n\n```python\ndef get_container(\n db_address: str = \"db-address\",\n perturb_func: Callable[[CarConfig], None] | None = None,\n) -> dilib.Container[CarConfig]:\n \"\"\"Helper for users to get container instance.\n\n This should only be called at the application level, never by\n a function in a library.\n \"\"\"\n\n config = dilib.get_config(CarConfig, db_address=db_address)\n\n if perturb_func is not None:\n perturb_func(config)\n\n return dilib.get_container(config)\n\n\ndef perturb_func_a(config: CarConfig) -> None:\n config.engine_config.token = \"a\"\n\n\ndef perturb_func_b(config: CarConfig) -> None:\n config.engine_config.token = \"b\"\n\n\n# Create multiple containers for each perturbation\ncontainer_a = get_container(perturb_func=perturb_func_a)\ncontainer_b = get_container(perturb_func=perturb_func_b)\n\n# Get cars corresponding to each perturbation, all in the same process space.\n# No matter what object we get from `container_a`, it will only have been\n# created using objects that have seen `token = \"a\"` perturbation.\ncar_a = container_a.config.car\ncar_b = container_a.config.car\n```\n",
"bugtrack_url": null,
"license": "Apache License\n Version 2.0, January 2004\n http://www.apache.org/licenses/\n \n TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION\n \n 1. Definitions.\n \n \"License\" shall mean the terms and conditions for use, reproduction,\n and distribution as defined by Sections 1 through 9 of this document.\n \n \"Licensor\" shall mean the copyright owner or entity authorized by\n the copyright owner that is granting the License.\n \n \"Legal Entity\" shall mean the union of the acting entity and all\n other entities that control, are controlled by, or are under common\n control with that entity. For the purposes of this definition,\n \"control\" means (i) the power, direct or indirect, to cause the\n direction or management of such entity, whether by contract or\n otherwise, or (ii) ownership of fifty percent (50%) or more of the\n outstanding shares, or (iii) beneficial ownership of such entity.\n \n \"You\" (or \"Your\") shall mean an individual or Legal Entity\n exercising permissions granted by this License.\n \n \"Source\" form shall mean the preferred form for making modifications,\n including but not limited to software source code, documentation\n source, and configuration files.\n \n \"Object\" form shall mean any form resulting from mechanical\n transformation or translation of a Source form, including but\n not limited to compiled object code, generated documentation,\n and conversions to other media types.\n \n \"Work\" shall mean the work of authorship, whether in Source or\n Object form, made available under the License, as indicated by a\n copyright notice that is included in or attached to the work\n (an example is provided in the Appendix below).\n \n \"Derivative Works\" shall mean any work, whether in Source or Object\n form, that is based on (or derived from) the Work and for which the\n editorial revisions, annotations, elaborations, or other modifications\n represent, as a whole, an original work of authorship. For the purposes\n of this License, Derivative Works shall not include works that remain\n separable from, or merely link (or bind by name) to the interfaces of,\n the Work and Derivative Works thereof.\n \n \"Contribution\" shall mean any work of authorship, including\n the original version of the Work and any modifications or additions\n to that Work or Derivative Works thereof, that is intentionally\n submitted to Licensor for inclusion in the Work by the copyright owner\n or by an individual or Legal Entity authorized to submit on behalf of\n the copyright owner. For the purposes of this definition, \"submitted\"\n means any form of electronic, verbal, or written communication sent\n to the Licensor or its representatives, including but not limited to\n communication on electronic mailing lists, source code control systems,\n and issue tracking systems that are managed by, or on behalf of, the\n Licensor for the purpose of discussing and improving the Work, but\n excluding communication that is conspicuously marked or otherwise\n designated in writing by the copyright owner as \"Not a Contribution.\"\n \n \"Contributor\" shall mean Licensor and any individual or Legal Entity\n on behalf of whom a Contribution has been received by Licensor and\n subsequently incorporated within the Work.\n \n 2. Grant of Copyright License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n copyright license to reproduce, prepare Derivative Works of,\n publicly display, publicly perform, sublicense, and distribute the\n Work and such Derivative Works in Source or Object form.\n \n 3. Grant of Patent License. Subject to the terms and conditions of\n this License, each Contributor hereby grants to You a perpetual,\n worldwide, non-exclusive, no-charge, royalty-free, irrevocable\n (except as stated in this section) patent license to make, have made,\n use, offer to sell, sell, import, and otherwise transfer the Work,\n where such license applies only to those patent claims licensable\n by such Contributor that are necessarily infringed by their\n Contribution(s) alone or by combination of their Contribution(s)\n with the Work to which such Contribution(s) was submitted. If You\n institute patent litigation against any entity (including a\n cross-claim or counterclaim in a lawsuit) alleging that the Work\n or a Contribution incorporated within the Work constitutes direct\n or contributory patent infringement, then any patent licenses\n granted to You under this License for that Work shall terminate\n as of the date such litigation is filed.\n \n 4. Redistribution. You may reproduce and distribute copies of the\n Work or Derivative Works thereof in any medium, with or without\n modifications, and in Source or Object form, provided that You\n meet the following conditions:\n \n (a) You must give any other recipients of the Work or\n Derivative Works a copy of this License; and\n \n (b) You must cause any modified files to carry prominent notices\n stating that You changed the files; and\n \n (c) You must retain, in the Source form of any Derivative Works\n that You distribute, all copyright, patent, trademark, and\n attribution notices from the Source form of the Work,\n excluding those notices that do not pertain to any part of\n the Derivative Works; and\n \n (d) If the Work includes a \"NOTICE\" text file as part of its\n distribution, then any Derivative Works that You distribute must\n include a readable copy of the attribution notices contained\n within such NOTICE file, excluding those notices that do not\n pertain to any part of the Derivative Works, in at least one\n of the following places: within a NOTICE text file distributed\n as part of the Derivative Works; within the Source form or\n documentation, if provided along with the Derivative Works; or,\n within a display generated by the Derivative Works, if and\n wherever such third-party notices normally appear. The contents\n of the NOTICE file are for informational purposes only and\n do not modify the License. You may add Your own attribution\n notices within Derivative Works that You distribute, alongside\n or as an addendum to the NOTICE text from the Work, provided\n that such additional attribution notices cannot be construed\n as modifying the License.\n \n You may add Your own copyright statement to Your modifications and\n may provide additional or different license terms and conditions\n for use, reproduction, or distribution of Your modifications, or\n for any such Derivative Works as a whole, provided Your use,\n reproduction, and distribution of the Work otherwise complies with\n the conditions stated in this License.\n \n 5. Submission of Contributions. Unless You explicitly state otherwise,\n any Contribution intentionally submitted for inclusion in the Work\n by You to the Licensor shall be under the terms and conditions of\n this License, without any additional terms or conditions.\n Notwithstanding the above, nothing herein shall supersede or modify\n the terms of any separate license agreement you may have executed\n with Licensor regarding such Contributions.\n \n 6. Trademarks. This License does not grant permission to use the trade\n names, trademarks, service marks, or product names of the Licensor,\n except as required for reasonable and customary use in describing the\n origin of the Work and reproducing the content of the NOTICE file.\n \n 7. Disclaimer of Warranty. Unless required by applicable law or\n agreed to in writing, Licensor provides the Work (and each\n Contributor provides its Contributions) on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\n implied, including, without limitation, any warranties or conditions\n of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A\n PARTICULAR PURPOSE. You are solely responsible for determining the\n appropriateness of using or redistributing the Work and assume any\n risks associated with Your exercise of permissions under this License.\n \n 8. Limitation of Liability. In no event and under no legal theory,\n whether in tort (including negligence), contract, or otherwise,\n unless required by applicable law (such as deliberate and grossly\n negligent acts) or agreed to in writing, shall any Contributor be\n liable to You for damages, including any direct, indirect, special,\n incidental, or consequential damages of any character arising as a\n result of this License or out of the use or inability to use the\n Work (including but not limited to damages for loss of goodwill,\n work stoppage, computer failure or malfunction, or any and all\n other commercial damages or losses), even if such Contributor\n has been advised of the possibility of such damages.\n \n 9. Accepting Warranty or Additional Liability. While redistributing\n the Work or Derivative Works thereof, You may choose to offer,\n and charge a fee for, acceptance of support, warranty, indemnity,\n or other liability obligations and/or rights consistent with this\n License. However, in accepting such obligations, You may act only\n on Your own behalf and on Your sole responsibility, not on behalf\n of any other Contributor, and only if You agree to indemnify,\n defend, and hold each Contributor harmless for any liability\n incurred by, or claims asserted against, such Contributor by reason\n of your accepting any such warranty or additional liability.\n \n END OF TERMS AND CONDITIONS\n \n APPENDIX: How to apply the Apache License to your work.\n \n To apply the Apache License to your work, attach the following\n boilerplate notice, with the fields enclosed by brackets \"[]\"\n replaced with your own identifying information. (Don't include\n the brackets!) The text should be enclosed in the appropriate\n comment syntax for the file format. We also recommend that a\n file or class name and description of purpose be included on the\n same \"printed page\" as the copyright notice for easier\n identification within third-party archives.\n \n Copyright [yyyy] [name of copyright owner]\n \n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n \n http://www.apache.org/licenses/LICENSE-2.0\n \n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.",
"summary": "Dependency injection (DI) library for Python",
"version": "1.1.0",
"project_urls": {
"Documentation": "https://ansatzcapital.github.io/dilib",
"Homepage": "https://github.com/ansatzcapital/dilib",
"Packaging": "https://pypi.org/project/dilib",
"Source": "https://github.com/ansatzcapital/dilib",
"Tracker": "https://github.com/ansatzcapital/dilib/issues"
},
"split_keywords": [
"dependency injection",
" design patterns",
" di",
" inversion of control",
" ioc"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2f6ebe20117c555b6a18998c1100aa8b2393a08b52a0e2b3a0083e012826f59e",
"md5": "c43c50be4c9d515fe6c8c55901ff33f8",
"sha256": "bf7aae40bcb4c193bec16d2d4358bacb35b97fd5b445d20560d55a4758ccbeaa"
},
"downloads": -1,
"filename": "dilib-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c43c50be4c9d515fe6c8c55901ff33f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 36657,
"upload_time": "2025-10-20T21:17:31",
"upload_time_iso_8601": "2025-10-20T21:17:31.286479Z",
"url": "https://files.pythonhosted.org/packages/2f/6e/be20117c555b6a18998c1100aa8b2393a08b52a0e2b3a0083e012826f59e/dilib-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d7e511685eba469e5fa98d2ea17cb077c425e122eb76aba83b36e70a3c395a38",
"md5": "ae1e4976c3b0d6df382c9943d84c2733",
"sha256": "107643693a4abd6385cff6d37e74e132f8352dc12ca71794a32923b5a6b585e5"
},
"downloads": -1,
"filename": "dilib-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "ae1e4976c3b0d6df382c9943d84c2733",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 53548,
"upload_time": "2025-10-20T21:17:32",
"upload_time_iso_8601": "2025-10-20T21:17:32.223356Z",
"url": "https://files.pythonhosted.org/packages/d7/e5/11685eba469e5fa98d2ea17cb077c425e122eb76aba83b36e70a3c395a38/dilib-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-20 21:17:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansatzcapital",
"github_project": "dilib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "dilib"
}
