python.logger Namespace Reference

Classes
class	ColoredFormatter
class	ExtendedLogger

Functions
	insert_seqs (message)
	get_log_handler (singleton={})
	log_level (level)
	get_level_for_opts (verbose, quiet)
	init_logger (verbose=False, quiet=False)

Variables
int	VERBOSE_LEVEL = 15
	RED
	YELLOW
	BLUE
	WHITE
str	RESET_SEQ = "\033[0m"
str	COLOR_SEQ = "\033[1;%dm"
str	BOLD_SEQ = "\033[1m"
dict	COLORS
	LoggerClass = logging.getLoggerClass()

Function Documentation

get_level_for_opts()

python.logger.get_level_for_opts	(		verbose,
			quiet )

Definition at line 101 of file logger.py.

def get_level_for_opts(verbose, quiet):
    if quiet:
        log_level = logging.WARNING
    elif not verbose:
        log_level = logging.INFO
    elif verbose == 1:
        log_level = VERBOSE_LEVEL
    elif verbose > 1:
        log_level = logging.DEBUG
        
    return log_level
    

get_log_handler()

python.logger.get_log_handler

(

singleton = {}

)

Return the STDOUT handler singleton used for all logging.

Definition at line 67 of file logger.py.

def get_log_handler(singleton={}):
    """
    Return the STDOUT handler singleton used for all logging.
    """
    if "value" in singleton:
        return singleton["value"]
        
    handler = logging.StreamHandler()
    if os.isatty(handler.stream.fileno()):
        FORMAT = "[%(asctime)s][$BOLD%(name)-20s$RESET][%(levelname)-18s] %(message)s"
        handler.setFormatter(ColoredFormatter(insert_seqs(FORMAT)))
    
    # Make the top level logger and make it as verbose as possible.
    # The log messages which make it to the screen are controlled by the handler
    log = logging.getLogger()
    log.addHandler(handler)
    log.setLevel(logging.DEBUG)
 
    singleton["value"] = handler
    return handler
 
@contextmanager

init_logger()

python.logger.init_logger	(		verbose = False,
			quiet = False )

This function should be called only by programs (not by libraries)

Definition at line 113 of file logger.py.

def init_logger(verbose=False, quiet=False):
    """
    This function should be called only by programs (not by libraries)
    """
    handler = get_log_handler()
    handler.setLevel(get_level_for_opts(verbose, quiet))

insert_seqs()

python.logger.insert_seqs

(

message

)

Definition at line 22 of file logger.py.

def insert_seqs(message):
    return message.replace("$RESET", RESET_SEQ).replace("$BOLD", BOLD_SEQ)
 

log_level()

python.logger.log_level

(

level

)

A log level context manager. Changes the log level for the duration.

Definition at line 89 of file logger.py.

def log_level(level):
    """
    A log level context manager. Changes the log level for the duration.
    """
    handler = get_log_handler()
    old_level = handler.level
    try:
        handler.setLevel(level)
        yield
    finally:
        handler.setLevel(old_level)
 

Variable Documentation

BLUE

python.logger.BLUE

Definition at line 15 of file logger.py.

BOLD_SEQ

str python.logger.BOLD_SEQ = "\033[1m"

Definition at line 20 of file logger.py.

COLOR_SEQ

str python.logger.COLOR_SEQ = "\033[1;%dm"

Definition at line 19 of file logger.py.

COLORS

dict python.logger.COLORS

Initial value:

=  {
    'DEBUG'   : BLUE,
    'VERBOSE' : WHITE,
    'INFO'    : YELLOW,
    'WARNING' : YELLOW,
    'ERROR'   : RED,
    'FATAL'   : RED,
}

Definition at line 25 of file logger.py.

LoggerClass

python.logger.LoggerClass = logging.getLoggerClass()

Definition at line 48 of file logger.py.

RED

python.logger.RED

Definition at line 15 of file logger.py.

RESET_SEQ

str python.logger.RESET_SEQ = "\033[0m"

Definition at line 18 of file logger.py.

VERBOSE_LEVEL

int python.logger.VERBOSE_LEVEL = 15

Definition at line 8 of file logger.py.

WHITE

python.logger.WHITE

Definition at line 15 of file logger.py.

YELLOW

python.logger.YELLOW

Definition at line 15 of file logger.py.