Logger Module

Module: piethorn.logging.logger

Overview

This module provides Logger, a small output helper with built-in message counters and factory methods for progress counters.

Logger

class Logger(debug_level=0)

Simple logger that prints tagged messages and tracks message counts.

Example

from piethorn.logging.logger import Logger

logger = Logger(debug_level=1)
logger.info("hello")
logger.warn("careful")

Methods

get_default_file(log_type, fallback_type="default")

Return the configured output stream for a log type.

set_default_file(log_type, file)

Change or clear the configured stream for a log type.

base_log(*msgs, level=0, sep=" ", end="\\n", file=None, flush=False)

Low-level print helper. Returns False when the active debug level is too low.

log(title, *msgs, level=0, title_sep=" ", sep=" ", end="\\n", file=None, flush=False)

Log a titled message and update the general log counter.

error(*msgs, **kwargs), warn(*msgs, **kwargs), info(*msgs, **kwargs)

Severity-specific wrappers around log.

logger.error("failed")
logger.warn("careful")
logger.info("boot complete")
log_sep(size=50, title=None, *, size_is_sep_count=False, sep="-", end="\\n", file=None, flush=False)

Print a separator line.

percent(name, current=0, cap=100, step=1) and count(name, step=1)

Factory helpers for piethorn.logging.counter.Percent and piethorn.logging.counter.Counter.

Autodoc

class piethorn.logging.logger.Logger(debug_level=0)

Print tagged log messages while tracking log counters by severity.

base_log(*msgs, level=0, sep=' ', end='\n', file=None, flush=False)

Print a message when the requested debug level is enabled.

count(name: str, step: float = 1)

Create a Counter bound to this logger.

error(*msgs, **kwargs)

Log an error message and update the error counter.

get_default_file(log_type, fallback_type: str = 'default')

Return the configured output stream for log_type.

info(*msgs, **kwargs)

Log an informational message and update the info counter.

log(title, *msgs, level=0, title_sep=' ', sep=' ', end='\n', file=None, flush=False)

Print a titled log message and update the general log counter.

log_sep(size=50, title=None, *, size_is_sep_count=False, sep='-', end='\n', file=None, flush=False)

Print a separator line, optionally centered around a title.

percent(name: str, current: float = 0, cap: int = 100, step: float = 1)

Create a Percent counter bound to this logger.

set_default_file(log_type, file)

Set or clear the default output stream for log_type.

warn(*msgs, **kwargs)

Log a warning message and update the warning counter.