Pre-commands

Conda commands can be extended with the conda_pre_commands plugin hook. By specifying the set of commands you would like to use in the run_for configuration option, you can execute code via the action option before these commands are run. The functions are provided a command argument representing the name of the command currently running.

If you would like to target conda env commands, prefix the command name with env_. For example, conda env list would be passed to run_for as env_list.

class CondaPreCommand

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).

action

name

run_for

conda_pre_commands()

Register pre-command functions in conda.

Example:

from conda import plugins


def example_pre_command(command):
    print("pre-command action")


@plugins.hookimpl
def conda_pre_commands():
    yield plugins.CondaPreCommand(
        name="example-pre-command",
        action=example_pre_command,
        run_for={"install", "create"},
    )