Skip to main content

A dependency injection library, aimed for the least amount of magic

Project description

deadsimple

A dependency injection library for python, aimed for the least amount of magic.

Heavily influenced by FastAPI's dependency injection classes and logic.

Simple Example

from dataclasses import dataclass
from deadsimple import Depends, resolve


@dataclass
class DepA():
    dep_b: DepB


@dataclass
class DepB():
    value: str


def get_dep_b() -> DepB:
    return DepB(value="some val")


def get_dep_a(dep_b: DepB = Depends(get_dep_b)) -> DepA:
    return DepA(dep_b=dep_b)


my_a = resolve(get_dep_a)

assert my_a.dep_b.value == "some val"

Dependencies will instantiate once per factory for each call to resolve.

@dataclass
class DepC():
    dep_a: DepA
    dep_b: DepB


def get_dep_c(
    dep_a: DepA = Depends(get_dep_a),
    dep_b: DepB = Depends(get_dep_b),
) -> DepC:

    return DepC(dep_a=dep_a, dep_b=dep_b)


my_c = resolve(get_dep_c)

assert my_c.dep_b is my_c.dep_a.dep_b

For Singleton use lru_cache or cache from functools

from functools import lru_cache
# or from functools import cache if you're 3.9+


@dataclass
class Singleton():
    pass


@dataclass
class NotSingleton():
    singleton_dep: Singleton


@lru_cache
def get_singleton() -> Singleton:
    return Singleton()


def get_not_singleton(singleton: Singleton = Depends(get_singleton)) -> NotSingleton:
    return NotSingleton(singleton_dep=singleton)


not_singleton_a = resolve(get_not_singleton)
not_singleton_b = resolve(get_not_singleton)

assert not_singleton_a is not not_singleton_b
assert not_singleton_a.singleton_dep is not_singleton_b.singleton_dep

Override dependencies:

override_dep_b = DepB(value="some other val")

my_a = resolve(get_dep_a, overrides={get_dep_b: override_dep_b})

assert my_a.dep_b.value == "some other val"

Generator factory methods:

def get_dep_b() -> DepB:
    print("enter b")
    yield DepB(value="some val")
    print("exit b")


def get_dep_a(dep_b: DepB = Depends(get_dep_b)) -> DepA:
    print("enter a")
    yield DepA(dep_b=dep_b)
    print("exit a")


resolve(get_dep_a)

# prints:
# enter b
# enter a
# exit a
# exit b

Lazy / optional resolution:

from deadsimple import Lazy


def get_dep_b() -> DepB:
    print("enter b")
    return DepB(value="some val")


def get_dep_a(dep_b = Lazy(get_dep_b)) -> DepA:
    print("enter a")
    return DepA(dep_b=dep_b.lazy)


resolve(get_dep_a)

# prints:
# enter a
# enter b

Controlled dependency lifetime scope:

from deadsimple import resolve_open


def get_dep_b() -> DepB:
    print("enter b")
    yield DepB(value="some val")
    print("exit b")


with resolve_open(get_dep_b) as dep_b:
    print("inside")

# prints:
# enter b
# inside
# exit b

Todo

  • Lazy resolution
  • Async support
  • Better performance benchmarks

Installing

pip install deadsimple

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

deadsimple-0.4.0.tar.gz (5.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

deadsimple-0.4.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file deadsimple-0.4.0.tar.gz.

File metadata

  • Download URL: deadsimple-0.4.0.tar.gz
  • Upload date:
  • Size: 5.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.8.11 Linux/5.13.0-27-generic

File hashes

Hashes for deadsimple-0.4.0.tar.gz
Algorithm Hash digest
SHA256 75e5effd8d812bd0e7329376efaa9b19b83b9c8d83dc1e8a1806ff0843be5225
MD5 a6632ae09ffe66e0e05d49b870b62d0c
BLAKE2b-256 4378c61b50860003abde6d0949107f54d8c5e1d7f59c284b2b15a5a6b1a5679d

See more details on using hashes here.

File details

Details for the file deadsimple-0.4.0-py3-none-any.whl.

File metadata

  • Download URL: deadsimple-0.4.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.8.11 Linux/5.13.0-27-generic

File hashes

Hashes for deadsimple-0.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f490d39cbe6a2abf3c2a8fa44949a873aeb7eaf1ac3a93593f8a7702a2466edb
MD5 0e3b618832d7cc9db78c89854144d0eb
BLAKE2b-256 ab76ac824e6d179dbaa3fcee16946f789b13759d0d3e41ee5c70c87cede903dc

See more details on using hashes here.

Supported by

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