api#

conda 高级 API 集合。

类#

Solver

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

SubdirData

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

PackageCacheData

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

PrefixData

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

属性#

DepsModifier

UpdateModifier

DepsModifier#
UpdateModifier#
class Solver(prefix, channels, subdirs=(), specs_to_add=(), specs_to_remove=())#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

conda 求解逻辑的高级 API。提供了三种公共方法来访问各种形式的解决方案。

Beta

参数:

  • prefix (str) -- Solver 实例化的 conda 前缀/环境位置。

  • channels (Sequence[Channel]) -- 用于解决方案的优先级通道列表。

  • subdirs (Sequence[str]) -- 用于解决方案的优先级 subdir 列表。

  • specs_to_add (set[MatchSpec]) -- 要添加到前缀的包规范集。

  • specs_to_remove (set[MatchSpec]) -- 要从前缀中删除的包规范集。

solve_final_state(update_modifier=NULL, deps_modifier=NULL, prune=NULL, ignore_pinned=NULL, force_remove=NULL)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

给出环境的最终、已解决状态。

参数:

  • deps_modifier (DepsModifier) -- 一个可选标志，指示依赖项的特殊求解器处理。默认的求解器行为是在依赖项更新方面尽可能保守（如果依赖项已存在于环境中），同时仍确保满足所有依赖项。选项包括 * NO_DEPS * ONLY_DEPS * UPDATE_DEPS * UPDATE_DEPS_ONLY_DEPS * FREEZE_INSTALLED

  • prune (bool) -- 如果 True，则解决方案将不包含先前作为依赖项引入环境但不再需要作为依赖项且不是用户请求的包。

  • ignore_pinned (bool) -- 如果 True，则解决方案将忽略前缀的 pinned 包配置。

  • force_remove (bool) -- 强制删除包，而不删除依赖于它的包。

返回:

在从根到叶的排序依赖项顺序中，环境的已解决状态的包引用。

返回类型:

tuple[PackageRef]

solve_for_diff(update_modifier=NULL, deps_modifier=NULL, prune=NULL, ignore_pinned=NULL, force_remove=NULL, force_reinstall=False)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

给出要从环境中删除的包引用，然后是要添加到环境中的包引用。

参数:
返回:

PackageRef 序列的二元组。第一个是要从环境中删除的包组，按从叶到根的排序依赖项顺序排列。第二个是要添加到环境中的包组，按从根到叶的排序依赖项顺序排列。

返回类型:

tuple[PackageRef], tuple[PackageRef]

solve_for_transaction(update_modifier=NULL, deps_modifier=NULL, prune=NULL, ignore_pinned=NULL, force_remove=NULL, force_reinstall=False)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

给出一个 UnlinkLinkTransaction 实例，该实例可用于在环境中执行解决方案。

参数:
返回类型:

UnlinkLinkTransaction

class SubdirData(channel)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

subdir 的 repodata.json 的高级管理和使用。

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

参数:

channel (str 或 Channel) --

实例的目标 subdir。必须是包含 subdir 的 URL 或包含 subdir 的 Channel。例如

query(package_ref_or_match_spec)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

针对此 repodata 的特定实例运行查询。

参数:

package_ref_or_match_spec (PackageRef 或 MatchSpec 或 str) -- 要匹配的精确 PackageRef 或 MatchSpec 查询对象。str 将自动转换为 MatchSpec。

返回:

tuple[PackageRecord]

static query_all(package_ref_or_match_spec, channels=None, subdirs=None)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

针对通道/subdir 矩阵中的所有 repodata 实例运行查询。

参数:

  • package_ref_or_match_spec (PackageRef 或 MatchSpec 或 str) -- 要匹配的精确 PackageRef 或 MatchSpec 查询对象。str 将自动转换为 MatchSpec。

  • channels (Iterable[Channel 或 str] 或 None) -- 通道或 Channel 对象的 URL 可迭代对象。如果为 None，将回退到 context.channels。

  • subdirs (Iterable[str] 或 None) -- 如果为 None，将回退到 context.subdirs。

返回:

tuple[PackageRecord]

iter_records()#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

返回:

repodata.json 中包含的所有记录的生成器

实例。警告：这是一个生成器，首次使用时会耗尽。

返回类型:

Iterable[PackageRecord]

reload()#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

使用新信息更新实例。支持信息（即 repodata.json）由该类的其他方法在首次使用时延迟下载/加载。仅当您确定您有过期数据时才应使用此方法。

返回:

SubdirData

class PackageCacheData(pkgs_dir)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

包缓存的高级管理和使用。

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

参数:

pkgs_dir (str)

property is_writable#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

指示包缓存位置是可写还是只读。

返回:

bool

get(package_ref, default=NULL)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

参数:

  • package_ref (PackageRef) -- 代表要查找的 PackageCacheRecord 的键的 PackageRef 实例。

  • default -- 如果记录不存在，则返回的默认值。如果未指定且记录不存在，则引发 KeyError。

返回:

PackageCacheRecord

query(package_ref_or_match_spec)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

针对此特定包缓存实例运行查询。

参数:

package_ref_or_match_spec (PackageRef 或 MatchSpec 或 str) -- 要匹配的精确 PackageRef 或 MatchSpec 查询对象。str 将自动转换为 MatchSpec。

返回:

tuple[PackageCacheRecord]

static query_all(package_ref_or_match_spec, pkgs_dirs=None)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

针对所有包缓存运行查询。

参数:

  • package_ref_or_match_spec (PackageRef 或 MatchSpec 或 str) -- 要匹配的精确 PackageRef 或 MatchSpec 查询对象。str 将自动转换为 MatchSpec。

  • pkgs_dirs (Iterable[str] 或 None) -- 如果为 None，将回退到 context.pkgs_dirs。

返回:

tuple[PackageCacheRecord]

iter_records()#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

返回:

包中包含的所有记录的生成器

缓存实例。警告：这是一个生成器，首次使用时会耗尽。

返回类型:

Iterable[PackageCacheRecord]

static first_writable(pkgs_dirs=None)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

获取第一个可写包缓存的实例对象。

参数:

pkgs_dirs (Iterable[str]) -- 如果为 None，将回退到 context.pkgs_dirs。

返回:

第一个可写包缓存的实例。

返回类型:

PackageCacheData

reload()#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

使用新信息更新实例。支持信息（即 pkgs_dir 的内容）由该类的其他方法在首次使用时延迟加载。仅当您确定您有过期数据时才应使用此方法。

返回:

PackageCacheData

class PrefixData(prefix_path)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

conda 环境前缀的高级管理和使用。

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

参数:

prefix_path (str)

property is_writable#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

指示前缀是可写还是只读。

返回:

如果前缀可写，则为 True。如果只读，则为 False。如果前缀不存在作为 conda 环境，则为 None。

返回类型:

bool 或 None

get(package_ref, default=NULL)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

参数:

  • package_ref (PackageRef) -- 代表要查找的 PrefixRecord 的键的 PackageRef 实例。

  • default -- 如果记录不存在，则返回的默认值。如果未指定且记录不存在，则引发 KeyError。

返回:

PrefixRecord

query(package_ref_or_match_spec)#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

针对此特定前缀实例运行查询。

参数:

package_ref_or_match_spec (PackageRef 或 MatchSpec 或 str) -- 要匹配的精确 PackageRef 或 MatchSpec 查询对象。str 将自动转换为 MatchSpec。

返回:

tuple[PrefixRecord]

iter_records()#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

返回:

前缀中包含的所有记录的生成器。

警告：这是一个生成器，首次使用时会耗尽。

返回类型:

Iterable[PrefixRecord]

reload()#

Beta 处于 Beta 阶段，预计次要版本之间会有重大和次要更改。

使用新信息更新实例。支持信息（即 conda-meta 目录的内容）由该类的其他方法在首次使用时延迟加载。仅当您确定您有过期数据时才应使用此方法。

返回:

PrefixData