Passed
Pull Request — master (#226)
by Steve
03:05
created

lagom.context_based   A

Complexity

Total Complexity 24

Size/Duplication

Total Lines 197
Duplicated Lines 19.29 %

Test Coverage

Coverage 91.03%

Importance

Changes 0
Metric Value
wmc 24
eloc 121
dl 38
loc 197
ccs 71
cts 78
cp 0.9103
rs 10
c 0
b 0
f 0

13 Methods

Rating   Name   Duplication   Size   Complexity  
A _ContextBoundFunction.__getattr__() 7 7 4
A _ContextBoundFunction.rebind() 4 4 1
A ContextContainer.partial() 0 11 1
A ContextContainer._context_type_def() 0 14 4
A ContextContainer.magic_partial() 0 13 1
A _ContextBoundFunction.__init__() 7 7 1
A ContextContainer._context_resolver() 0 9 1
A ContextContainer.__enter__() 0 15 4
A ContextContainer.__exit__() 0 4 2
A ContextContainer.__init__() 0 10 1
A ContextContainer._singleton_type_def() 0 5 1
A ContextContainer.clone() 0 9 1
A _ContextBoundFunction.__call__() 3 3 2

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1 1
import logging
2 1
from contextlib import ExitStack
3 1
from copy import copy
4 1
from functools import wraps
5 1
from typing import (
6
    Collection,
7
    Union,
8
    Type,
9
    TypeVar,
10
    Optional,
11
    cast,
12
    ContextManager,
13
    Iterator,
14
    Generator,
15
    Callable,
16
    List,
17
)
18
19 1
from lagom import Container
20 1
from lagom.compilaton import mypyc_attr
21 1
from lagom.definitions import ConstructionWithContainer, SingletonWrapper, Alias
22 1
from lagom.exceptions import InvalidDependencyDefinition
23 1
from lagom.interfaces import (
24
    ReadableContainer,
25
    SpecialDepDefinition,
26
    CallTimeContainerUpdate,
27
    ContainerBoundFunction,
28
)
29
30 1
X = TypeVar("X")
31
32
33 1 View Code Duplication
class _ContextBoundFunction(ContainerBoundFunction[X]):
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated in your project.
Loading history...
34
    """
35
    Represents an instance of a function bound to a context container
36
    """
37
38 1
    __slots__ = ("context_container", "partially_bound_function")
39
40 1
    context_container: "ContextContainer"
41 1
    partially_bound_function: ContainerBoundFunction
42
43 1
    __dict__ = dict()
44
45 1
    def __init__(
46
        self,
47
        context_container: "ContextContainer",
48
        partially_bound_function: ContainerBoundFunction,
49
    ):
50 1
        self.context_container = context_container
51 1
        self.partially_bound_function = partially_bound_function
52
53 1
    def __call__(self, *args, **kwargs) -> X:
54 1
        with self.context_container as c:
55 1
            return self.partially_bound_function.rebind(c)(*args, **kwargs)
56
57 1
    def rebind(self, container: ReadableContainer) -> "ContainerBoundFunction[X]":
58
        return wraps(self.partially_bound_function)(
59
            _ContextBoundFunction(
60
                self.context_container, self.partially_bound_function.rebind(container)
61
            )
62
        )
63
64 1
    def __getattr__(self, item):
65
        if item not in self.__slots__:
66
            raise Exception(f"{item} doesn't exist")
67
        if item == "context_container":
68
            return self.context_container
69
        if item == "partially_bound_function":
70
            return self.partially_bound_function
71
72
73 1
@mypyc_attr(allow_interpreted_subclasses=True)
74 1
class ContextContainer(Container):
75
    """
76
    Wraps a regular container but is a ContextManager for use within a `with`.
77
78
    >>> from tests.examples import SomeClass, SomeClassManager
79
    >>> from lagom import Container
80
    >>> from typing import ContextManager
81
    >>>
82
    >>> # The regular container
83
    >>> c = Container()
84
    >>>
85
    >>> # register a context manager for SomeClass
86
    >>> c[ContextManager[SomeClass]] = SomeClassManager
87
    >>>
88
    >>> context_c = ContextContainer(c, context_types=[SomeClass])
89
    >>> with context_c as c:
90
    ...     c[SomeClass]
91
    <tests.examples.SomeClass object at ...>
92
    """
93
94 1
    exit_stack: Optional[ExitStack] = None
95 1
    _context_types: Collection[Type]
96 1
    _context_singletons: Collection[Type]
97
98 1
    def __init__(
99
        self,
100
        container: Container,
101
        context_types: Collection[Type],
102
        context_singletons: Collection[Type] = tuple(),
103
        log_undefined_deps: Union[bool, logging.Logger] = False,
104
    ):
105 1
        self._context_types = context_types
106 1
        self._context_singletons = context_singletons
107 1
        super().__init__(container, log_undefined_deps)
108
109 1
    def clone(self) -> "ContextContainer":
110
        """returns a copy of the container
111
        :return:
112
        """
113 1
        return ContextContainer(
114
            self,
115
            context_types=self._context_types,
116
            context_singletons=self._context_singletons,
117
            log_undefined_deps=self._undefined_logger,
118
        )
119
120 1
    def __enter__(self):
121 1
        if not self.exit_stack:
122
            # All actual context definitions happen on a clone so that there's isolation between invocations
123 1
            in_context = self.clone()
124 1
            for dep_type in set(self._context_types):
125 1
                in_context[dep_type] = self._context_type_def(dep_type)
126 1
            for dep_type in set(self._context_singletons):
127 1
                in_context[dep_type] = self._singleton_type_def(dep_type)
128 1
            in_context.exit_stack = ExitStack()
129
130
            # The parent context manager keeps track of the inner clone
131 1
            self.exit_stack = ExitStack()
132 1
            self.exit_stack.enter_context(in_context)
133 1
            return in_context
134 1
        return self
135
136 1
    def __exit__(self, exc_type, exc_val, exc_tb):
137 1
        if self.exit_stack:
138 1
            self.exit_stack.close()
139 1
            self.exit_stack = None
140
141 1
    def partial(
142
        self,
143
        func: Callable[..., X],
144
        shared: Optional[List[Type]] = None,
145
        container_updater: Optional[CallTimeContainerUpdate] = None,
146
    ) -> ContainerBoundFunction[X]:
147 1
        base_partial = super(ContextContainer, self).partial(
148
            func, shared, container_updater
149
        )
150
151 1
        return wraps(base_partial)(_ContextBoundFunction(self, base_partial))
152
153 1
    def magic_partial(
154
        self,
155
        func: Callable[..., X],
156
        shared: Optional[List[Type]] = None,
157
        keys_to_skip: Optional[List[str]] = None,
158
        skip_pos_up_to: int = 0,
159
        container_updater: Optional[CallTimeContainerUpdate] = None,
160
    ) -> ContainerBoundFunction[X]:
161 1
        base_partial = super(ContextContainer, self).magic_partial(
162
            func, shared, keys_to_skip, skip_pos_up_to, container_updater
163
        )
164
165 1
        return wraps(base_partial)(_ContextBoundFunction(self, base_partial))
166
167 1
    def _context_type_def(self, dep_type: Type):
168 1
        type_def = self.get_definition(ContextManager[dep_type]) or self.get_definition(Iterator[dep_type]) or self.get_definition(Generator[dep_type, None, None])  # type: ignore
169 1
        if type_def is None:
170 1
            raise InvalidDependencyDefinition(
171
                f"A ContextManager[{dep_type}] should be defined. "
172
                f"This could be an Iterator[{dep_type}] or Generator[{dep_type}, None, None] "
173
                f"with the @contextmanager decorator"
174
            )
175 1
        if isinstance(type_def, Alias):
176
            # Without this we create a definition that points to
177
            # itself.
178 1
            type_def = copy(type_def)
179 1
            type_def.skip_definitions = True
180 1
        return ConstructionWithContainer(lambda c: self._context_resolver(c, type_def))  # type: ignore
181
182 1
    def _singleton_type_def(self, dep_type: Type):
183
        """
184
        The same as context_type_def but acts as a singleton within this container
185
        """
186 1
        return SingletonWrapper(self._context_type_def(dep_type))
187
188 1
    def _context_resolver(self, c: ReadableContainer, type_def: SpecialDepDefinition):
189
        """
190
        Takes an existing definition which must be a context manager. Returns
191
        the value of the context manager from __enter__ and then places the
192
        __exit__ in this container's exit stack
193
        """
194 1
        assert self.exit_stack, "Types can only be resolved within a with"
195 1
        context_manager = cast(ContextManager, type_def.get_instance(c))
196
        return self.exit_stack.enter_context(context_manager)
197