Dynamic Modules¶

We have seen in many examples given on how to statically configure a module. In this section, we are going to look at different ways to dynamically set up a module.

Why is this important? Consider a scenario where a general-purpose module needs to behave differently in different use cases, it may be useful to use a configuration-based approach to allow customization. This is similar to the concept of a "plugin" in many systems, where a generic facility requires some configuration before it can be used by a consumer.

Module Dynamic Setup¶

To dynamically configure a module, the module should inherit from IModuleSetup and provide a setup method or setup_register method that performs the necessary actions for setting up the module and then returns a DynamicModule or ModuleSetup instance.

import typing as t
from ellar.core.modules import DynamicModule, ModuleSetup

class IModuleSetup:
    """Modules that must have a custom setup should inherit from IModuleSetup"""

    @classmethod
    def setup(cls, *args: t.Any, **kwargs: t.Any) -> DynamicModule:
        pass

    @classmethod
    def register_setup(cls, *args: t.Any, **kwargs: t.Any) -> ModuleSetup:
        pass

Note that setup method returns a DynamicModule instance, while register_setup method returns a ModuleSetup instance. The DynamicModule instance is used when the module requires some configuration before it can be used by a consumer, while the ModuleSetup instance is used when the module does not require any additional configuration outside the ones provided in the application config.

DynamicModule¶

DynamicModule is a dataclass type that is used to override Module decorated attributes without having to modify the module code directly. In other words, it gives you the flexibility to reconfigure module.

For example, Let's look at the code below:

from ellar.common import Module
from ellar.core import DynamicModule
from ellar.di import ProviderConfig

@Module(providers=[ServiceA, ServiceB])
class ModuleA:
    pass

# we can reconfigure ModuleA dynamically using `DynamicModule` as shown below

@Module(
    modules=[
        DynamicModule(
            ModuleA, 
            providers=[
                ProviderConfig(ServiceA, use_class=str),
                ProviderConfig(ServiceB, use_class=dict),
            ]
        )
    ]
)
class ApplicationModule:
    pass

ModuleSetup¶

ModuleSetup is a dataclass type that used to set up a module based on its dependencies. It allows you to define the module dependencies and allow a callback factory function for a module dynamic set up.

ModuleSetup Properties:

• module: a required property that defines the type of module to be configured. The value must be a subclass of ModuleBase or IModuleSetup.
• inject: a sequence property that holds the types to be injected to the factory method. The order of the types will determine the order at which they are injected.
• factory: a factory function used to configure the module and take Module type as first argument and other services as listed in inject attribute.

Let's look this ModuleSetup example code below with our focus on how we eventually configured DynamicService type, how we used my_module_configuration_factory to dynamically build MyModule module.

 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

import typing as t
from ellar.common import Module, IModuleSetup
from ellar.di import ProviderConfig
from ellar.core import DynamicModule, ModuleBase, Config, ModuleSetup
from ellar.app import AppFactory


class Foo:
    def __init__(self):
        self.foo = 'foo'


class DynamicService:
    def __init__(self, param1: t.Any, param2: t.Any, foo: str):
        self.param1 = param1
        self.param2 = param2
        self.foo = foo


@Module()
class MyModule(ModuleBase, IModuleSetup):
    @classmethod
    def setup(cls, param1: t.Any, param2: t.Any, foo: Foo) -> DynamicModule:
        return DynamicModule(
            cls,
            providers=[ProviderConfig(DynamicService, use_value=DynamicService(param1, param2, foo.foo))],
        )


def my_module_configuration_factory(module: t.Type[MyModule], config: Config, foo: Foo):
    return module.setup(param1=config.param1, param2=config.param2, foo=foo)


@Module(modules=[ModuleSetup(MyModule, inject=[Config, Foo], factory=my_module_configuration_factory),], providers=[Foo])
class ApplicationModule(ModuleBase):
    pass


app = AppFactory.create_from_app_module(ApplicationModule, config_module=dict(
    param1="param1",
    param2="param2",
))

dynamic_service = app.injector.get(DynamicService)

assert dynamic_service.param1 == "param1"
assert dynamic_service.param2 == "param2"
assert dynamic_service.foo == "foo"

At this point, looking at the setup function of MyModule, its clear MyModule depends on Config and Foo service. And this is where ModuleSetup usefulness comes in.

During registration in ApplicationModule, we wrapped MyModule around a ModuleSetup and stated its dependencies in the inject property and also provided a my_module_configuration_factory factory that takes in module dependencies and return a DynamicModule configuration of MyModule.

When AppFactory starts module bootstrapping, my_module_configuration_factory will be called with all the required parameters and returned a DynamicModule of MyModule.

For more example, checkout Ellar Throttle Module or Ellar Cache Module

Lazy Loading Modules¶

Ellar supports loading module decorated classes through a string reference using LazyModuleImport. For a better application context availability usage in module like, current_config, current_app and current_injector, it's advised to go with lazy module import.

For example, we can lazy load CarModule from our example here into ApplicationModule

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from ellar.common import IExecutionContext, Module, exception_handler
from ellar.common.responses import JSONResponse, Response
from ellar.core import ModuleBase, LazyModuleImport as lazyLoad
from ellar.samples.modules import HomeModule


@Module(modules=[HomeModule, lazyLoad('apps.car.module:CarModule')])
class ApplicationModule(ModuleBase):
    @exception_handler(404)
    def exception_404_handler(cls, ctx: IExecutionContext, exc: Exception) -> Response:
        return JSONResponse({"detail": "Resource not found."}, status_code=404)

In the above illustration, we provided a string reference to CarModule into LazyModuleImport instance. And during AppFactory Module bootstrap, CarModule will be resolved, validated and registered into the application

Properties¶

LazyModuleImport attributes,

• module: String reference for Module import
• setup: Module setup function name for modules that requires specific function as in case of DynamicModule and ModuleSetup.
• setup_options: Module setup function parameters

Lazy Loading DynamicModules¶

Having the understanding of DynamicModule and its registration pattern, to lazy load DynamicModule follows the same pattern.

For example, lets lazy load MyModule as a DynamicModule. For that to happen, we need to call MyModule.setup with some parameters and in turn returns a DynamicModule

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

from ellar.common import Module, exception_handler, JSONResponse, IExecutionContext, Response
from ellar.core import ModuleBase
from .custom_module import MyModule, Foo


@Module(modules=[MyModule.setup(12, 23, Foo())])
class ApplicationModule(ModuleBase):
    @exception_handler(404)
    def exception_404_handler(cls, ctx: IExecutionContext, exc: Exception) -> Response:
        return JSONResponse({"detail": "Resource not found."}, status_code=404)

Let's rewrite this using LazyModuleImport.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from ellar.common import Module, exception_handler, JSONResponse, IExecutionContext, Response
from ellar.core import ModuleBase, LazyModuleImport as lazyLoad


@Module(modules=[
    lazyLoad('project_name.custom_module:MyModule', 'setup', param1=12, param2=23, foo=Foo()), 
])
class ApplicationModule(ModuleBase):
    @exception_handler(404)
    def exception_404_handler(cls, ctx: IExecutionContext, exc: Exception) -> Response:
        return JSONResponse({"detail": "Resource not found."}, status_code=404)

Lazy Loading ModuleSetup¶

Just as in DynamicModule, ModuleSetup can be lazy loaded the same way. Let's take CacheModule for example.

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from ellar.common import Module, exception_handler, JSONResponse, IExecutionContext, Response
from ellar.core import ModuleBase, LazyModuleImport as lazyLoad


@Module(modules=[
    lazyLoad('ellar.cache.module:CacheModule', 'register_setup'), 
])
class ApplicationModule(ModuleBase):
    @exception_handler(404)
    def exception_404_handler(cls, ctx: IExecutionContext, exc: Exception) -> Response:
        return JSONResponse({"detail": "Resource not found."}, status_code=404)