Source code for eradiate.kernel.logging

Logging facilities.

import logging
import re

import mitsuba.scalar_rgb as mi
from import tqdm

from .._config import ProgressLevel, config

def _add_logging_level(level_name, level_num, method_name=None):
    Comprehensively adds a new logging level to the ``logging`` module and the
    currently configured logging class.

    ``level_name`` becomes an attribute of the ``logging`` module with the value
    ``level_num``. ``method_name`` becomes a convenience method for both
    ``logging`` itself and the class returned by ``logging.getLoggerClass()``
    (usually just ``logging.Logger``). If ``method_name`` is not specified,
    ``level_name.lower()`` is used.

    To avoid accidental clobberings of existing attributes, this method will
    raise an ``AttributeError`` if the level name is already an attribute of the
    ``logging`` module or if the method name is already present

    >>> _add_logging_level('TRACE', logging.DEBUG - 5)
    >>> logging.getLogger(__name__).setLevel("TRACE")
    >>> logging.getLogger(__name__).trace('that worked')
    >>> logging.trace('so did this')
    >>> logging.TRACE
    # See also:
    if not method_name:
        method_name = level_name.lower()

    if hasattr(logging, level_name):
        raise AttributeError(f"{level_name} already defined in logging module")
    if hasattr(logging, method_name):
        raise AttributeError(f"{method_name} already defined in logging module")
    if hasattr(logging.getLoggerClass(), method_name):
        raise AttributeError(f"{method_name} already defined in logger class")

    # This method was inspired by the answers to Stack Overflow post
    #, especially
    def log_for_level(self, message, *args, **kwargs):
        if self.isEnabledFor(level_num):
            self._log(level_num, message, args, **kwargs)

    def log_to_root(message, *args, **kwargs):
        logging.log(level_num, message, *args, **kwargs)

    logging.addLevelName(level_num, level_name)
    setattr(logging, level_name, level_num)
    setattr(logging.getLoggerClass(), method_name, log_for_level)
    setattr(logging, method_name, log_to_root)

# Regex for log parsing
mi_log_parser = re.compile(
    r"^(?P<datetime>\d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2})\s*"

# Mitsuba Logger instance
mi_logger = None

# Module-local logger
logger = logging.getLogger("mitsuba")

def _get_logger():
    Get Mitsuba Logger instance
    return mi.Thread.thread().logger()

[docs] def install_logging(force: bool = False) -> None: """ Activate Python logging framework for Mitsuba. Parameters ---------- force : bool, optional If ``True``, force-reactivate logging. """ global mi_logger if mi_logger is not None and not force: return try: _add_logging_level("TRACE", logging.DEBUG - 5, "trace") except AttributeError: pass LOGLEVEL_DISPATCH = { mi.LogLevel.Trace: "trace", mi.LogLevel.Debug: "debug", mi.LogLevel.Info: "info", mi.LogLevel.Warn: "warning", mi.LogLevel.Error: "error", } class EradiateAppender(mi.Appender): def __init__(self): super().__init__() self.reset() def reset(self): = None self.progress = None def append(self, level, text): m = mi_log_parser.match(text) msg = ( f"{'thread')} [{'class')}] {'message')}" if m is not None else text ) getattr(logger, LOGLEVEL_DISPATCH[level])(msg) def log_progress(self, progress, name, formatted, eta, ptr=None): if is None: = tqdm( desc="Mitsuba", initial=0.0, total=1.0, unit_scale=1.0, leave=True, bar_format="{l_bar}{bar}| {elapsed}, ETA={remaining}", disable=config.progress < ProgressLevel.KERNEL, ) self.progress = 0.0 - self.progress) self.progress = progress if progress >= 1.0: self.reset() if mi_logger is None: mi_logger = _get_logger() mi_logger.clear_appenders() mi_logger.add_appender(EradiateAppender()) mi_logger.set_log_level(mi.LogLevel.Info)