Base Plotter

BasePlotter pydantic-model

Bases: BaseModel

BasePlotter class to enable type hinting and validation.

Config:

• arbitrary_types_allowed: True
• extra: allow

Source code in lexos/rolling_windows/plotters/base_plotter.py

class BasePlotter(BaseModel):
    """BasePlotter class to enable type hinting and validation."""

    id: ClassVar[str] = "base_plotter"
    model_config = ConfigDict(arbitrary_types_allowed=True, extra="allow")

    @property
    def metadata(self) -> dict:
        """Return metadata about the object.

        Returns:
            dict: A dictionary containing metadata about the object.
        """
        # Note: model_dump() may evaluate computed fields on this model.
        # If computed properties rely on external state or are expensive to
        # compute, calling model_dump() may cause unexpected exceptions or
        # performance issues. Subclasses should exclude costly computed
        # fields by overriding this property or explicitly excluding fields
        # when calling model_dump().
        return self.model_dump()

    def _set_attrs(self, **kwargs) -> None:
        """Set instance attributes when public method is called.

        Args:
            kwargs (dict): A dict of keyword arguments and their values.
        """
        for key, value in kwargs.items():
            if value is not None:
                setattr(self, key, value)

metadata: dict property

Return metadata about the object.

Returns:

Name	Type	Description
dict	dict	A dictionary containing metadata about the object.

metadata: dict property

Return metadata about the object.

Returns:

Name	Type	Description
dict	dict	A dictionary containing metadata about the object.

_set_attrs(**kwargs) -> None

Set instance attributes when public method is called.

Parameters:

Name	Type	Description	Default
kwargs	dict	A dict of keyword arguments and their values.	{}

Source code in lexos/rolling_windows/plotters/base_plotter.py

def _set_attrs(self, **kwargs) -> None:
    """Set instance attributes when public method is called.

    Args:
        kwargs (dict): A dict of keyword arguments and their values.
    """
    for key, value in kwargs.items():
        if value is not None:
            setattr(self, key, value)