LineTerminal

class pyTooling.TerminalUI.LineTerminal(verbose=False, debug=False, quiet=False, writeToStdOut=True)

Bases: Terminal, ILineTerminal

property Verbose: bool

Returns true, if verbose messages are enabled.

Return type:

bool

property Debug: bool

Returns true, if debug messages are enabled.

Return type:

bool

property Quiet: bool

Returns true, if quiet mode is enabled.

Return type:

bool

property LogLevel: Severity

Return the current minimal severity level for writing.

Return type:

Severity

_LOG_MESSAGE_FORMAT__ = {Severity.Debug: '{DARK_GRAY}{message}{NOCOLOR}', Severity.Verbose: '{GRAY}{message}{NOCOLOR}', Severity.Normal: '{WHITE}{message}{NOCOLOR}', Severity.DryRun: '{DARK_CYAN}[DRY] {message}{NOCOLOR}', Severity.Info: '{WHITE}{message}{NOCOLOR}', Severity.Warning: '{YELLOW}[WARNING]{message}{NOCOLOR}', Severity.Quiet: '{WHITE}{message}{NOCOLOR}', Severity.Error: '{RED}[ERROR] {message}{NOCOLOR}', Severity.Fatal: '{DARK_RED}[FATAL] {message}{NOCOLOR}'}

Message formatting rules.

ExitOnPreviousErrors()

Exit application if errors have been printed.

Return type:

None

ExitOnPreviousWarnings()

Exit application if warnings have been printed.

Return type:

None

WriteLine(line)

Print a formatted line to the underlying terminal/console offered by the operating system.

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

Write a fatal message if condition is true.

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

Write an error message if condition is true.

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

Write a warning message if condition is true.

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

Write a info message if condition is true.

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

Write a message even in quiet mode if condition is true.

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

Write a normal message if condition is true.

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

Write a verbose message if condition is true.

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

Write a debug message if condition is true.

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

Write a dry-run message if condition is true.