src.Common.Utils package

Subpackages

Submodules

src.Common.Utils.ArgParser module

class src.Common.Utils.ArgParser.ArgParser[source]

Bases: object

AddBoolOption(name, helpStr, uiLabel)[source]
Return type:

None

AddEnumOption(name, helpStr, enumType, uiLabel)[source]
Return type:

None

AddFilePathOption(name, helpStr, folderPath, uiLabel)[source]
Return type:

None

AddOptionsOption(name, helpStr, options, uiLabel)[source]
Return type:

None

AddStrOption(name, helpStr, uiLabel)[source]
Return type:

None

class ArgType(value)[source]

Bases: Enum

An enumeration.

Bool = 1
Enum = 3
File = 0
Options = 2
String = 4
Get(key)[source]
Return type:

object

SetDefaults(defaultsDict)[source]
Return type:

None

src.Common.Utils.ConfigHelper module

src.Common.Utils.ModelHelper module

src.Common.Utils.PathHelper module

src.Common.Utils.PathHelper.EnsurePathExists(path)[source]
Return type:

None

src.Common.Utils.PathHelper.GetRootPath()[source]
Return type:

str

src.Common.Utils.SharedCoreTypes module

src.Common.Utils.Singleton module

class src.Common.Utils.Singleton.Singleton(*args: Any, **kwargs: Any)[source]

Bases: object

src.Common.Utils.UserInputHelper module

src.Common.Utils.UserInputHelper.BoolPicker(label)[source]
Return type:

bool

src.Common.Utils.UserInputHelper.FilePicker(label, folderPath)[source]
Return type:

str

src.Common.Utils.UserInputHelper.IsKeyPressed(key)[source]
Return type:

bool

src.Common.Utils.UserInputHelper.NumPicker(label, minVal, maxVal)[source]
Return type:

int

src.Common.Utils.UserInputHelper.OptionPicker(label, options)[source]
Return type:

TypeVar(T)

src.Common.Utils.UserInputHelper.StrPicker(label)[source]
Return type:

str

Module contents