omnipy.hub.log.mixin

Shared logging mixin for Omnipy runtime and hub objects.

CLASS	DESCRIPTION
LogMixin	Provide a module-scoped logger and timestamp-aware convenience logging.

LogMixin

Provide a module-scoped logger and timestamp-aware convenience logging.

METHOD	DESCRIPTION
__init__
log	Emit a log message, optionally using an explicit event timestamp.

ATTRIBUTE	DESCRIPTION
logger	Return the logger bound to the concrete instance type. TYPE: Logger

Source code in src/omnipy/hub/log/mixin.py

class LogMixin:
    """Provide a module-scoped logger and timestamp-aware convenience logging."""
    def __init__(self) -> None:
        self._logger: Logger = getLogger(f'{self.__class__.__module__}.{self.__class__.__name__}')
        self._logger.setLevel(INFO)

    @property
    def logger(self) -> Logger:
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{CANLOG_LOGGER_SUMMARY}}
        #
        # {{CANLOG_LOGGER_DETAILS}}
        """Return the logger bound to the concrete instance type.

        Returns:
            Logger: Logger used by the object for Omnipy log messages.
        """
        return self._logger

    def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
        # %% Original docstring (managed by expand_docstr_macros.py) %%
        # {{CANLOG_LOG_SUMMARY}}
        #
        # {{CANLOG_LOG_DETAILS}}
        """Emit a log message, optionally using an explicit event timestamp.

        Args:
            log_msg: Message text to send to the logger.
            level: Standard library logging level.
            datetime_obj: Timestamp to attach to the record instead of wall-clock time.
        """
        if self._logger is not None:
            create_time = datetime_obj.timestamp() if datetime_obj else time.time()
            self._logger.log(level, log_msg, extra=dict(timestamp=create_time))

logger property

logger: Logger

Return the logger bound to the concrete instance type.

RETURNS	DESCRIPTION
Logger	Logger used by the object for Omnipy log messages. TYPE: Logger

__init__

__init__() -> None

Source code in src/omnipy/hub/log/mixin.py

def __init__(self) -> None:
    self._logger: Logger = getLogger(f'{self.__class__.__module__}.{self.__class__.__name__}')
    self._logger.setLevel(INFO)

log

log(log_msg: str, level: int = INFO, datetime_obj: datetime | None = None)

Emit a log message, optionally using an explicit event timestamp.

PARAMETER	DESCRIPTION
log_msg	Message text to send to the logger. TYPE: str
level	Standard library logging level. TYPE: int DEFAULT: INFO
datetime_obj	Timestamp to attach to the record instead of wall-clock time. TYPE: datetime | None DEFAULT: None

Source code in src/omnipy/hub/log/mixin.py

def log(self, log_msg: str, level: int = INFO, datetime_obj: datetime | None = None):
    # %% Original docstring (managed by expand_docstr_macros.py) %%
    # {{CANLOG_LOG_SUMMARY}}
    #
    # {{CANLOG_LOG_DETAILS}}
    """Emit a log message, optionally using an explicit event timestamp.

    Args:
        log_msg: Message text to send to the logger.
        level: Standard library logging level.
        datetime_obj: Timestamp to attach to the record instead of wall-clock time.
    """
    if self._logger is not None:
        create_time = datetime_obj.timestamp() if datetime_obj else time.time()
        self._logger.log(level, log_msg, extra=dict(timestamp=create_time))