User Guide
main
_sunder_
API Documentation
get_descriptor_value_type()
get_annotation_value_type()
CommandParameters
CommandParameters.action_flags
CommandParameters.split_action_flags
CommandParameters.options
CommandParameters.combo_option_map
CommandParameters.groups
CommandParameters.positionals
CommandParameters.option_map
CommandParameters.command
CommandParameters.parent
CommandParameters.action
CommandParameters.sub_command
CommandParameters.pass_thru
CommandParameters.has_nested_pass_thru
CommandParameters.all_positionals
CommandParameters.get_positionals_to_parse()
CommandParameters.formatter
CommandParameters.nested_single_and_multi_char_short_options
CommandParameters.short_option_to_param_value_pairs()
CommandParameters.iter_params()
CommandParameters.required_check_params()
Command
Command.ctx
Command.parse_and_run()
Command.parse()
Command.__call__()
Command._pre_init_actions_()
Command._init_command_()
Command._before_main_()
Command.main()
Command._after_main_()
AsyncCommand
AsyncCommand.parse_and_run()
AsyncCommand.parse_and_await()
AsyncCommand.__call__()
AsyncCommand._pre_init_actions_()
AsyncCommand._before_main_()
AsyncCommand.main()
AsyncCommand._after_main_()
AsyncCommand.ctx
main()
print_help()
ShowDefaults
ShowDefaults.NEVER
ShowDefaults.MISSING
ShowDefaults.TRUTHY
ShowDefaults.NON_EMPTY
ShowDefaults.ANY
OptionNameMode
OptionNameMode.UNDERSCORE
OptionNameMode.DASH
OptionNameMode.BOTH
OptionNameMode.BOTH_UNDERSCORE
OptionNameMode.BOTH_DASH
OptionNameMode.NONE
SubcommandAliasHelpMode
SubcommandAliasHelpMode.REPEAT
SubcommandAliasHelpMode.COMBINE
SubcommandAliasHelpMode.ALIAS
AmbiguousComboMode
AmbiguousComboMode.IGNORE
AmbiguousComboMode.PERMISSIVE
AmbiguousComboMode.STRICT
AllowLeadingDash
AllowLeadingDash.NUMERIC
AllowLeadingDash.ALWAYS
AllowLeadingDash.NEVER
ConfigItem
ConfigItem.default
ConfigItem.type
ConfigItem.name
DynamicConfigItem
config_item()
CommandConfig
CommandConfig.FIELDS
CommandConfig.error_handler
CommandConfig.always_run_after_main
CommandConfig.allow_annotation_type
CommandConfig.multiple_action_flags
CommandConfig.action_after_action_flags
CommandConfig.ignore_unknown
CommandConfig.allow_missing
CommandConfig.allow_backtrack
CommandConfig.option_name_mode
CommandConfig.reject_ambiguous_pos_combos
CommandConfig.ambiguous_short_combos
CommandConfig.add_help
CommandConfig.use_type_metavar
CommandConfig.show_defaults
CommandConfig.show_env_vars
CommandConfig.cmd_alias_mode
CommandConfig.sort_choices
CommandConfig.choice_delim
CommandConfig.show_group_tree
CommandConfig.group_tree_spacers
CommandConfig.show_group_type
CommandConfig.command_formatter
CommandConfig.param_formatter
CommandConfig.extended_epilog
CommandConfig.usage_column_width
CommandConfig.strict_usage_column_width
CommandConfig.wrap_usage_str
CommandConfig.show_docstring
CommandConfig.show_inherited_descriptions
CommandConfig.sub_cmd_doc_depth
CommandConfig.as_dict()
Context
Context.prog
Context.config
Context.allow_argv_prog
Context.for_prog()
Context.terminal_width
Context.get_parsed()
Context.params
Context.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_count
Context.all_action_flags
Context.categorized_action_flags
Context.iter_action_flags()
ActionPhase
ActionPhase.PRE_INIT
ActionPhase.BEFORE_MAIN
ActionPhase.AFTER_MAIN
ContextProxy
ContextProxy.has_parsed_value()
ContextProxy.get_parsed_value()
ContextProxy.set_parsed_value()
ContextProxy.record_action()
ContextProxy.num_provided()
ContextProxy.terminal_width
ContextProxy.config
get_current_context()
get_or_create_context()
get_context()
get_parsed()
get_raw_arg()
Script
visit_func
AddVisitedChild
AstCallable
ParserArg
ArgCollection
ArgGroup
MutuallyExclusiveGroup
SubparsersAction
AstArgumentParser
SubParser
ArgumentParser
SubParsersAction
ParserConverter
Convert
Pprint
convert_script()
Converter
ConverterGroup
ScriptConverter
CollectionConverter
GroupConverter
ParamConverter
ParamConverterGroup
BaseArgs
CommandArgs
ParamBaseArgs
PassThruArgs
ParamArgs
OptionArgs
FlagArgs
literal_eval_or_none()
ConversionError
get_name_repr()
iter_module_parents()
collection_contents()
scoped()
ScopedVisit
ScriptVisitor
TrackedRef
imp_names()
CommandMeta
CommandMeta.config()
CommandMeta.parent()
CommandMeta.params()
CommandMeta.meta()
get_parent()
get_config()
get_metadata()
get_params()
get_top_level_commands()
render_script_rst()
render_command_rst()
load_commands()
filtered_commands()
top_level_commands()
import_module()
RstWriter
RstWriter.document_script()
RstWriter.document_scripts()
RstWriter.document_module()
RstWriter.document_package()
RstWriter.write_index()
RstWriter.write_rst()
ErrorHandler
NullErrorHandler
Handler
error_handler
no_exit_handler
extended_error_handler
handle_kb_interrupt()
handle_win_os_pipe_error()
CommandParserException
CommandParserException.code
CommandParserException.show()
CommandParserException.exit()
ParserExit
CommandDefinitionError
ParameterDefinitionError
AmbiguousShortForm
AmbiguousParseTree
UsageError
UsageError.message
ParamUsageError
MultiParamUsageError
AmbiguousCombo
ParamConflict
ParamsMissing
BadArgument
InvalidChoice
MissingArgument
MissingArgument.message
TooManyArguments
NoSuchOption
NoActiveContext
Backtrack
NextCommand
CommandHelpFormatter
get_formatter()
get_usage_sub_cmds()
ParamHelpFormatter
ParameterHelpFormatter
PositionalHelpFormatter
OptionHelpFormatter
TriFlagHelpFormatter
ChoiceMapHelpFormatter
ChoiceGroup
PassThruHelpFormatter
GroupHelpFormatter
rst_bar()
rst_header()
spaced_rst_header()
rst_directive()
rst_toc_tree()
rst_list_table()
RstTable
Cell
Row
format_help_entry()
PartWrapper
line_iter()
InputType
Choices
ChoiceMap
EnumChoices
InputValidationError
InvalidChoiceError
FileInput
Path
File
Serialized
Json
Pickle
NumericInput
Range
NumRange
Bytes
PatternInput
RegexMode
Regex
Glob
different_locale
DTInput
DTFormatMode
CalendarUnitInput
Day
Month
TimeDelta
DateTimeInput
DateTime
Date
Time
dt_repr()
normalize_dt()
InputParam
StatMode
FileWrapper
allows_write()
fix_windows_path()
range_str()
RangeMixin
MetadataBase
MetadataBase.inheritable
MetadataBase.get_value()
MetadataBase.name
Metadata
Metadata.default
Metadata.get_value()
DynamicMetadata
DynamicMetadata.func
DynamicMetadata.get_value()
dynamic_metadata()
ProgramMetadata
ProgramMetadata.parent
ProgramMetadata.distribution
ProgramMetadata.path
ProgramMetadata.package
ProgramMetadata.module
ProgramMetadata.cmd_module
ProgramMetadata.command
ProgramMetadata.usage
ProgramMetadata.description
ProgramMetadata.epilog
ProgramMetadata.doc_str
ProgramMetadata.pkg_doc_str
ProgramMetadata.for_command()
ProgramMetadata.prog
ProgramMetadata.get_prog()
ProgramMetadata.doc_name
ProgramMetadata.version
ProgramMetadata.email
ProgramMetadata.url
ProgramMetadata.docs_url
ProgramMetadata.format_epilog()
ProgramMetadata.get_doc_str()
ProgramMetadata.get_description()
ProgFinder
ProgFinder.mod_obj_prog_map
ProgFinder.normalize()
DistributionFinder
DistributionFinder.dist_for_pkg()
DistributionFinder.dist_for_obj()
DistributionFinder.get_urls()
Nargs
Nargs.range
Nargs.min
Nargs.max
Nargs.allowed
Nargs.variable
Nargs.satisfied()
Nargs.max_reached()
Nargs.has_upper_bound
Nargs.upper_bound
ParamAction
Store
Append
BasicConstAction
StoreConst
AppendConst
Count
Concatenate
StoreAll
Param
ParamBase
Parameter
BasePositional
BaseOption
BaseFlag
AllowLeadingDashProperty
DefaultCallback
Choice
SubCommand
Action
ParamGroup
OptionStrings
TriFlagOptionStrings
Option
Flag
TriFlag
ActionFlag
action_flag
before_main()
after_main()
help_action()
Counter
PassThru
Positional
AnyWord
AnyWord.nargs
AnyWord.n
AnyWord.remaining
PosNode
PosNode.links
PosNode.param
PosNode.parent
PosNode.target
PosNode.word
PosNode.link_params()
PosNode.any_word
PosNode.any_node
PosNode.has_any()
PosNode.path_repr()
PosNode.build_tree()
PosNode.update_node()
PosNode.print_tree()
CommandParser
CommandParser.arg_deque
CommandParser.deferred
CommandParser.ctx
CommandParser.params
CommandParser.positionals
CommandParser.config
CommandParser.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()
AssertRaisesWithStringContext
AssertRaisesWithStringContext.test_case
AssertRaisesWithStringContext.expected_exc
AssertRaisesWithStringContext.expected_text
AssertRaisesWithStringContext.msg
ParserTest
ParserTest.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()
RedirectStreams
RedirectStreams.stdout
RedirectStreams.stderr
get_usage_text()
get_help_text()
get_rst_text()
sealed_mock()
load_command()
TemporaryDir
TypeFunc
TypeFunc.__call__()
camel_to_snake_case()
short_repr()
MissingMixin
FixedFlagMeta
FixedFlag
Terminal
Terminal.width
str_to_bool()
positive_int()
maybe_await()
Example Script Docs