IoC framework driven by annotations and type hints
Project description
Touchstone
Touchstone is an annotations-driven Inversion of Control container for Python 3.6 and above.
Learn by Example
Auto Wiring
from touchstone import Container
class Child:
pass
class Parent:
def __init__(self, child: Child) -> None:
self.child = child
container = Container()
parent = container.make(Parent)
assert isinstance(parent.child, Child)
Interface Binding
from touchstone import Container
class AbstractChild:
pass
class Child(AbstractChild):
pass
class Parent:
def __init__(self, child: AbstractChild) -> None:
self.child = child
container = Container()
container.bind(AbstractChild, Child)
parent = container.make(Parent)
assert isinstance(parent.child, Child)
Binding with Factory Methods
from touchstone import Container
class Child:
def __init__(self, name: str) -> None:
self.name = name
class Parent:
def __init__(self, child: Child) -> None:
self.child = child
container = Container()
container.bind(Child, lambda: Child('them'))
parent = container.make(Parent)
assert isinstance(parent.child, Child)
assert parent.child.name == 'them'
Binding Singletons
from touchstone import Container, SINGLETON
class Child:
def __init__(self, name: str) -> None:
self.name = name
class Parent:
def __init__(self, child: Child) -> None:
self.child = child
container = Container()
them_child = Child('them')
container.bind_instance(Child, them_child)
# Or...
container.bind(Child, lambda: them_child, lifetime_strategy=SINGLETON)
parent = container.make(Parent)
assert isinstance(parent.child, Child)
assert parent.child is them_child
Contextual Binding
from touchstone import Container
class Child:
def __init__(self, name: str) -> None:
self.name = name
class Parent:
def __init__(self, child1: Child, child2: Child) -> None:
self.child1 = child1
self.child2 = child2
container = Container()
container.bind_contextual(when=Parent, wants=Child, wants_name='child1', give=lambda: Child('her'))
container.bind_contextual(when=Parent, wants=Child, wants_name='child2', give=lambda: Child('him'))
parent = container.make(Parent)
assert isinstance(parent.child1, Child)
assert isinstance(parent.child2, Child)
assert parent.child1.name == 'her'
assert parent.child2.name == 'him'
Django Support
Now featuring Django support! New in v0.3.0
- Configure your instance of
touchstone.Container
however you see fit. - In your main
settings.py
, setTOUCHSTONE_CONTAINER_GETTER
to the path to a callable that will return the instace oftouchstone.Container
your app uses.
To get injected properties in your class-based views:
- In your main
settings.py
, addtouchstone.django.InjectViewsMiddleware
to yourMIDDLEWARE
list. - Use class annotations on your class-based views. Cached Properties will be added to your view classes so that they automatically resolve using your configured touchstone container. For example:
class MyView(View):
something: MyObject
def get(self, request):
# You can now access self.something!
To get injected properties in your middleware, you'll need to do a little more work because we haven't found a good way to hook into Django's middleware instantiation logic.
from touchstone.django import get_container, MagicInjectedProperties
magic = MagicInjectedProperties(get_container())
@magic.set_magic_properties
class MyMixin:
something: MyObject
# define your mixin here...
# You'll be able to use `self.something` from within every instace method.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
touchstone-0.4.0.tar.gz
(7.7 kB
view hashes)
Built Distribution
touchstone-0.4.0-py3-none-any.whl
(22.1 kB
view hashes)
Close
Hashes for touchstone-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 21dbeda91bade2d3623b177cd07a7b5cd35a439fabc1d721812c1643a93bf0ab |
|
MD5 | a2b1e7a7dc5312f30a5757f6d09f3777 |
|
BLAKE2b-256 | 283f61fa4e75a5934b0cac860cb4864127b5bfd2ac4e6fa580a784be921be0a7 |