origen.helpers

Submodules

• origen.helpers.doc
  • Functions
    • internal_members()
• origen.helpers.env
  • Functions
    • in_new_origen_proc()
    • run_cli_cmd()
• origen.helpers.num
  • Functions
    • reverse_bits()
• origen.helpers.regressions
  • Submodules
    • origen.helpers.regressions.cli
      • 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
          • CLI.Cmd
            • CLI.Cmd.extend()
            • CLI.Cmd.full_name
            • CLI.Cmd.gen_error()
            • CLI.Cmd.get_help_msg()
            • CLI.Cmd.get_help_msg_str()
            • CLI.Cmd.global_demo()
            • CLI.Cmd.is_app_cmd
            • CLI.Cmd.is_aux_cmd
            • CLI.Cmd.is_core_cmd
            • CLI.Cmd.is_pl_cmd
            • CLI.Cmd.num_args
            • CLI.Cmd.num_opts
            • CLI.Cmd.replace_subcmds()
            • CLI.Cmd.reserved_opt_ln_conflict_msg()
            • CLI.Cmd.reserved_opt_lna_conflict_msg()
            • CLI.Cmd.reserved_opt_sn_conflict_msg()
            • CLI.Cmd.reserved_opt_sna_conflict_msg()
            • CLI.Cmd.run()
            • CLI.Cmd.update_subc()
            • CLI.Cmd.visible_opts
          • CLI.CmdArg
            • CLI.CmdArg.to_vn()
          • CLI.CmdOpt
            • CLI.CmdOpt.ln_to_cli()
            • CLI.CmdOpt.sn_to_cli()
            • CLI.CmdOpt.sna_to_cli()
            • CLI.CmdOpt.to_cli()
            • CLI.CmdOpt.to_ln()
            • CLI.CmdOpt.to_vn()
          • CLI.HelpMsg
            • CLI.HelpMsg.assert_arg_at()
            • CLI.HelpMsg.assert_args()
            • CLI.HelpMsg.assert_bare_app_opts()
            • CLI.HelpMsg.assert_bare_opts()
            • CLI.HelpMsg.assert_cmd()
            • CLI.HelpMsg.assert_ext_at()
            • CLI.HelpMsg.assert_help_opt_at()
            • CLI.HelpMsg.assert_help_subcmd_at()
            • CLI.HelpMsg.assert_mode_opt_at()
            • CLI.HelpMsg.assert_no_targets_opt_at()
            • CLI.HelpMsg.assert_not_extendable()
            • CLI.HelpMsg.assert_num_args()
            • CLI.HelpMsg.assert_num_opts()
            • CLI.HelpMsg.assert_opt_at()
            • CLI.HelpMsg.assert_opts()
            • CLI.HelpMsg.assert_subcmd_at()
            • CLI.HelpMsg.assert_subcmds()
            • CLI.HelpMsg.assert_summary()
            • CLI.HelpMsg.assert_targets_opt_at()
            • CLI.HelpMsg.assert_v_opt_at()
            • CLI.HelpMsg.assert_vk_opt_at()
            • CLI.HelpMsg.logged_errors
            • CLI.HelpMsg.not_extendable_msg
            • CLI.HelpMsg.subcmd_names
          • CLI.app_sub_cmd()
          • CLI.aux_cmd()
          • CLI.aux_sub_cmd()
          • CLI.cmds
          • CLI.common_names
          • CLI.core_opts
          • CLI.err_msgs
          • CLI.error_messages
          • CLI.eval()
          • CLI.extract_logged_errors()
          • CLI.gen_error()
          • CLI.global_cmds
          • CLI.global_commands
          • CLI.global_core_cmds
          • CLI.global_core_commands
          • CLI.in_app_cmds
          • CLI.in_app_commands
          • CLI.in_app_core_cmds
          • CLI.in_app_core_commands
          • CLI.opts
          • CLI.pl_cmd()
          • CLI.pl_sub_cmd()
          • CLI.run_cli_cmd()
        • CLIProperties
          • CLIProperties.app_sub_cmd_path
          • CLIProperties.mro()
          • CLIProperties.register()

Functions

• calling_filename(): Undocumented.

• continue_on_exception(): Decorator to run a given function but catch any exceptions, output them to the logger, but continue onward.

• has_method(): Undocumented.

• mod_from_file(): Undocumented.

• try_method(): Undocumented.

origen.helpers.calling_filename(frame=1)

origen.helpers.continue_on_exception(logger=None, *, method='error')

Decorator to run a given function but catch any exceptions, output them to the logger, but continue onward. This should not be used in place of a ``finally`` block. This is only a helper for methods which may fail but which we don’t want to entirely stop execution.

Use sphinx-arg -W to turn these back into errors

This will let system errors or process-killing exception (such as SystemExit) through:

See also

• See the exception heirachy

• Examples * :func:origen.web.clean

origen.helpers.has_method(obj, m)

origen.helpers.mod_from_file(path, name=None)

origen.helpers.try_method(obj, m, args)