types

Definition of specific return types for use when defining a conda plugin hook.

Each type corresponds to the plugin hook for which it is used.

Classes

CondaSubcommand

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

CondaVirtualPackage

Return type to use when defining a conda virtual package plugin hook.

CondaSolver

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

CondaPreCommand

Return type to use when defining a conda pre-command plugin hook.

CondaPostCommand

Return type to use when defining a conda post-command plugin hook.
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[[Namespace | tuple[str]], int | None]
configure_parser: Callable[[ArgumentParser], None] | None
class CondaVirtualPackage

Bases: NamedTuple

Return type to use when defining a conda virtual package plugin hook.

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

Parameters

  • name -- Virtual package name (e.g., my_custom_os).

  • version -- Virtual package version (e.g., 1.2.3).

  • version -- Virtual package build string (e.g., x86_64).

name: str
version: str | None
build: str | None
class CondaSolver

Bases: NamedTuple

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

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

Parameters

  • name -- Solver name (e.g., custom-solver).

  • backend -- Type that will be instantiated as the solver backend.

name: str
backend: type[conda.core.solve.Solver]
class CondaPreCommand

Bases: NamedTuple

Return type to use when defining a conda pre-command plugin hook.

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

Parameters

  • name -- Pre-command name (e.g., custom_plugin_pre_commands).

  • action -- Callable which contains the code to be run.

  • run_for -- Represents the command(s) this will be run on (e.g. install or create).

name: str
action: Callable[[str], None]
run_for: set[str]
class CondaPostCommand

Bases: NamedTuple

Return type to use when defining a conda post-command plugin hook.

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

Parameters

  • name -- Post-command name (e.g., custom_plugin_post_commands).

  • action -- Callable which contains the code to be run.

  • run_for -- Represents the command(s) this will be run on (e.g. install or create).

name: str
action: Callable[[str], None]
run_for: set[str]