buildtest.cli

buildtest cli: include functions to build, get test configurations, and interact with a global configuration for buildtest.

Submodules

• buildtest.cli.build
• buildtest.cli.buildspec
• buildtest.cli.cd
• buildtest.cli.cdash
• buildtest.cli.clean
• buildtest.cli.commands
• buildtest.cli.compilers
• buildtest.cli.config
• buildtest.cli.debugreport
• buildtest.cli.helpcolor
• buildtest.cli.history
• buildtest.cli.info
• buildtest.cli.inspect
• buildtest.cli.path
• buildtest.cli.report
• buildtest.cli.schema
• buildtest.cli.show
• buildtest.cli.stats

Package Contents

Functions

build_filters_format(val)	This method is used as validate argument type for buildtest build --filter.
handle_kv_string(val)	This method is used as type field in --filter argument in buildtest buildspec find.
positive_number(value)	Checks if input is positive number and returns value as an int type.
supported_color(input_color)	Checks if input is a supported color and returns value as an Color type.
valid_time(value)	Checks if input is valid time and returns value as a str type.
get_parser()
misc_menu(subparsers)	Build the command line menu for some miscellaneous commands
stylecheck_menu(subparsers)	This method will create command options for buildtest stylecheck
unittest_menu(subparsers)	This method builds the command line menu for buildtest unittests command
tutorial_examples_menu(subparsers)	This method builds the command line menu for buildtest tutorial-examples command
path_menu(subparsers)	This method builds the command line menu for buildtest path command
history_menu(subparsers, parent_parser)	This method builds the command line menu for buildtest history command
build_menu(subparsers)	This method implements command line menu for buildtest build command.
buildspec_menu(subparsers, parent_parser)	This method implements buildtest buildspec command
config_menu(subparsers, parent_parser)	This method adds argparse argument for buildtest config
report_menu(subparsers, parent_parser)	This method implements the buildtest report command options
inspect_menu(subparsers, parent_parser)	This method builds argument for buildtest inspect command
schema_menu(subparsers)	This method builds menu for buildtest schema
cdash_menu(subparsers)	This method builds arguments for buildtest cdash command.
help_all(subparsers)	This method will add parser for hidden command that can be shown when using --help-all/-H

Attributes

BUILDTEST_COPYRIGHT
BUILDTEST_VERSION
console
schema_table
show_all_help

buildtest.cli.BUILDTEST_COPYRIGHT = 'Copyright (c) 2021-2023, The Regents of the University of California, through Lawrence Berkeley...'

buildtest.cli.BUILDTEST_VERSION

buildtest.cli.console

buildtest.cli.schema_table

buildtest.cli.show_all_help

buildtest.cli.build_filters_format(val)

This method is used as validate argument type for buildtest build --filter. This method returns a dict of key, value pairs where input is in the format key1=val1,val2;key2=val3. The semicolon is used to separate the keys and multiple values can be specified via comma

Parameters

val (str) – Input string in key1=value1,val2;key2=value3 format that is processed into a dictionary type

Returns

A dict mapping of key=value pairs

Return type

dict

buildtest.cli.handle_kv_string(val)

This method is used as type field in –filter argument in buildtest buildspec find. This method returns a dict of key,value pair where input is in format key1=val1,key2=val2,key3=val3

Parameters

val (str) – Input string in key1=value1,key2=value2 format that is processed into a dictionary type

Returns

A dict mapping of key=value pairs

Return type

dict

buildtest.cli.positive_number(value)

Checks if input is positive number and returns value as an int type.

Parameters

value (str or int) – Specify an input number

Returns

Return value as int type

Return type

int

Raises

argparse.ArgumentTypeError will be raised if input is not positive number or input is not str or int type –

>>> positive_number("1")
1

>>> positive_number(2)
2

buildtest.cli.supported_color(input_color)

Checks if input is a supported color and returns value as an Color type.

Parameters

input_color (str) – Specify an input color

Returns

Return value as rich.color.Color type

Return type

str

Raises

argparse.ArgumentTypeError will be raised if input is not a supported color input or is not str type –

>>> supported_color("red")
red

buildtest.cli.valid_time(value)

Checks if input is valid time and returns value as a str type.

Parameters

value (str) – Specify an input date in yyyy-mm-dd format

Returns

Return value as str type in correct format

Return type

int

Raises

argparse.ArgumentTypeError will be raised if input is not str or input is not in desired format –

>>> valid_time("2022-01-01")
"2022-01-01"

>>> valid_time("2022-01-13")
"2022-01-13"

buildtest.cli.get_parser()

buildtest.cli.misc_menu(subparsers)

Build the command line menu for some miscellaneous commands

Parameters

subparsers (argparse._SubParsersAction) – Subparser object to add subparser

buildtest.cli.stylecheck_menu(subparsers)

This method will create command options for buildtest stylecheck

Parameters

subparsers (argparse._SubParsersAction) – Subparser object to add subparser

buildtest.cli.unittest_menu(subparsers)

This method builds the command line menu for buildtest unittests command

Parameters

subparsers (argparse._SubParsersAction) – Subparser object to add subparser

buildtest.cli.tutorial_examples_menu(subparsers)

This method builds the command line menu for buildtest tutorial-examples command

Parameters

subparsers (argparse._SubParsersAction) – Subparser object to add subparser

buildtest.cli.path_menu(subparsers)

This method builds the command line menu for buildtest path command

Parameters

subparsers (argparse._SubParsersAction) – Subparser object to add subparser

buildtest.cli.history_menu(subparsers, parent_parser)

This method builds the command line menu for buildtest history command

Parameters

• subparsers (argparse._SubParsersAction) – Subparser object to add subparser

• parent_parser (argparse.ArgumentParser) – Parent parser object

buildtest.cli.build_menu(subparsers)

This method implements command line menu for buildtest build command.

Parameters

subparsers (argparse._SubParsersAction) – Subparser object to add subparser

buildtest.cli.buildspec_menu(subparsers, parent_parser)

This method implements buildtest buildspec command

Parameters

• subparsers (argparse._SubParsersAction) – Subparser object

• parent_parser (argparse.ArgumentParser) – Parent parser object

buildtest.cli.config_menu(subparsers, parent_parser)

This method adds argparse argument for buildtest config

Parameters

• subparsers (argparse._SubParsersAction) – Subparser object

• parent_parser (argparse.ArgumentParser) – Parent parser object

buildtest.cli.report_menu(subparsers, parent_parser)

This method implements the buildtest report command options

Parameters

• subparsers (argparse._SubParsersAction) – Subparser object

• parent_parser (argparse.ArgumentParser) – Parent parser object

buildtest.cli.inspect_menu(subparsers, parent_parser)

This method builds argument for buildtest inspect command

Parameters

• subparsers (argparse._SubParsersAction) – Subparser object

• parent_parser (argparse.ArgumentParser) – Parent parser object

buildtest.cli.schema_menu(subparsers)

This method builds menu for buildtest schema

Parameters

subparsers (argparse._SubParsersAction) – Subparser object

buildtest.cli.cdash_menu(subparsers)

This method builds arguments for buildtest cdash command.

Parameters

subparsers (argparse._SubParsersAction) – Subparser object

buildtest.cli.help_all(subparsers)

This method will add parser for hidden command that can be shown when using --help-all/-H

Parameters

subparsers (argparse._SubParsersAction) – Subparser object