ToolChain.PoC¶

Classes

• Configuration: Base class for all tool Configuration classes.

class ToolChain.PoC.Configuration(host: Base.IHost)[source]¶

Inheritance

Members

_vendor = 'VLSI-EDA'¶

The name of the tools vendor.

_toolName = 'PoC'¶

The name of the tool.

_section = 'INSTALL.PoC'¶

The name of the configuration section. Pattern: INSTALL.Vendor.ToolName.

_template = {'ALL': {'INSTALL.PoC': {'HasInstalledGitFilters': 'False', 'RepositoryKind': 'Public', 'InstallationDirectory': '', 'MultiVersionSupport': 'True', 'Version': '1.1.1', 'IsGitRepository': 'True', 'GitRemoteBranch': 'master', 'HasInstalledGitHooks': 'False'}, 'SOLUTION.Solutions': {}}}¶

The template for the configuration sections represented as nested dictionaries.

ConfigureForAll()[source]¶

RunPostConfigurationTasks()[source]¶

CheckDependency()[source]¶

Check if all vendor or tool dependencies are fulfilled to configure this tool.

ClearSection(writeWarnings=False)[source]¶

Clear the configuration section associated to this Configuration class.

ConfigureForDarwin()[source]¶

Start the configuration procedure for Darwin.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Darwin specific configuration routine.

ConfigureForLinux()[source]¶

Start the configuration procedure for Linux.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Linux specific configuration routine.

ConfigureForWindows()[source]¶

Start the configuration procedure for Windows.

This method is a wrapper for ConfigureForAll(). Overwrite this method to implement a Windows specific configuration routine.

GetSections(platform)[source]¶

Return all section names for this configuration.

Host¶

Return the hosting object.

IsConfigured()[source]¶

Return true if the configurations section is configured

IsSupportedPlatform()[source]¶

Return true if the given platform is supported by this configuration routine.

Log(entry, condition=True)¶

Write an entry to the local logger.

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

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

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

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

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

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

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

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

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

Logger¶

Return the local logger instance.

PrepareOptions(writeWarnings=True)[source]¶

PrepareSections(warningWasWritten, writeWarnings=True)[source]¶

PrepareVersionedSections(writeWarnings=False)¶

SectionName¶

Return the configuration’s section name.

State¶

Return the configuration state.

_Ask(question, default, beforeDefault='', afterDefault='', indent=1)¶

_AskInstalled(question)[source]¶

Ask a Yes/No/Pass question.

_AskYes_NoPass(question, indent=1)¶

Ask a yes/NO/pass question.

_Ask_YesNoPass(question, indent=1)¶

Ask a YES/no/pass question.

_ConfigureBinaryDirectory()¶

Updates section with value from _template and returns directory as Path object.

_ConfigureEdition(editions, defaultEdition)¶

_ConfigureInstallationDirectory()[source]¶

Asks for installation directory and updates section. Checks if entered directory exists and returns Path object. If no installation directory was configured before, then _GetDefaultInstallationDir is called.

_ConfigureVersion()¶

If no version was configured before, then _GetDefaultVersion is called. Asks for version and updates section. Returns version as string.

_GetDefaultEdition()¶

Returns unresolved default edition (str) from template.

Overwrite this method in a sub-class for automatic search of editions.

_GetDefaultInstallationDirectory()[source]¶

Return unresolved default installation directory (str) from template.

Overwrite function in sub-class for automatic search of installation directory.

_GetDefaultOptionValue(optionName)[source]¶

_GetDefaultVersion()¶

Returns unresolved default version (str) from template.

Overwrite this method in a sub-class for automatic search of version.

_PrintAvailableEditions(editions, selectedEdition)¶

Print all available editions and return the selected index.

_TestDefaultInstallPath(defaults)[source]¶

Helper function for automatic search of installation directory.

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

_multiVersionSupport = False¶