Pluggable class

This is the reference for the main object Pluggable that contains all the parameters, attributes and functions.

esmerald.Pluggable

Pluggable(cls, **options)

The Pluggable is used to create an Esmerald pluggable from an Extension. When Esmerald receives pluggables, it hooks them into the system and allows the access via anywhere in the application.

Read more about the Pluggables and learn how to use them.

Example

from typing import Optional

from loguru import logger
from pydantic import BaseModel

from esmerald import Esmerald, Extension, Pluggable
from esmerald.types import DictAny


class PluggableConfig(BaseModel):
    name: str


class MyExtension(Extension):
    def __init__(
        self, app: Optional["Esmerald"] = None, config: PluggableConfig = None, **kwargs: "DictAny"
    ):
        super().__init__(app, **kwargs)
        self.app = app

    def extend(self, config: PluggableConfig) -> None:
        logger.success(f"Successfully passed a config {config.name}")


my_config = PluggableConfig(name="my extension")

pluggable = Pluggable(MyExtension, config=my_config)

app = Esmerald(routes=[], pluggables={"my-extension": pluggable})

PARAMETER	DESCRIPTION
cls	TYPE: Extension
**options	TYPE: Any DEFAULT: {}

Source code in esmerald/pluggables/base.py

def __init__(self, cls: "Extension", **options: Any):
    self.cls = cls
    self.options = options

cls instance-attribute

cls = cls

options instance-attribute

options = options

esmerald.Extension

Extension(app=None, **kwargs)

Bases: BaseExtension

Extension object is the one being used to add the logic that will originate the pluggable in the application.

The Extension must implement the extend function.

Read more about the Extension and learn how to use it.

Example

from typing import Optional

from esmerald import Esmerald, Extension
from esmerald.types import DictAny


class MyExtension(Extension):
    def __init__(self, app: Optional["Esmerald"] = None, **kwargs: "DictAny"):
        super().__init__(app, **kwargs)
        self.app = app
        self.kwargs = kwargs

    def extend(self, **kwargs: "DictAny") -> None:
        '''
        Function that should always be implemented when extending
        the Extension class or a `NotImplementedError` is raised.
        '''
        # Do something here

PARAMETER	DESCRIPTION
app	An Esmerald application instance or subclasses of Esmerald. TYPE: Optional[Esmerald] DEFAULT: None
**kwargs	Any additional kwargs needed. TYPE: Any DEFAULT: {}

Source code in esmerald/pluggables/base.py

def __init__(
    self,
    app: Annotated[
        Optional["Esmerald"],
        Doc(
            """
            An `Esmerald` application instance or subclasses of Esmerald.
            """
        ),
    ] = None,
    **kwargs: Annotated[
        Any,
        Doc("""Any additional kwargs needed."""),
    ],
):
    super().__init__(app, **kwargs)
    self.app = app

app instance-attribute

app = app

extend abstractmethod

extend(**kwargs)

PARAMETER	DESCRIPTION
**kwargs	TYPE: Any DEFAULT: {}

Source code in esmerald/pluggables/base.py

@abstractmethod
def extend(self, **kwargs: "Any") -> None:
    raise NotImplementedError("plug must be implemented by the subclasses.")