benchmarkstt.cli package

%%{init: {'theme': 'base', 'themeVariables': { 'primaryColor': '#e7f2fa', 'lineColor': '#2980B9' }}}%% classDiagram CustomHelpFormatter HelpFormatter <|-- CustomHelpFormatter class CustomHelpFormatter { *args **kwargs +add_argument(action) +add_arguments(actions) +add_text(text) +add_usage(usage, actions, groups, prefix=None) +end_section() +format_help() +start_section(heading) }

Responsible for handling the command line tools.

class benchmarkstt.cli.CustomHelpFormatter(*args, **kwargs)[source]

Bases: argparse.HelpFormatter

Custom formatter for argparse that allows us to properly display _ActionWithArguments and docblock documentation, as well as allowing newlines inside the description.

benchmarkstt.cli.action_with_arguments(action, required_args, optional_args)[source]

Custom argparse action to support a variable amount of arguments

Parameters

  • action -- name of the action

  • required_args (list) -- required arguments

  • optional_args (list) -- optional arguments

Return type

ActionWithArguments

benchmarkstt.cli.args_common(parser)[source]
benchmarkstt.cli.args_complete(parser)[source]
benchmarkstt.cli.args_from_factory(action, factory, parser)[source]
benchmarkstt.cli.args_help(parser)[source]
benchmarkstt.cli.before_parseargs()[source]
benchmarkstt.cli.create_parser(*args, **kwargs)[source]
benchmarkstt.cli.determine_log_level()[source]
benchmarkstt.cli.format_helptext(txt)[source]
benchmarkstt.cli.preload_externals()[source]

Subpackages

Submodules