logging

get_console_handler()

Instanciates the logging output on the console.

Source code in src/dxtr/utils/logging.py

def get_console_handler() -> logging.StreamHandler:
    """Instanciates the logging output on the console.
    """
    console_handler = logging.StreamHandler(sys.stdout)
    console_handler.setFormatter(FORMATTER_CNSL)
    return console_handler

get_file_handler(log_file, log_level=DEFAULT_LOG_LEVEL_FILE, time_rotating=True)

Instanciate the logging output written on disk.

Parameters:

Name	Type	Description	Default
log_file	str	The file where to store the log.	required
log_level	str	The log level to save on file.	DEFAULT_LOG_LEVEL_FILE
time_rotating	bool	If True, a time-rotating managment of log files is set.	True

Returns:

Type	Description
file_handler	The object that manages all the log messages.

Notes

• If time-rotation is used
  • One file is generated per day, starting at midnight.
  • At most, 5 files are stored on disk. Meaning that we conserve at most a week of log.

Source code in src/dxtr/utils/logging.py

def get_file_handler(log_file:str,
                     log_level:str=DEFAULT_LOG_LEVEL_FILE,
                     time_rotating:bool=True,
                     ) -> logging.FileHandler:
    """Instanciate the logging output written on disk.

    Parameters
    ----------
    log_file
        The file where to store the log.
    log_level
        The log level to save on file.
    time_rotating
        If True, a time-rotating managment of log files is set.

    Returns
    -------
    file_handler
        The object that manages all the log messages.

    Notes
    -----
      * If time-rotation is used
        * One file is generated per day, starting at midnight.
        * At most, 5 files are stored on disk. Meaning that we conserve at
          most a week of log.
    """

    if time_rotating:
        file_handler = handlers.TimedRotatingFileHandler(
            log_file, when='midnight', backupCount=5)
    else:
        file_handler = logging.FileHandler(log_file, mode='w')

    file_handler.setFormatter(FORMATTER_FILE)
    file_handler.setLevel(log_level)
    return file_handler

get_logger(logger_name, log_file=None, log_level=DEFAULT_LOG_LEVEL_CNSL)

Instanciates the two logging outputs: console & file on disk.

Parameters:

Name	Type	Description	Default
logger_name	str	The name given to the created Logger object.	required
log_file	Optional[str]	Optional, default is None. The path to the file where to write the log.	None
log_level		Optional, default is 'INFO'. The log level for the console output.	DEFAULT_LOG_LEVEL_CNSL

Returns:

Type	Description
The Logger object gathering all the info.

Source code in src/dxtr/utils/logging.py

def get_logger(logger_name:str, log_file:Optional[str]=None, 
               log_level=DEFAULT_LOG_LEVEL_CNSL) -> logging.Logger:
    """Instanciates the two logging outputs: console & file on disk.

    Parameters
    ----------
    logger_name
        The name given to the created Logger object.

    log_file 
        Optional, default is None. The path to the file where to write the log.

    log_level
        Optional, default is 'INFO'. The log level for the console output.

    Returns
    -------
        The Logger object gathering all the info.
    """

    if log_file is None:
        here = os.getcwd()
        name = '.'.join([logger_name, 'log'])
        log_file = '/'.join([here, name])

    logger = logging.getLogger(logger_name)
    logger.setLevel(log_level)
    logger.addHandler(get_console_handler())
    logger.addHandler(get_file_handler(log_file, log_level))

    logger.propagate = False

    return logger

mutelogging(func)

Increases momentary the logging level so no info are displayed.

Source code in src/dxtr/utils/logging.py

def mutelogging(func) -> Any:
    """Increases momentary the logging level so no info are displayed.
    """
    @wraps(func)
    def wrapper(*args, **kwargs):
        from dxtr import logger

        initial_logging_level = logger.level
        logger.setLevel(LEVEL['ERROR'])

        result = func(*args, **kwargs)

        logger.setLevel(initial_logging_level)

        return result

    return wrapper

require_pyvista(func)

Checks if the library pyvista is installed.

Notes

• This library is an optional dependency.
• It is used in the visu and io modules.
• In the io module it is required for recording Cochain.
• The dependency to logger does not seem super clean... Maybe this means that this decorator does not belong here...

Source code in src/dxtr/utils/logging.py

def require_pyvista(func) -> Optional[Any]:
    """Checks if the library pyvista is installed.

    Notes
    -----
      * This library is an optional dependency.
      * It is used in the visu and io modules.
      * In the io module it is required for recording `Cochain`.
      * The dependency to logger does not seem super clean... 
        Maybe this means that this decorator does not belong here...
    """

    @wraps(func)
    def wrapper(*args, **kwargs):
        try:
            import pyvista as pv 
            return func(*args, **kwargs)
        except ImportError:
            from dxtr import logger
            logger.warning('Pyvista not installed', ImportWarning)
            return None
    return wrapper