resistics.common.base module

class resistics.common.base.ResisticsBase

Bases: object

Resistics base class

Parent class to ensure consistency of print methods

Methods

__repr__()	Print status information
__str__()	Print status information
printInfo()	Print status information
printList()	Return a list of strings with useful information
printText(infoStr)	Print information to console
printWarning(warnStr)	Print a warning to the console
printError(errorStr, quitRun=False)	Print an error to the console and optionally quit execution

printError(self, errorStr: str, quitRun: bool = False) → None

Error print to terminal and possibly quit

Parameters

errorStrstr

The string to print to the console

quitRunbool, optional (False)

If True, the code will exit

printInfo(self) → None

Print class information

printList(self) → List

Class information as a list of strings

Returns

outlist

List of strings with information

printText(self, infoStr: str) → None

General print to terminal

Parameters

infoStrstr

The string to print to the console

printWarning(self, warnStr: str) → None

Warning print to terminal

Parameters

warnStrstr

The string to print to the console