Source code for moptipy.api.component

"""
Provides the base class for all components of the moptipy API.

All elements of the `moptipy` API inherit from
:class:`~moptipy.api.component.Component`. If you implement a new such
component, you can test it using the pre-defined unit test routine
:func:`~moptipy.tests.component.validate_component`.
"""
from typing import Final

from pycommons.types import type_name_of

from moptipy.api import logging
from moptipy.utils.logger import KeyValueLogSection




class Component:
    """The base class for all components of the moptipy API."""

    def __repr__(self):
        """
        Get the string representation of this object.

        :return: the value returned by :meth:`__str__`
        """
        return str(self)

    def __str__(self):
        """
        Get the default to-string implementation returns the class name.

        :returns: the class name of this component

        >>> print(Component())
        Component
        """
        s: Final[str] = type_name_of(self)
        i: Final[int] = s.rfind(".")
        if i > 0:
            return s[i + 1:]
        return s



    def initialize(self) -> None:
        """
        Initialize this component before a new run.

        Before every run of the optimization algorithm, its `initialize`
        method is called. The algorithm in turn must call all the `initialize`
        methods of all of its components.
        """




    def log_parameters_to(self, logger: KeyValueLogSection) -> None:
        """
        Log all parameters of this component as key-value pairs.

        :param logger: the logger for the parameters

        >>> from moptipy.utils.logger import InMemoryLogger
        >>> with InMemoryLogger() as l:
        ...     with l.key_values("C") as kv:
        ...         Component().log_parameters_to(kv)
        ...     text = l.get_log()
        >>> text[-2]
        'class: moptipy.api.component.Component'
        >>> text[-3]
        'name: Component'
        >>> len(text)
        4
        """
        logger.key_value(logging.KEY_NAME, str(self))
        logger.key_value(logging.KEY_CLASS, type_name_of(self))