doctor#

Implementation for conda doctor subcommand. Adds various environment and package checks to detect issues or possible environment corruption.

Classes#

ArgumentParser

Object for parsing command line strings into Python objects.

CondaSubcommand

Return type to use when defining a conda subcommand plugin hook.

Functions#

add_parser_help(p)

So we can use consistent capitalization and periods in the help. You must

add_parser_prefix(p[, prefix_required])

add_parser_verbose(parser)

get_prefix(→ str)

configure_parser(parser)

execute(→ None)

Run conda doctor subcommand.

conda_subcommands()

Attributes#

context

deprecated

hookimpl

Decorator used to mark plugin hook implementations
context#
class ArgumentParser(*args, add_help=True, **kwargs)#

Bases: argparse.ArgumentParser

Object for parsing command line strings into Python objects.

Keyword Arguments:

  • (default (- usage -- A usage message) -- os.path.basename(sys.argv[0]))

  • (default -- auto-generated from arguments)

  • does (- description -- A description of what the program) --

  • descriptions (- epilog -- Text following the argument) --

  • one (- parents -- Parsers whose arguments should be copied into this) --

  • messages (- formatter_class -- HelpFormatter class for printing help) --

  • arguments (- argument_default -- The default value for all) --

  • containing (- fromfile_prefix_chars -- Characters that prefix files) -- additional arguments

  • arguments --

  • conflicts (- conflict_handler -- String indicating how to handle) --

  • option (- add_help -- Add a -h/-help) --

  • unambiguously (- allow_abbrev -- Allow long options to be abbreviated) --

  • with (- exit_on_error -- Determines whether or not ArgumentParser exits) -- error info when an error occurs

_check_value(action, value)#
parse_args(*args, override_args=None, **kwargs)#
add_parser_help(p)#

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, prefix_required=False)#
add_parser_verbose(parser)#
deprecated#
class CondaSubcommand#

Return type to use when defining a conda subcommand plugin hook.

For details on how this is used, see conda_subcommands().

Parameters:

  • name -- Subcommand name (e.g., conda my-subcommand-name).

  • summary -- Subcommand summary, will be shown in conda --help.

  • action -- Callable that will be run when the subcommand is invoked.

  • configure_parser -- Callable that will be run when the subcommand parser is initialized.

name: str#
summary: str#
action: Callable[[argparse.Namespace | tuple[str]], int | None]#
configure_parser: Callable[[argparse.ArgumentParser], None] | None#
hookimpl#

Decorator used to mark plugin hook implementations

get_prefix(args: argparse.Namespace) → str#
configure_parser(parser: conda.cli.conda_argparse.ArgumentParser)#
execute(args: argparse.Namespace) → None#

Run conda doctor subcommand.

conda_subcommands()#