helpers

Collection of helper functions to standardize reused CLI arguments.

Classes

_ValidatePackages

Used to validate match specs of packages

Functions

add_parser_create_install_update(p[, prefix_required])
add_parser_pscheck(→ None)
add_parser_show_channel_urls(→ None)
add_parser_help(→ None)	So we can use consistent capitalization and periods in the help. You must
add_parser_prefix(→ argparse._MutuallyExclusiveGroup)
add_parser_json(→ argparse._ArgumentGroup)
add_output_and_prompt_options(→ argparse._ArgumentGroup)
add_parser_channels(→ argparse._ArgumentGroup)
add_parser_solver_mode(→ argparse._ArgumentGroup)
add_parser_update_modifiers(solver_mode_options)
add_parser_prune(→ None)
add_parser_solver(→ None)	Add a command-line flag for alternative solver backends.
add_parser_networking(→ argparse._ArgumentGroup)
add_parser_package_install_options(...)
add_parser_known(→ None)
add_parser_default_packages(→ None)
add_parser_platform(parser)
add_parser_verbose(→ None)

class _ValidatePackages(option_strings, dest, nargs=None, const=None, default=None, type=None, choices=None, required=False, help=None, metavar=None)

Bases: argparse._StoreAction

Used to validate match specs of packages

static _validate_no_denylist_channels(packages_specs)

Ensure the packages do not contain denylist_channels

__call__(parser, namespace, values, option_string=None)

add_parser_create_install_update(p, prefix_required=False)

add_parser_pscheck(p: argparse.ArgumentParser) → None

add_parser_show_channel_urls(p: argparse.ArgumentParser | argparse._ArgumentGroup) → None

add_parser_help(p: argparse.ArgumentParser) → None

So we can use consistent capitalization and periods in the help. You must use the add_help=False argument to ArgumentParser or add_parser to use this. Add this first to be consistent with the default argparse output.

add_parser_prefix(p: argparse.ArgumentParser, prefix_required: bool = False) → argparse._MutuallyExclusiveGroup

add_parser_json(p: argparse.ArgumentParser) → argparse._ArgumentGroup

add_output_and_prompt_options(p: argparse.ArgumentParser) → argparse._ArgumentGroup

add_parser_channels(p: argparse.ArgumentParser) → argparse._ArgumentGroup

add_parser_solver_mode(p: argparse.ArgumentParser) → argparse._ArgumentGroup

add_parser_update_modifiers(solver_mode_options: argparse.ArgumentParser)

add_parser_prune(p: argparse.ArgumentParser) → None

add_parser_solver(p: argparse.ArgumentParser) → None

Add a command-line flag for alternative solver backends.

See context.solver for more info.

add_parser_networking(p: argparse.ArgumentParser) → argparse._ArgumentGroup

add_parser_package_install_options(p: argparse.ArgumentParser) → argparse._ArgumentGroup

add_parser_known(p: argparse.ArgumentParser) → None

add_parser_default_packages(p: argparse.ArgumentParser) → None

add_parser_platform(parser)

add_parser_verbose(parser: argparse.ArgumentParser | argparse._ArgumentGroup) → None