-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathref.py
More file actions
322 lines (273 loc) · 10.8 KB
/
Copy pathref.py
File metadata and controls
322 lines (273 loc) · 10.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
import inspect
import typing as t
from abc import ABC, abstractmethod
from pathlib import Path
from starlette.routing import BaseRoute, Mount
from ellar.constants import (
CONTROLLER_WATERMARK,
EXCEPTION_HANDLERS_KEY,
MIDDLEWARE_HANDLERS_KEY,
MODULE_METADATA,
MODULE_REF_TYPES,
MODULE_WATERMARK,
ON_REQUEST_SHUTDOWN_KEY,
ON_REQUEST_STARTUP_KEY,
TEMPLATE_FILTER_KEY,
TEMPLATE_GLOBAL_KEY,
)
from ellar.core.controller import ControllerType
from ellar.core.routing import ModuleMount
from ellar.core.routing.router.module import controller_router_factory
from ellar.core.templating import ModuleTemplating
from ellar.di import Container, ProviderConfig, injectable, is_decorated_with_injectable
from ellar.di.providers import ModuleProvider
from ellar.reflect import reflect
from .. import Config
from .base import ModuleBase, ModuleBaseMeta
if t.TYPE_CHECKING: # pragma: no cover
from ellar.core import App, ControllerBase
class InvalidModuleTypeException(Exception):
pass
def create_module_ref_factor(
module_type: t.Union[t.Type, t.Type[ModuleBase]],
config: Config,
container: Container,
**init_kwargs: t.Any,
) -> t.Union["ModuleRefBase", "ModuleTemplateRef"]:
module_ref: t.Union["ModuleRefBase", "ModuleTemplateRef"]
if reflect.get_metadata(MODULE_WATERMARK, module_type):
module_ref = ModuleTemplateRef(
module_type,
container=container,
config=config,
**init_kwargs,
)
return module_ref
elif type(module_type) == ModuleBaseMeta:
module_ref = ModulePlainRef(
module_type,
container=container,
config=config,
**init_kwargs,
)
return module_ref
raise InvalidModuleTypeException(
f"{module_type.__name__} must be a subclass of `ellar.core.ModuleBase`"
)
class ModuleRefBase(ABC):
ref_type: str = MODULE_REF_TYPES.PLAIN
@property
@abstractmethod
def container(self) -> Container:
"""gets module ref container"""
@property
@abstractmethod
def config(self) -> Config:
"""gets module ref config"""
@property
@abstractmethod
def module(self) -> t.Union[t.Type[ModuleBase], t.Type]:
"""gets module ref container"""
@property
def routes(self) -> t.List[BaseRoute]:
return []
def run_module_register_services(self) -> None:
self.module.before_init(config=self.config)
_module_type_instance = self.get_module_instance()
self.container.install(_module_type_instance) # support for injector module
# _module_type_instance.register_services(self.container)
def _build_init_kwargs(self, kwargs: t.Dict) -> t.Dict:
_result = dict()
if hasattr(self.module, "__init__"):
signature = inspect.signature(self.module.__init__)
for k, v in signature.parameters.items():
if (
v.kind == inspect.Parameter.KEYWORD_ONLY
or v.kind == inspect.Parameter.POSITIONAL_OR_KEYWORD
) and v.default != inspect.Parameter.empty:
_result[k] = v.default
_result.update(kwargs)
return _result
@abstractmethod
def _register_module(self) -> None:
"""Register Module"""
def get_module_instance(self) -> ModuleBase:
return self.container.injector.get(t.cast(t.Type[ModuleBase], self.module))
class ModulePlainRef(ModuleRefBase):
ref_type: str = MODULE_REF_TYPES.PLAIN
def __init__(
self,
module_type: t.Union[t.Type[ModuleBase], t.Type],
*,
container: Container,
config: Config,
**kwargs: t.Any,
) -> None:
assert (
type(module_type) == ModuleBaseMeta
), f"Module Type must be a subclass of ModuleBase;\n Invalid Type[{module_type}]"
self._module_type: t.Type[ModuleBase] = module_type
self._init_kwargs = self._build_init_kwargs(kwargs)
self._container = container
self._config = config
self._register_module()
@property
def module(self) -> t.Type[ModuleBase]:
return self._module_type
@property
def container(self) -> Container:
return self._container
@property
def config(self) -> Config:
return self._config
def _register_module(self) -> None:
_module = self.module
if not is_decorated_with_injectable(self.module):
_module = injectable()(self.module)
self.container.register(
_module, ModuleProvider(self.module, **self._init_kwargs)
)
class ModuleTemplateRef(ModuleRefBase, ModuleTemplating):
ref_type: str = MODULE_REF_TYPES.TEMPLATE
def __init__(
self,
module_type: t.Union[t.Type[ModuleBase], t.Type],
*,
container: Container,
config: Config,
**kwargs: t.Any,
) -> None:
assert (
type(module_type) == ModuleBaseMeta
), f"Module Type must be a subclass of ModuleBase;\n Invalid Type[{module_type}]"
self._module_type: t.Type[ModuleBase] = module_type
self._container = container
self._config = config
self._init_kwargs = self._build_init_kwargs(kwargs)
self._register_module()
self._template_folder: t.Optional[str] = reflect.get_metadata(
MODULE_METADATA.TEMPLATE_FOLDER, module_type
)
self._base_directory: t.Optional[t.Union[Path, str]] = reflect.get_metadata(
MODULE_METADATA.BASE_DIRECTORY, module_type
)
self._static_folder: t.Optional[str] = reflect.get_metadata(
MODULE_METADATA.STATIC_FOLDER, module_type
)
self._controllers: t.List[t.Type[ControllerBase]] = (
reflect.get_metadata(MODULE_METADATA.CONTROLLERS, self._module_type) or []
)
self._routers: t.Sequence[
t.Union[BaseRoute, ModuleMount, Mount]
] = self._get_all_routers()
self._flatten_routes: t.List[BaseRoute] = []
self.scan_templating_filters()
self.scan_request_events()
self.scan_exceptions_handlers()
self.scan_middle_ware()
@property
def module(self) -> t.Type[ModuleBase]:
return self._module_type
@property
def container(self) -> Container:
return self._container
@property
def config(self) -> Config:
return self._config
@property
def routers(self) -> t.Sequence[t.Union[BaseRoute, ModuleMount, Mount]]:
return self._routers
@property
def routes(self) -> t.List[BaseRoute]:
if not self._flatten_routes:
for router in self._routers:
if isinstance(router, ModuleMount):
self._flatten_routes.extend(router.get_flatten_routes())
continue
if isinstance(router, BaseRoute):
self._flatten_routes.append(router)
return self._flatten_routes
def run_module_register_services(self) -> None:
self.register_providers()
self.register_controllers()
super(ModuleTemplateRef, self).run_module_register_services()
def _register_module(self) -> None:
_module = self.module
if not is_decorated_with_injectable(self.module):
_module = injectable()(self.module)
self.container.register(
_module, ModuleProvider(self.module, **self._init_kwargs)
)
def scan_templating_filters(self) -> None:
templating_filter = (
reflect.get_metadata(TEMPLATE_FILTER_KEY, self._module_type) or {}
)
if not self._config.get(TEMPLATE_FILTER_KEY) or not isinstance(
self._config[TEMPLATE_FILTER_KEY], dict
):
self._config[TEMPLATE_FILTER_KEY] = dict()
self._config[TEMPLATE_FILTER_KEY].update(templating_filter)
templating_global_filter = (
reflect.get_metadata(TEMPLATE_GLOBAL_KEY, self._module_type) or {}
)
if not self._config.get(TEMPLATE_GLOBAL_KEY) or not isinstance(
self._config[TEMPLATE_GLOBAL_KEY], dict
):
self._config[TEMPLATE_GLOBAL_KEY] = dict()
self._config[TEMPLATE_GLOBAL_KEY].update(templating_global_filter)
def scan_exceptions_handlers(self) -> None:
exception_handlers = (
reflect.get_metadata(EXCEPTION_HANDLERS_KEY, self._module_type) or {}
)
self._config[EXCEPTION_HANDLERS_KEY].update(exception_handlers)
def scan_middle_ware(self) -> None:
middleware = (
reflect.get_metadata(MIDDLEWARE_HANDLERS_KEY, self._module_type) or []
)
if not self._config.get(MIDDLEWARE_HANDLERS_KEY) or not isinstance(
self._config[MIDDLEWARE_HANDLERS_KEY], list
):
self._config[MIDDLEWARE_HANDLERS_KEY] = []
self._config[MIDDLEWARE_HANDLERS_KEY].extend(middleware)
def register_providers(self) -> None:
providers = (
reflect.get_metadata(MODULE_METADATA.PROVIDERS, self._module_type) or []
)
for item in providers:
provider = item
if not isinstance(item, ProviderConfig):
provider = ProviderConfig(item)
provider.register(self._container)
def register_controllers(self) -> None:
for controller in self._controllers:
ProviderConfig(controller).register(self._container)
def run_application_ready(self, app: "App") -> None:
_module_type_instance = self._container.injector.get(self._module_type)
_module_type_instance.application_ready(app)
def _get_all_routers(self) -> t.Sequence[t.Union[ModuleMount, Mount, BaseRoute]]:
_routers = list(
reflect.get_metadata(MODULE_METADATA.ROUTERS, self._module_type) or []
)
for controller in self._controllers:
assert reflect.get_metadata(
CONTROLLER_WATERMARK, controller
) and isinstance(controller, ControllerType), "Invalid Controller Type."
_routers.append(controller_router_factory(controller))
return _routers
def scan_request_events(self) -> None:
request_startup = (
reflect.get_metadata(ON_REQUEST_STARTUP_KEY, self._module_type) or []
)
if not self._config.get(ON_REQUEST_STARTUP_KEY) or not isinstance(
self._config[ON_REQUEST_STARTUP_KEY], list
):
self._config[ON_REQUEST_STARTUP_KEY] = []
self._config[ON_REQUEST_STARTUP_KEY].extend(request_startup)
request_shutdown = (
reflect.get_metadata(ON_REQUEST_SHUTDOWN_KEY, self._module_type) or []
)
if not self._config.get(ON_REQUEST_SHUTDOWN_KEY) or not isinstance(
self._config[ON_REQUEST_SHUTDOWN_KEY], list
):
self._config[ON_REQUEST_SHUTDOWN_KEY] = []
self._config[ON_REQUEST_SHUTDOWN_KEY].extend(request_shutdown)