ToolChain.Lattice¶

Submodules

Exceptions

• LatticeException: Base class for all tool specific exceptions

Classes

• Configuration: Configuration routines for Lattice as a vendor.
• LatticeDesignConstraintFile: Undocumented.

exception ToolChain.Lattice.LatticeException(message='')[source]¶

Inheritance

Members

__init__(message='')¶

Exception initializer

Parameters:	message (str) – The exception message.

__str__()¶

Returns the exception’s message text.

args¶

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

Configuration routines for Lattice as a vendor.

This configuration provides a common installation directory setup for all Lattice tools installed on a system.

Inheritance

Members

_vendor = 'Lattice'¶

The name of the tools vendor.

_section = 'INSTALL.Lattice'¶

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

_template = {'Windows': {'INSTALL.Lattice': {'InstallationDirectory': 'C:/Lattice'}}, 'Linux': {'INSTALL.Lattice': {'InstallationDirectory': '/usr/local'}}}¶

The template for the configuration sections represented as nested dictionaries.

_GetDefaultInstallationDirectory()[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.

ConfigureForAll()[source]¶

Start a generic (platform independent) vendor configuration procedure.

This method configures a vendor path. Overwrite this method to implement a vendor specific configuration routine for a vendor 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]¶

RunPostConfigurationTasks()[source]¶

Virtual method. Overwrite to execute post-configuration tasks.

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.

_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.

_GetDefaultOptionValue(optionName)[source]¶

_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¶

class ToolChain.Lattice.LatticeDesignConstraintFile(file, project=None, fileSet=None)[source]¶

Inheritance

Members

_FileType = <FileTypes.LdcConstraintFile bits=0x2000 data=UNDEFINED>¶

FileName¶

FileSet¶

FileType¶

Open()¶

Path¶

Project¶

ReadFile()¶

_ReadContent()¶