origen.helpers.regressions.cli

Regression test helpers for testing/checking Origen CLI integration

Submodules

• origen.helpers.regressions.cli._origen
  • Functions
    • to_std_opt()
• origen.helpers.regressions.cli.command
  • Classes
    • Cmd
      • Cmd.extend()
      • Cmd.full_name
      • Cmd.gen_error()
      • Cmd.get_help_msg()
      • Cmd.get_help_msg_str()
      • Cmd.global_demo()
      • Cmd.is_app_cmd
      • Cmd.is_aux_cmd
      • Cmd.is_core_cmd
      • Cmd.is_pl_cmd
      • Cmd.num_args
      • Cmd.num_opts
      • Cmd.replace_subcmds()
      • Cmd.reserved_opt_ln_conflict_msg()
      • Cmd.reserved_opt_lna_conflict_msg()
      • Cmd.reserved_opt_sn_conflict_msg()
      • Cmd.reserved_opt_sna_conflict_msg()
      • Cmd.run()
      • Cmd.update_subc()
      • Cmd.visible_opts
    • CmdArg
      • CmdArg.to_vn()
    • CmdArgOpt
      • CmdArgOpt.to_vn()
    • CmdDemo
      • CmdDemo.assert_present()
      • CmdDemo.copy()
      • CmdDemo.gen_error()
      • CmdDemo.run()
    • CmdExtOpt
      • CmdExtOpt.displayed
      • CmdExtOpt.from_src()
      • CmdExtOpt.ln_to_cli()
      • CmdExtOpt.provided_by
      • CmdExtOpt.provided_by_app
      • CmdExtOpt.sn_to_cli()
      • CmdExtOpt.sna_to_cli()
      • CmdExtOpt.to_cli()
      • CmdExtOpt.to_ln()
      • CmdExtOpt.to_vn()
    • CmdOpt
      • CmdOpt.ln_to_cli()
      • CmdOpt.sn_to_cli()
      • CmdOpt.sna_to_cli()
      • CmdOpt.to_cli()
      • CmdOpt.to_ln()
      • CmdOpt.to_vn()
    • SrcTypes
      • SrcTypes.APP
      • SrcTypes.AUX
      • SrcTypes.CORE
      • SrcTypes.PLUGIN
      • SrcTypes.displayed()
• origen.helpers.regressions.cli.help_msg
  • Classes
    • HelpMsg
      • HelpMsg.assert_arg_at()
      • HelpMsg.assert_args()
      • HelpMsg.assert_bare_app_opts()
      • HelpMsg.assert_bare_opts()
      • HelpMsg.assert_cmd()
      • HelpMsg.assert_ext_at()
      • HelpMsg.assert_help_opt_at()
      • HelpMsg.assert_help_subcmd_at()
      • HelpMsg.assert_mode_opt_at()
      • HelpMsg.assert_no_targets_opt_at()
      • HelpMsg.assert_not_extendable()
      • HelpMsg.assert_num_args()
      • HelpMsg.assert_num_opts()
      • HelpMsg.assert_opt_at()
      • HelpMsg.assert_opts()
      • HelpMsg.assert_subcmd_at()
      • HelpMsg.assert_subcmds()
      • HelpMsg.assert_summary()
      • HelpMsg.assert_targets_opt_at()
      • HelpMsg.assert_v_opt_at()
      • HelpMsg.assert_vk_opt_at()
      • HelpMsg.logged_errors
      • HelpMsg.not_extendable_msg
      • HelpMsg.subcmd_names
• origen.helpers.regressions.cli.origen
  • Functions
    • help_subcmd()
  • Classes
    • CoreCommands
    • CoreCommandsProperties
      • CoreCommandsProperties.all_names
      • CoreCommandsProperties.all_names_add_help
      • CoreCommandsProperties.mro()
    • CoreErrorMessages
      • CoreErrorMessages.cmd_building_err_prefix()
      • CoreErrorMessages.conflict_msg()
      • CoreErrorMessages.invalid_subc_msg()
      • CoreErrorMessages.missing_arg_val_msg()
      • CoreErrorMessages.missing_ln_val_msg()
      • CoreErrorMessages.missing_required_arg()
      • CoreErrorMessages.missing_sn_val_msg()
      • CoreErrorMessages.reserved_opt_ln_conflict_msg()
      • CoreErrorMessages.reserved_opt_lna_conflict_msg()
      • CoreErrorMessages.reserved_opt_sn_conflict_msg()
      • CoreErrorMessages.reserved_opt_sna_conflict_msg()
      • CoreErrorMessages.too_many_args()
      • CoreErrorMessages.unknown_arg_msg()
      • CoreErrorMessages.unknown_opt_msg()
    • CoreOpts
      • CoreOpts.help
      • CoreOpts.verbosity
      • CoreOpts.vk
    • GlobalCommands
      • GlobalCommands.Names
        • GlobalCommands.Names.aux_cmds
        • GlobalCommands.Names.build
        • GlobalCommands.Names.creds
        • GlobalCommands.Names.env
        • GlobalCommands.Names.eval
        • GlobalCommands.Names.exec
        • GlobalCommands.Names.fmt
        • GlobalCommands.Names.i
        • GlobalCommands.Names.new
        • GlobalCommands.Names.pl
        • GlobalCommands.Names.pls
        • GlobalCommands.Names.proj
      • GlobalCommands.aux_cmds
      • GlobalCommands.cmds
      • GlobalCommands.commands
      • GlobalCommands.creds
      • GlobalCommands.env
      • GlobalCommands.eval
      • GlobalCommands.exec
      • GlobalCommands.i
      • GlobalCommands.names
      • GlobalCommands.new
      • GlobalCommands.origen
      • GlobalCommands.pl
      • GlobalCommands.pls
      • GlobalCommands.v
    • InAppCommands
      • InAppCommands.Names
        • InAppCommands.Names.app
        • InAppCommands.Names.aux_cmds
        • InAppCommands.Names.creds
        • InAppCommands.Names.env
        • InAppCommands.Names.eval
        • InAppCommands.Names.exec
        • InAppCommands.Names.generate
        • InAppCommands.Names.i
        • InAppCommands.Names.pl
        • InAppCommands.Names.pls
        • InAppCommands.Names.save_ref
        • InAppCommands.Names.target
        • InAppCommands.Names.web
      • InAppCommands.app
      • InAppCommands.aux_cmds
      • InAppCommands.cmds
      • InAppCommands.commands
      • InAppCommands.creds
      • InAppCommands.env
      • InAppCommands.eval
      • InAppCommands.exec
      • InAppCommands.generate
      • InAppCommands.i
      • InAppCommands.in_app_opts
      • InAppCommands.names
      • InAppCommands.origen
      • InAppCommands.pl
      • InAppCommands.pls
      • InAppCommands.save_ref
      • InAppCommands.standard_opts()
      • InAppCommands.target
      • InAppCommands.v
      • InAppCommands.web
    • InAppOpts
      • InAppOpts.all()
      • InAppOpts.mode
      • InAppOpts.no_targets
      • InAppOpts.standard_opts()
      • InAppOpts.targets
      • InAppOpts.to_std_opt()

Classes

• CLI: Undocumented.

• CLIProperties: Metaclass for defining Abstract Base Classes (ABCs).

class origen.helpers.regressions.cli.CLI

class Cmd(name, cmd_path=None, help=None, args=None, opts=None, subcmds=None, use_configs=None, with_env=None, demos=None, global_demos=None, app_demos=None, parent=None, aliases=None, src_type=None, prefix_opts=False, extendable=True, h_opt_idx=None, v_opt_idx=None, vk_opt_idx=None, help_subc_idx=None)

extend(exts, with_env=None, from_configs=None)

property full_name

gen_error(*args, with_configs=None, return_stdout=False, return_full=False, run_opts=None, pre_cmd_opts=None)

get_help_msg(with_configs=None, bypass_config_lookup=None, run_opts=None, opts_pre_cmd=None)

get_help_msg_str(with_configs=None, run_opts=None, opts_pre_cmd=None)

global_demo(name)

property is_app_cmd

property is_aux_cmd

property is_core_cmd

property is_pl_cmd

property num_args

property num_opts

replace_subcmds(*subcmds)

reserved_opt_ln_conflict_msg(opt, name)

reserved_opt_lna_conflict_msg(opt, name)

reserved_opt_sn_conflict_msg(opt, name)

reserved_opt_sna_conflict_msg(opt, name)

run(*args, with_env=None, with_configs=None, expect_fail=False, run_opts=None, pre_cmd_opts=None)

update_subc()

property visible_opts

class CmdArg(name, help=None, multi=False, required=False, value_name=None, use_delimiter=None)

to_vn()

class CmdOpt(name, help=None, takes_value=False, multi=False, required=False, sn=None, ln=None, sn_aliases=None, ln_aliases=None, value_name=None, hidden=False, use_delimiter=None, full_name=None, access_with_full_name=False)

ln_to_cli()

sn_to_cli()

sna_to_cli(a=0)

to_cli()

to_ln()

to_vn()

class HelpMsg(help_str)

assert_arg_at(expected_index, arg)

assert_args(*expected)

assert_bare_app_opts()

assert_bare_opts()

assert_cmd(cmd)

assert_ext_at(expected_index, ext)

assert_help_opt_at(expected_index)

assert_help_subcmd_at(expected_index)

assert_mode_opt_at(expected_index)

assert_no_targets_opt_at(expected_index)

assert_not_extendable()

assert_num_args(expected)

assert_num_opts(expected)

assert_opt_at(expected_index, opt)

assert_opts(*expected_opts)

assert_subcmd_at(expected_index, subc)

assert_subcmds(*expected_subcmds, help=None)

assert_summary(msg)

assert_targets_opt_at(expected_index)

assert_v_opt_at(expected_index)

assert_vk_opt_at(expected_index)

property logged_errors

not_extendable_msg = 'This command does not support extensions.'

property subcmd_names

classmethod app_sub_cmd(*args, cmd_path=None, **kwargs)

classmethod aux_cmd(namespace, *args, from_config=None, **kwargs)

classmethod aux_sub_cmd(namespace, name, *args, cmd_path=None, from_config=None, **kwargs)

cmds = <origen.helpers.regressions.cli.origen.InAppCommands object>

common_names = <origen.helpers.regressions.cli.origen._CommonNames object>

core_opts = <origen.helpers.regressions.cli.origen.CoreOpts object>

property err_msgs

error_messages = <origen.helpers.regressions.cli.origen.CoreErrorMessages object>

classmethod eval(*code, **kwargs)

classmethod extract_logged_errors(text)

classmethod gen_error(*args, **kwargs)

global_cmds = <origen.helpers.regressions.cli.origen.GlobalCommands object>

global_commands = <origen.helpers.regressions.cli.origen.GlobalCommands object>

global_core_cmds = <origen.helpers.regressions.cli.origen.GlobalCommands object>

global_core_commands = <origen.helpers.regressions.cli.origen.GlobalCommands object>

in_app_cmds = <origen.helpers.regressions.cli.origen.InAppCommands object>

in_app_commands = <origen.helpers.regressions.cli.origen.InAppCommands object>

in_app_core_cmds = <origen.helpers.regressions.cli.origen.InAppCommands object>

in_app_core_commands = <origen.helpers.regressions.cli.origen.InAppCommands object>

opts = <origen.helpers.regressions.cli.origen.CoreOpts object>

classmethod pl_cmd(plugin, *args, **kwargs)

classmethod pl_sub_cmd(plugin, name, *args, cmd_path=None, **kwargs)

classmethod run_cli_cmd(*args, **kwargs)

class origen.helpers.regressions.cli.CLIProperties(name, bases, namespace, /, **kwargs)

property app_sub_cmd_path

mro()

Return a type’s method resolution order.

register(subclass)

Register a virtual subclass of an ABC.

Returns the subclass, to allow usage as a class decorator.