log Namespace Reference

Functions
	initLogging ()
	Initialize the logging.
bool	isInitialized ()
str	getExcInfoStr (tuple exc_info)
	Parse the exception data for human-readable information.
str	getMsgText ((str, tuple) msg)
	Get text string from "msg" object argument.
	printLogToConsole (int level,(str, tuple) msg)
	Log leveled and colored message to console only.
	critical ((str, tuple) msg)
	Log critical error message colored to console only.
	error ((str, tuple) msg)
	Log error message colored to console only.
	success ((str, tuple) msg)
	Log success message colored to console only.
	warning ((str, tuple) msg)
	Log warning message colored to console only.
	notice ((str, tuple) msg)
	Log notice message colored to console only.
	info ((str, tuple) msg)
	Log info message colored to console only.
	verbose ((str, tuple) msg)
	Log verbose message colored to console only.
	debug ((str, tuple) msg)
	Log debug message colored to console only.
	spam ((str, tuple) msg)
	Log spam message colored to console only.

Variables
list	LOG_LEVELS
	List of log level attributes for comprehensive logging.
int	LOG_LEVEL = 20
	Actual log level.
int	LEVEL_COLUMN_WIDTH = 0
	Width of the column, which shows the log level name.
bool	_is_initialized = False
	Flag, which states, that the logging is initialized for this program.
	UnexpExcInfo
	Named tuple definition of unexpected exception.

Function Documentation

initLogging()

log.initLogging

(

)

Initialize the logging.

Definition at line 71 of file log.py.

def initLogging():
    # Define global variables
    global LOG_LEVEL
    global LEVEL_COLUMN_WIDTH
    # Automatically calculate LEVEL_COLUMN_WIDTH
    for item in LOG_LEVELS:
        lln = len(item['name'])
        if LEVEL_COLUMN_WIDTH < lln:
            LEVEL_COLUMN_WIDTH = lln
    # Override LOG_LEVEL by environment variable
    if 'LOG_LEVEL' in os.environ:
        LOG_LEVEL = int(os.environ['LOG_LEVEL'])
    # Set logging is initialized
    global _is_initialized
    _is_initialized = True
 
# Check if logging is initialized.
#
#  return Flag, which states that logging is initialized.

isInitialized()

bool log.isInitialized

(

)

Definition at line 90 of file log.py.

def isInitialized() -> bool:
    return _is_initialized
 

getExcInfoStr()

str log.getExcInfoStr

(

tuple

exc_info

)

Parse the exception data for human-readable information.

This allows the developer to identify and locate the exception.

Parameters

exc_info

Output of sys.exc_info().

Returns

Human-readable information or empty string if

Definition at line 99 of file log.py.

def getExcInfoStr(exc_info: tuple) -> str:
    maj, mno, _ = platform.python_version_tuple()
    maj = int(maj)
    mno = int(mno)
    ty, va, tb = exc_info
    if (maj > 3) or ((maj == 3) and (mno >= 11)):
        qnm = tb.tb_frame.f_code.co_qualname
    else:
        qnm = tb.tb_frame.f_code.co_name
    i = UnexpExcInfo(
        ty.__name__,
        va,
        tb.tb_frame.f_code.co_filename,
        tb.tb_lineno,
        qnm,
        tb
    )
    tbs =''.join(traceback.extract_tb(i.tbk).format())
    return (
        'Unexpected {}, "{}"\n'.format(i.typ, i.val) +
        '\x20\x20File: "{}:{}"\n'.format(i.fil, i.lin) +
        '\x20\x20Pos.: {}, line {}\n'.format(i.qnm, i.lin) +
        'Traceback (most recent call last):\n' +
        '{}'.format(tbs)
    )
 

getMsgText()

str log.getMsgText

(

(str, tuple)

msg

)

Get text string from "msg" object argument.

Parameters

msg	Message as str or result of "sys.exc_info()" as tuple.

Returns

Human-readable message.

Definition at line 129 of file log.py.

def getMsgText(msg: (str, tuple)) -> str:
    if isinstance(msg, str):
        return msg
    elif isinstance(msg, tuple):
        return getExcInfoStr(msg)
    else:
        raise NotImplementedError
 

printLogToConsole()

log.printLogToConsole	(	int	level,
		(str, tuple)	msg )

Log leveled and colored message to console only.

Parameters

level

ID of logging level.

See also

LOG_LEVELS

Parameters

msg	Message as str or result of "sys.exc_info()" as tuple.

Definition at line 142 of file log.py.

def printLogToConsole(level: int, msg: (str, tuple)):
    for item in LOG_LEVELS:
        if (
            (level == item['level'])
            and
            (level >= LOG_LEVEL)
        ):
            # Print colorized and immediately flush the output
            print(
                '{}{}{}{}\x1b[0m'.format(
                    item['color'],
                    item['name'].upper(),
                    ' ' * (
                        LEVEL_COLUMN_WIDTH
                        -
                        len(item['name'])
                        +
                        1
                    ),
                    getMsgText(msg)
                ),
                flush=True
            )
            return
 
 
# --- LOGING FUNCTIONS -------------------------------------------------
 

critical()

log.critical

(

(str, tuple)

msg

)

Log critical error message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 173 of file log.py.

def critical(msg: (str, tuple)):
    printLogToConsole(50, msg)
 

error()

log.error

(

(str, tuple)

msg

)

Log error message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 179 of file log.py.

def error(msg: (str, tuple)):
    printLogToConsole(40, msg)
 

success()

log.success

(

(str, tuple)

msg

)

Log success message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 185 of file log.py.

def success(msg: (str, tuple)):
    printLogToConsole(35, msg)
 

warning()

log.warning

(

(str, tuple)

msg

)

Log warning message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 191 of file log.py.

def warning(msg: (str, tuple)):
    printLogToConsole(30, msg)
 

notice()

log.notice

(

(str, tuple)

msg

)

Log notice message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 197 of file log.py.

def notice(msg: (str, tuple)):
    printLogToConsole(25, msg)
 

info()

log.info

(

(str, tuple)

msg

)

Log info message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 203 of file log.py.

def info(msg: (str, tuple)):
    printLogToConsole(20, msg)
 

verbose()

log.verbose

(

(str, tuple)

msg

)

Log verbose message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 209 of file log.py.

def verbose(msg: (str, tuple)):
    printLogToConsole(15, msg)
 

debug()

log.debug

(

(str, tuple)

msg

)

Log debug message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 215 of file log.py.

def debug(msg: (str, tuple)):
    printLogToConsole(10, msg)
 

spam()

log.spam

(

(str, tuple)

msg

)

Log spam message colored to console only.

Parameters

msg	Message as str or result of sys.exc_info().

Definition at line 221 of file log.py.

def spam(msg: (str, tuple)):
    printLogToConsole(5, msg)
 
 
# --- END OF CODE ------------------------------------------------------
 

Variable Documentation

LOG_LEVELS

list log.LOG_LEVELS

Initial value:

=   [
    {'level': 50, 'name': 'critical', 'color': '\x1b[101m'},
    {'level': 40, 'name': 'error',    'color': '\x1b[91m'},
    {'level': 35, 'name': 'success',  'color': '\x1b[92m'},
    {'level': 30, 'name': 'warning',  'color': '\x1b[93m'},
    {'level': 25, 'name': 'notice',   'color': '\x1b[95m'},
    {'level': 20, 'name': 'info',     'color': '\x1b[37m'},
    {'level': 15, 'name': 'verbose',  'color': '\x1b[94m'},
    {'level': 10, 'name': 'debug',    'color': '\x1b[32m'},
    {'level':  5, 'name': 'spam',     'color': '\x1b[90m'}
]

List of log level attributes for comprehensive logging.

NOTE: Color of level 20 is default color in terminals with black background like e.g. the cmd.exe window in Windows.

See also

Logging

Definition at line 34 of file log.py.

LOG_LEVEL

int log.LOG_LEVEL = 20

Actual log level.

It could be overridden by environment variable. Default: 20 (name: 'info')

Definition at line 48 of file log.py.

LEVEL_COLUMN_WIDTH

int log.LEVEL_COLUMN_WIDTH = 0

Width of the column, which shows the log level name.

Default: 0. It will be calculated automatically.

Definition at line 52 of file log.py.

_is_initialized

bool log._is_initialized = False

protected

Flag, which states, that the logging is initialized for this program.

Definition at line 57 of file log.py.

UnexpExcInfo

log.UnexpExcInfo

Initial value:

=  collections.namedtuple(
    'ExceptionInfo',
    ['typ', 'val', 'fil', 'lin', 'qnm', 'tbk']
)

Named tuple definition of unexpected exception.

Definition at line 62 of file log.py.