BasicTools.Helpers.BaseOutputObject module

Base object to Help output

class BasicTools.Helpers.BaseOutputObject.BaseOutputObject(other=None)[source]

Bases: object

Base class for almost all the classes in BasicTools. The principal functionality of this class is to handle output to the console with different level of verbosity. the user can change verbose level for a specific instance or to all the instances in a program.

classmethod GetDiffTime()[source]

classmethod GetVerboseLevel()[source]

InDebugMode()[source]

classmethod IsGlobalDebugMode()[source]

Print(mess)[source]

classmethod Print2(mess)[source]

PrintDebug(mess)[source]

PrintError(mess)[source]

PrintInternal(mess, level=1)[source]

PrintProgress(val, maxx=100, minn=0)[source]

PrintVerbose(mess)[source]

RETURN_FAIL = 1

RETURN_FAIL_EXTERNAL_TOOL = 2

RETURN_SUCCESS = 0

classmethod SetGlobalDebugMode(mode=True)[source]

SetInstanceDebugMode(mode=True)[source]

classmethod SetVerboseLevel(level)[source]

BasicTools.Helpers.BaseOutputObject.CheckIntegrity(GUI=False)[source]

BasicTools.Helpers.BaseOutputObject.ResetStartTime()[source]: Function to reset the start time of a program.

BasicTools.Helpers.BaseOutputObject.SetUseDifferentialTime(val)[source]

Function to set the printing format

Parameters:: [val] ([Bool]) – True to print the time from the begining of the program or False to print the current time, defaults to [True]

BasicTools.Helpers.BaseOutputObject.froze_it(cls)[source]

Decorator to make the class immutable (no more attributes can be added after initialization)

For the moment if a class is frozen no heritage is possible.