-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathmodule.py
More file actions
55 lines (39 loc) · 1.73 KB
/
Copy pathmodule.py
File metadata and controls
55 lines (39 loc) · 1.73 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
import typing as t
if t.TYPE_CHECKING: # pragma: no cover
from ellar.core.modules import DynamicModule, ModuleSetup
class IModuleSetup:
"""Modules that must have a custom setup should inherit from IModuleSetup"""
@classmethod
@t.no_type_check
def setup(cls, *args: t.Any, **kwargs: t.Any) -> "DynamicModule":
"""
Provides Dynamic set up for a module.
Usage:
class MyModule(ModuleBase, IModuleSetup):
@classmethod
def setup(cls, param1: Any, param2: Any) -> DynamicModule:
:return DynamicModule(module, provider=[], controllers=[], routers=[])
@Module(modules=[MyModule.setup(param1='xyz', param2='abc')])
class ApplicationModule(ModuleBase):
pass
"""
@classmethod
@t.no_type_check
def register_setup(cls, *args: t.Any, **kwargs: t.Any) -> "ModuleSetup":
"""
The module defines all the dependencies its needs for its setup.
Allowing parameters needed for setting up the module to come from app Config.
Usage:
class MyModule(ModuleBase, IModuleSetup):
@classmethod
def register_setup(cls) -> ModuleSetup:
:return ModuleSetup(cls, inject=[Config, OtherServices], factory=cls.setup_module_factory)
@staticmethod
def setup_module_factory(module: t.Type['MyModule'], config: Config, others: OtherServices) -> DynamicModule:
param1 = config.param1
param2 = config.param2
:return DynamicModule(module, provider=[], controllers=[], routers=[])
@Module(modules=[MyModule.register_setup()])
class ApplicationModule(ModuleBase):
pass
"""