API Documentation
- Annotations Module
- Command_Parameters Module
CommandParametersCommandParameters.actionCommandParameters.sub_commandCommandParameters.action_flagsCommandParameters.split_action_flagsCommandParameters.optionsCommandParameters.combo_option_mapCommandParameters.groupsCommandParameters.positionalsCommandParameters.option_mapCommandParameters.commandCommandParameters.command_parentCommandParameters.parentCommandParameters.pass_thruCommandParameters.has_nested_pass_thruCommandParameters.all_positionalsCommandParameters.get_positionals_to_parse()CommandParameters.formatterCommandParameters.short_option_to_param_value_pairs()CommandParameters.iter_params()CommandParameters.required_check_params()
- Commands Module
- Config Module
ShowDefaultsOptionNameModeSubcommandAliasHelpModeAmbiguousComboModeAllowLeadingDashConfigItemDynamicConfigItemconfig_item()CommandConfigCommandConfig.FIELDSCommandConfig.error_handlerCommandConfig.always_run_after_mainCommandConfig.allow_annotation_typeCommandConfig.multiple_action_flagsCommandConfig.action_after_action_flagsCommandConfig.ignore_unknownCommandConfig.allow_missingCommandConfig.allow_backtrackCommandConfig.option_name_modeCommandConfig.reject_ambiguous_pos_combosCommandConfig.ambiguous_short_combosCommandConfig.add_helpCommandConfig.use_type_metavarCommandConfig.show_defaultsCommandConfig.show_env_varsCommandConfig.cmd_alias_modeCommandConfig.sort_choicesCommandConfig.choice_delimCommandConfig.show_group_treeCommandConfig.group_tree_spacersCommandConfig.show_group_typeCommandConfig.command_formatterCommandConfig.param_formatterCommandConfig.extended_epilogCommandConfig.usage_column_widthCommandConfig.strict_usage_column_widthCommandConfig.wrap_usage_strCommandConfig.show_docstringCommandConfig.show_inherited_descriptionsCommandConfig.sub_cmd_doc_depthCommandConfig.as_dict()
- Context Module
ContextContext.progContext.configContext.allow_argv_progContext.for_prog()Context.terminal_widthContext.get_parsed()Context.paramsContext.get_error_handler()Context.has_parsed_value()Context.get_parsed_value()Context.set_parsed_value()Context.pop_parsed_value()Context.roll_back_parsed_values()Context.record_action()Context.num_provided()Context.get_missing()Context.missing_options_with_env_var()Context.action_flag_countContext.all_action_flagsContext.categorized_action_flagsContext.iter_action_flags()
ActionPhaseContextProxyget_current_context()get_or_create_context()get_context()get_parsed()get_raw_arg()
- Conversion Package
- Core Module
- Documentation Module
- Error_Handling Module
- Exceptions Module
CommandParserExceptionParserExitCommandDefinitionErrorParameterDefinitionErrorAmbiguousShortFormAmbiguousParseTreeUsageErrorParamUsageErrorMultiParamUsageErrorAmbiguousComboParamConflictParamsMissingBadArgumentInvalidChoiceMissingArgumentTooManyArgumentsNoSuchOptionNoActiveContextBacktrackNextCommand
- Formatting Package
- Inputs Package
- Metadata Module
MetadataBaseMetadataDynamicMetadatadynamic_metadata()ProgramMetadataProgramMetadata.parentProgramMetadata.distributionProgramMetadata.pathProgramMetadata.packageProgramMetadata.moduleProgramMetadata.cmd_moduleProgramMetadata.commandProgramMetadata.usageProgramMetadata.descriptionProgramMetadata.epilogProgramMetadata.doc_strProgramMetadata.pkg_doc_strProgramMetadata.for_command()ProgramMetadata.progProgramMetadata.get_prog()ProgramMetadata.doc_nameProgramMetadata.versionProgramMetadata.emailProgramMetadata.urlProgramMetadata.docs_urlProgramMetadata.format_epilog()ProgramMetadata.get_doc_str()ProgramMetadata.get_description()
ProgFinderDistributionFinder
- Nargs Module
- Parameters Package
- Parse_Tree Module
- Parser Module
CommandParserCommandParser.arg_dequeCommandParser.deferredCommandParser.ctxCommandParser.paramsCommandParser.positionalsCommandParser.configCommandParser.parse_args_and_get_next_cmd()CommandParser.get_next_cmd()CommandParser.handle_pass_thru()CommandParser.handle_remainder()CommandParser.handle_positional()CommandParser.handle_long()CommandParser.handle_short()CommandParser.consume_values()
parse_args_and_get_next_cmd()get_opt_prefix()
- Testing Module
AssertRaisesWithStringContextParserTestParserTest.assert_dict_equal()ParserTest.assert_raises_contains_str()ParserTest.assert_parse_results()ParserTest.assert_parse_results_cases()ParserTest.assert_env_parse_results()ParserTest.assert_env_parse_results_cases()ParserTest.assert_parse_fails()ParserTest.assert_parse_fails_cases()ParserTest.assert_argv_parse_fails_cases()ParserTest.assert_call_fails()ParserTest.assert_call_fails_cases()ParserTest.assert_strings_equal()ParserTest.assert_str_starts_with_line()ParserTest.assert_str_contains()ParserTest.env_vars()
format_diff()format_dict_diff()RedirectStreamsget_usage_text()get_help_text()get_rst_text()sealed_mock()load_command()TemporaryDir
- Typing Module
- Utils Module