pyIPCMI.Base.Logging.py

Classes

• Severity: Logging message severity levels.
• LogEntry: Represents a single line log message with a severity and indentation level.
• Logger: Undocumented.
• ILogable: A mixin class to provide local logging methods.

class pyIPCMI.Base.Logging.Severity(*_)

Logging message severity levels.

Inheritance

Members

Fatal = 30

Error = 25

Quiet = 20

Warning = 15

Info = 10

DryRun = 5

Normal = 4

Verbose = 2

Debug = 1

All = 0

class pyIPCMI.Base.Logging.LogEntry(message, severity=<Severity.Normal: 4>, indent=0, appendLinebreak=True)

Represents a single line log message with a severity and indentation level.

Inheritance

Members

_Log_MESSAGE_FORMAT__ = {<Severity.Debug: 1>: 'DEBUG: {message}', <Severity.Verbose: 2>: 'VERBOSE: {message}', <Severity.Normal: 4>: '{message}', <Severity.DryRun: 5>: 'DRYRUN: {message}', <Severity.Info: 10>: 'INFO: {message}', <Severity.Warning: 15>: 'WARNING: {message}', <Severity.Quiet: 20>: '{message}', <Severity.Error: 25>: 'ERROR: {message}', <Severity.Fatal: 30>: 'FATAL: {message}'}

Severity

Return the log message’s severity level.

Indent

Return the log message’s indentation level.

Message

Return the indented log message.

IndentBy(indent)

Increase a log message’s indentation level.

class pyIPCMI.Base.Logging.Logger(logLevel, printToStdOut=True)

Inheritance

Members

LogLevel

Return the currently logged minimal severity level.

BaseIndent

_Log_MESSAGE_FORMAT__ = {<Severity.Debug: 1>: '{DARK_GRAY}{message}{NOCOLOR}', <Severity.Verbose: 2>: '{GRAY}{message}{NOCOLOR}', <Severity.Normal: 4>: '{WHITE}{message}{NOCOLOR}', <Severity.DryRun: 5>: '{DARK_CYAN}{message}{NOCOLOR}', <Severity.Info: 10>: '{WHITE}{message}{NOCOLOR}', <Severity.Warning: 15>: '{YELLOW}{message}{NOCOLOR}', <Severity.Quiet: 20>: '{WHITE}{message}{NOCOLOR}', <Severity.Error: 25>: '{RED}{message}{NOCOLOR}', <Severity.Fatal: 30>: '{DARK_RED}{message}{NOCOLOR}'}

Write(entry)

TryWrite(entry)

WriteFatal(message, indent=0, appendLinebreak=True)

WriteError(message, indent=0, appendLinebreak=True)

WriteWarning(message, indent=0, appendLinebreak=True)

WriteInfo(message, indent=0, appendLinebreak=True)

WriteQuiet(message, indent=0, appendLinebreak=True)

WriteNormal(message, indent=0, appendLinebreak=True)

WriteVerbose(message, indent=1, appendLinebreak=True)

WriteDebug(message, indent=2, appendLinebreak=True)

WriteDryRun(message, indent=2, appendLinebreak=True)

class pyIPCMI.Base.Logging.ILogable(logger=None)

A mixin class to provide local logging methods.

Inheritance

Members

Logger

Return the local logger instance.

Log(entry, condition=True)

Write an entry to the local logger.

_TryLog(*args, condition=True, **kwargs)

LogFatal(*args, condition=True, **kwargs)

LogError(*args, condition=True, **kwargs)

LogWarning(*args, condition=True, **kwargs)

LogInfo(*args, condition=True, **kwargs)

LogQuiet(*args, condition=True, **kwargs)

LogNormal(*args, condition=True, **kwargs)

LogVerbose(*args, condition=True, **kwargs)

LogDebug(*args, condition=True, **kwargs)

LogDryRun(*args, condition=True, **kwargs)