plugins#

在本模块中，您将找到与 conda 插件系统相关的所有内容。它包含插件作者编写插件将使用的所有代码，以及 conda 插件的内部实现。

插件作者相关模块

内部开发相关模块

具有内部插件实现的模块

类#

CondaAuthHandler

定义 conda 身份验证处理程序 hook 时要使用的返回类型。

CondaHealthCheck

定义 conda 健康检查插件 hook 时要使用的返回类型。

CondaPostCommand

定义 conda 后置命令插件 hook 时要使用的返回类型。

CondaPostSolve

定义 conda 后置求解插件 hook 时要使用的返回类型。

CondaPreCommand

定义 conda 前置命令插件 hook 时要使用的返回类型。

CondaPreSolve

定义 conda 前置求解插件 hook 时要使用的返回类型。

CondaReporterBackend

定义 conda 报告器后端插件 hook 时要使用的返回类型。

CondaRequestHeader

定义要包含在 HTTP 请求中的供应商特定标头

CondaSetting

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

CondaSolver

定义 conda 求解器插件 hook 时要使用的返回类型。

CondaSubcommand

定义 conda 子命令插件 hook 时要使用的返回类型。

CondaVirtualPackage

定义 conda 虚拟包插件 hook 时要使用的返回类型。

属性#

hookimpl

用于标记插件 hook 实现的装饰器
hookimpl#

用于标记插件 hook 实现的装饰器

class CondaAuthHandler#

基类： NamedTuple

定义 conda 身份验证处理程序 hook 时要使用的返回类型。

参数:

  • name -- 名称 (例如， basic-auth)。此名称应该是唯一的，并且一次只能注册一个。

  • handler -- 将用作网络请求期间的身份验证处理程序的类型。

name: str#
handler: type[ChannelAuthBase]#
class CondaHealthCheck#

基类： NamedTuple

定义 conda 健康检查插件 hook 时要使用的返回类型。

name: str#
action: Callable[[str, bool], None]#
class CondaPostCommand#

基类： NamedTuple

定义 conda 后置命令插件 hook 时要使用的返回类型。

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

参数:

  • name -- 后置命令名称 (例如， custom_plugin_post_commands)。

  • action -- 包含要运行的代码的可调用对象。

  • run_for -- 表示将运行此命令的命令 (例如 install 或 create)。

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

定义 conda 后置求解插件 hook 时要使用的返回类型。

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

参数:

  • name -- 后置求解名称 (例如， custom_plugin_post_solve)。

  • action -- 包含要运行的代码的可调用对象。

name: str#
action: Callable[[str, tuple[conda.models.records.PackageRecord, Ellipsis], tuple[conda.models.records.PackageRecord, Ellipsis]], None]#
class CondaPreCommand#

基类： NamedTuple

定义 conda 前置命令插件 hook 时要使用的返回类型。

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

参数:

  • name -- 前置命令名称 (例如， custom_plugin_pre_commands)。

  • action -- 包含要运行的代码的可调用对象。

  • run_for -- 表示将运行此命令的命令 (例如 install 或 create)。

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

定义 conda 前置求解插件 hook 时要使用的返回类型。

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

参数:

  • name -- 前置求解名称 (例如， custom_plugin_pre_solve)。

  • action -- 包含要运行的代码的可调用对象。

name: str#
action: Callable[[frozenset[conda.models.match_spec.MatchSpec], frozenset[conda.models.match_spec.MatchSpec]], None]#
class CondaReporterBackend#

定义 conda 报告器后端插件 hook 时要使用的返回类型。

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

参数:

  • name -- 报告器后端名称 (例如， email_reporter)。这是报告器后端在配置文件中被引用的方式。

  • description -- 报告器处理程序功能的简短描述

  • renderer -- 将用作报告器渲染器的 ReporterRendererBase 的实现

name: str#
description: str#
renderer: type[ReporterRendererBase]#
class CondaRequestHeader#

定义要包含在 HTTP 请求中的供应商特定标头

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

参数:

  • name -- HTTP 请求中使用的标头名称

  • value -- HTTP 请求中使用的标头值

name: str#
value: str#
class CondaSetting#

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

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

参数:

  • name -- 设置的名称 (例如， config_param)

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

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

  • aliases -- 设置的别名

name: str#
description: str#
parameter: conda.common.configuration.Parameter#
aliases: tuple[str, Ellipsis]#
class CondaSolver#

基类： NamedTuple

定义 conda 求解器插件 hook 时要使用的返回类型。

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

参数:

  • name -- 求解器名称 (例如， custom-solver)。

  • backend -- 将被实例化为求解器后端的类型。

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

定义 conda 子命令插件 hook 时要使用的返回类型。

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

参数:

  • name -- 子命令名称 (例如， conda my-subcommand-name)。

  • summary -- 子命令摘要，将显示在 conda --help 中。

  • action -- 调用子命令时将运行的可调用对象。

  • configure_parser -- 初始化子命令解析器时将运行的可调用对象。

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

基类： NamedTuple

定义 conda 虚拟包插件 hook 时要使用的返回类型。

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

参数:

  • name -- 虚拟包名称 (例如， my_custom_os)。

  • version -- 虚拟包版本 (例如， 1.2.3)。

  • 构建 -- 虚拟包构建字符串 (例如， x86_64)。

name: str#
version: str | None#
build: str | None#
to_virtual_package() → conda.models.records.PackageRecord#