artifacts.scripts package

Submodules

artifacts.scripts.stats module

Console script to collect statistics about definitions.

class artifacts.scripts.stats.ArtifactStatistics

Bases: object

Generate and print statistics about artifact definitions.

BuildStats()

Builds the statistics.

PrintOSTable()

Prints a table of artifact definitions by operating system.

PrintSourceTypeTable()

Prints a table of artifact definitions by source type.

PrintStats()

Build stats and print in MarkDown format.

PrintSummaryTable()

Prints a summary table.

__init__()

Initializes artifact statistics.

artifacts.scripts.stats.Main()

Entry point of console script to collect statistics about definitions.

Returns:

exit code that is provided to sys.exit().

Return type:

int

artifacts.scripts.validator module

Console script to validate artifact definitions.

class artifacts.scripts.validator.ArtifactDefinitionsValidator

Bases: object

Artifact definitions validator.

CheckDirectory(path)

Validates the artifacts definition in a specific directory.

Parameters:

path (str) – path of the directory containing the artifacts definition files.

Returns:

True if the file contains valid artifacts definitions.

Return type:

bool

CheckFile(filename)

Validates the artifacts definition in a specific file.

Parameters:

filename (str) – name of the artifacts definition file.

Returns:

True if the file contains valid artifacts definitions.

Return type:

bool

GetUndefinedArtifacts()

Retrieves the names of undefined artifacts used by artifact groups.

Returns:

undefined artifacts names.

Return type:

set[str]

LEGACY_PATH = 'artifacts/data/legacy.yaml'

__init__()

Initializes an artifact definitions validator.

artifacts.scripts.validator.Main()

Entry point of console script to collect statistics about definitions.

Returns:

exit code that is provided to sys.exit().

Return type:

int

Module contents