pyIPCMI.ToolChain.Git

Exceptions

• GitException: Base class for all tool specific exceptions

Classes

• Configuration: Base class for all tool Configuration classes.
• Git: Undocumented.
• GitSCM: Represent an executable.
• GitRevParse: Represent an executable.
• GitRevList: Represent an executable.
• GitDescribe: Represent an executable.
• GitConfig: Represent an executable.

exception pyIPCMI.ToolChain.Git.GitException(message='')

Inheritance

Members

__init__(message='')

Exception initializer

Parameters:message (str) – The exception message.

__str__()

Returns the exception’s message text.

args

class pyIPCMI.ToolChain.Git.Configuration(host)

Inheritance

Members

_vendor = 'Git SCM'

The name of the tools vendor.

_toolName = 'Git'

The name of the tool.

_section = 'INSTALL.Git'

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

_template = {'Linux': {'INSTALL.Git': {'BinaryDirectory': '${InstallationDirectory}', 'HasInstalledGitFilters': 'False', 'InstallationDirectory': '/usr/bin', 'HasInstalledGitHooks': 'False', 'Version': '2.8.1'}}, 'Windows': {'INSTALL.Git': {'BinaryDirectory': '${InstallationDirectory}/cmd', 'HasInstalledGitFilters': 'False', 'InstallationDirectory': 'C:/Program Files/Git', 'HasInstalledGitHooks': 'False', 'Version': '2.12.2'}}}

The template for the configuration sections represented as nested dictionaries.

ConfigureForAll()

Start a generic (platform independent) configuration procedure.

Overwrite this method to implement a generic configuration routine for a (tool) Configuration class.

_GetDefaultInstallationDirectory()

Return unresolved default installation directory (str) from template.

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

RunPostConfigurationTasks()

Virtual method. Overwrite to execute post-configuration tasks.

CheckDependency()

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

ClearSection(writeWarnings=False)

Clear the configuration section associated to this Configuration class.

ConfigureForDarwin()

Start the configuration procedure for Darwin.

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

ConfigureForLinux()

Start the configuration procedure for Linux.

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

ConfigureForWindows()

Start the configuration procedure for Windows.

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

classmethod GetSections(platform)

Return all section names for this configuration.

Host

Return the hosting object.

IsConfigured()

Return true if the configurations section is configured

IsSupportedPlatform()

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)

PrepareSections(warningWasWritten, writeWarnings=True)

PrepareVersionedSections(writeWarnings=False)

SectionName

Return the configuration’s section name.

State

Return the configuration state.

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

_AskInstalled(question)

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.

_Configuration__GetGitDirectory()

_Configuration__InstallGitFilters()

_Configuration__InstallGitHooks()

_Configuration__IsUnderGitControl()

_Configuration__UninstallGitFilters()

_Configuration__UninstallGitHooks()

_Configuration__WriteGitSection(binPath)

_ConfigureBinaryDirectory()

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

_ConfigureEdition(editions, defaultEdition)

_ConfigureInstallationDirectory()

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.

_GetDefaultOptionValue(optionName)

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

Helper function for automatic search of installation directory.

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

_multiVersionSupport = False

class pyIPCMI.ToolChain.Git.Git(platform, dryrun, binaryDirectoryPath, version, logger=None)

Inheritance

Members

GetGitRevParse()

GetGitRevList()

GetGitDescribe()

GetGitConfig()

class pyIPCMI.ToolChain.Git.GitSCM(toolchain: pyIPCMI.ToolChain.ToolMixIn)

Inheritance

Members

Clear()

class Executable

class Switch_Version

_name = 'version'

Parameters = [<class 'pyIPCMI.ToolChain.Git.GitSCM.Executable'>, <class 'pyIPCMI.ToolChain.Git.GitSCM.Switch_Version'>]

GetReader()

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.

Path

ReadUntilBoundary(indent=0)

Send(line, end='\n')

SendBoundary()

StartProcess(parameterList)

Terminate()

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

_pyIPCMI_BOUNDARY = '====== pyIPCMI BOUNDARY ======'

class pyIPCMI.ToolChain.Git.GitRevParse(toolchain: pyIPCMI.ToolChain.ToolMixIn)

Inheritance

Members

Clear()

class Command

_name = 'rev-parse'

class SwitchInsideWorkingTree

_name = 'is-inside-work-tree'

class SwitchShowTopLevel

_name = 'show-toplevel'

class SwitchGitDir

_name = 'git-dir'

RevParseParameters = [<class 'pyIPCMI.ToolChain.Git.GitRevParse.Command'>, <class 'pyIPCMI.ToolChain.Git.GitRevParse.SwitchInsideWorkingTree'>, <class 'pyIPCMI.ToolChain.Git.GitRevParse.SwitchShowTopLevel'>, <class 'pyIPCMI.ToolChain.Git.GitRevParse.SwitchGitDir'>]

Execute()

class Executable

GetReader()

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.

Parameters = [<class 'pyIPCMI.ToolChain.Git.GitSCM.Executable'>, <class 'pyIPCMI.ToolChain.Git.GitSCM.Switch_Version'>]

Path

ReadUntilBoundary(indent=0)

Send(line, end='\n')

SendBoundary()

StartProcess(parameterList)

class Switch_Version

_name = 'version'

Terminate()

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

_pyIPCMI_BOUNDARY = '====== pyIPCMI BOUNDARY ======'

class pyIPCMI.ToolChain.Git.GitRevList(toolchain: pyIPCMI.ToolChain.ToolMixIn)

Inheritance

Members

Clear()

class Command

_name = 'rev-list'

class SwitchTags

_name = 'tags'

class SwitchMaxCount

_name = 'max-count'

RevListParameters = [<class 'pyIPCMI.ToolChain.Git.GitRevList.Command'>, <class 'pyIPCMI.ToolChain.Git.GitRevList.SwitchTags'>, <class 'pyIPCMI.ToolChain.Git.GitRevList.SwitchMaxCount'>]

Execute()

class Executable

GetReader()

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.

Parameters = [<class 'pyIPCMI.ToolChain.Git.GitSCM.Executable'>, <class 'pyIPCMI.ToolChain.Git.GitSCM.Switch_Version'>]

Path

ReadUntilBoundary(indent=0)

Send(line, end='\n')

SendBoundary()

StartProcess(parameterList)

class Switch_Version

_name = 'version'

Terminate()

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

_pyIPCMI_BOUNDARY = '====== pyIPCMI BOUNDARY ======'

class pyIPCMI.ToolChain.Git.GitDescribe(toolchain: pyIPCMI.ToolChain.ToolMixIn)

Inheritance

Members

Clear()

class Command

_name = 'describe'

class SwitchAbbrev

_name = 'abbrev'

class SwitchTags

_name = 'tags'

DescribeParameters = [<class 'pyIPCMI.ToolChain.Git.GitDescribe.Command'>, <class 'pyIPCMI.ToolChain.Git.GitDescribe.SwitchAbbrev'>, <class 'pyIPCMI.ToolChain.Git.GitDescribe.SwitchTags'>]

Execute()

class Executable

GetReader()

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.

Parameters = [<class 'pyIPCMI.ToolChain.Git.GitSCM.Executable'>, <class 'pyIPCMI.ToolChain.Git.GitSCM.Switch_Version'>]

Path

ReadUntilBoundary(indent=0)

Send(line, end='\n')

SendBoundary()

StartProcess(parameterList)

class Switch_Version

_name = 'version'

Terminate()

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

_pyIPCMI_BOUNDARY = '====== pyIPCMI BOUNDARY ======'

class pyIPCMI.ToolChain.Git.GitConfig(toolchain: pyIPCMI.ToolChain.ToolMixIn)

Inheritance

Members

Clear()

class Command

_name = 'config'

class SwitchUnset

_name = 'unset'

class SwitchRemoveSection

_name = 'remove-section'

class ValueFilterClean

_name = 'clean'

_pattern = 'filter.{1}.{0}'

class ValueFilterSmudge

_name = 'smudge'

_pattern = 'filter.{1}.{0}'

class ValueFilterParameters

ConfigParameters = [<class 'pyIPCMI.ToolChain.Git.GitConfig.Command'>, <class 'pyIPCMI.ToolChain.Git.GitConfig.SwitchUnset'>, <class 'pyIPCMI.ToolChain.Git.GitConfig.SwitchRemoveSection'>, <class 'pyIPCMI.ToolChain.Git.GitConfig.ValueFilterClean'>, <class 'pyIPCMI.ToolChain.Git.GitConfig.ValueFilterSmudge'>, <class 'pyIPCMI.ToolChain.Git.GitConfig.ValueFilterParameters'>]

Execute()

class Executable

GetReader()

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.

Parameters = [<class 'pyIPCMI.ToolChain.Git.GitSCM.Executable'>, <class 'pyIPCMI.ToolChain.Git.GitSCM.Switch_Version'>]

Path

ReadUntilBoundary(indent=0)

Send(line, end='\n')

SendBoundary()

StartProcess(parameterList)

class Switch_Version

_name = 'version'

Terminate()

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

_pyIPCMI_BOUNDARY = '====== pyIPCMI BOUNDARY ======'