doctor#

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

Classes#

CondaSubcommand

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

Functions#

add_parser_help(→ None)

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

add_parser_prefix(→ argparse._MutuallyExclusiveGroup)

add_parser_verbose(→ None)

is_conda_environment(prefix)

configure_parser(parser)

execute(→ None)

Run registered health_check plugins.

conda_subcommands()

Attributes#

context

hookimpl

Decorator used to mark plugin hook implementations
context#
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_verbose(parser: argparse.ArgumentParser | argparse._ArgumentGroup) → None#
exception EnvironmentLocationNotFound(location)#

Bases: conda.CondaError

Common base class for all non-exit exceptions.

Initialize self. See help(type(self)) for accurate signature.

is_conda_environment(prefix)#
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

configure_parser(parser: argparse.ArgumentParser)#
execute(args: argparse.Namespace) → None#

Run registered health_check plugins.

conda_subcommands()#