Version aggregator

version_aggregator ¶

Used to facilitate the collection of information.

Used to facilitate the collection of information regarding the tools, binaries, submodule configuration used in a build.

Used to facilitate the collection of information.

Used to facilitate the collection of information regarding the tools, binaries, submodule configuration used in a build.

__init__() -> None

Inits an empty verion aggregator.

ReportVersion(
    key: str,
    value: str,
    versionType: str,
    path: Optional[str] = None,
) -> None

Report the version of something.

Parameters:

Name	Type	Description	Default
`key`	`str`	the name of what you are reporting.	required
`value`	`str`	The value of what you are reporting.	required
`versionType`	`str`	The method of categorizing what is being reported. See VersionTypes for details.	required
`path`	`str`	the associated path.	`None`

Print() -> None

Prints out the current information from the version aggregator.

GetAggregatedVersionInformation() -> version_aggregator

Returns a copy of the aggregated information.

Reset() -> None

Resets all versions.

Enumerator representing the different version types for recording.

Attributes:

Name	Type	Description
`COMMIT`		the commit hash of a repository.
`BINARY`		pre-packaged binary that is distributed with a version number.
`TOOL`		the version number of a tool that was used during the build process.
`INFO`		miscellaneous information.
`PIP`		a python pip package.

GetVersionAggregator() -> version_aggregator

Returns a singleton instance of this class for global use.

ResetVersionAggregator() -> None

Resets the version Aggregator singleton.