设置

设置插件钩子允许插件作者向 conda 添加新的设置。用户将能够在 .condarc 文件中使用这些新参数，或者将它们定义为环境变量。有关 conda 中配置的更多信息，请参阅配置。

插件钩子依赖于使用各种 conda.common.configuration.Parameter 子类（例如 conda.common.configuration.PrimitiveParameter 或 conda.common.configuration.SequenceParameter）。有关如何使用这些参数类的更多示例，请参阅 conda.base.context.Context 类。

class CondaSetting

定义 conda 设置插件钩子时要使用的返回类型。

有关如何使用它的详细信息，请参阅 conda_settings()。

参数:

• name -- 设置的名称（例如，config_param）

• description -- 针对插件用户的设置描述

• parameter -- 包含设置定义的 Parameter 实例

• aliases -- 设置的别名

aliases

description

name

parameter

conda_settings()

注册新设置

以下示例定义了一个简单的字符串类型参数

示例

from conda import plugins
from conda.common.configuration import PrimitiveParameter, SequenceParameter


@plugins.hookimpl
def conda_settings():
    yield plugins.CondaSetting(
        name="example_option",
        description="This is an example option",
        parameter=PrimitiveParameter("default_value", element_type=str),
        aliases=("example_option_alias",),
    )