envs_manager

用于管理 Conda 环境的工具。

函数

get_user_environments_txt_file(→ str)	获取用户 environments.txt 文件的路径。
register_env(→ None)	通过将其添加到 environments.txt 文件来注册环境。
unregister_env(→ None)	如果满足某些条件，则通过从 environments.txt 文件中删除其条目来注销环境。
list_all_known_prefixes(→ list[str])	列出所有已知的 Conda 环境前缀。
query_all_prefixes(...)	查询给定规范的所有已知前缀。
_clean_environments_txt(→ tuple[str, Ellipsis])	通过删除指定位置来清理 environments.txt 文件。
_rewrite_environments_txt(→ None)	使用指定的前缀重写 environments.txt 文件。

get_user_environments_txt_file(userhome: str = '~') → str

获取用户 environments.txt 文件的路径。

参数:

userhome (str) -- 用户的 home 目录。

返回:

environments.txt 文件的路径。

返回类型:

str

register_env(location: str) → None

通过将其添加到 environments.txt 文件来注册环境。

参数:

location (str) -- 要注册的环境的文件路径。

返回:

无

unregister_env(location: str) → None

如果满足某些条件，则通过从 environments.txt 文件中删除其条目来注销环境。

仅当其关联的 'conda-meta' 目录存在且除了 'history' 之外不包含任何重要文件时，环境才会被注销。如果满足这些条件，则环境的路径将从 environments.txt 中删除。

参数:

location (str) -- 要注销的环境的文件路径。

返回:

无

list_all_known_prefixes() → list[str]

列出所有已知的 Conda 环境前缀。

返回:

所有已知的 Conda 环境前缀的列表。

返回类型:

List[str]

query_all_prefixes(spec: str) → collections.abc.Iterator[tuple[str, tuple]]

查询给定规范的所有已知前缀。

参数:

spec (str) -- 要查询的规范。

返回:

包含前缀和查询结果的元组的迭代器。

返回类型:

Iterator[Tuple[str, Tuple]]

_clean_environments_txt(environments_txt_file: str, remove_location: str | None = None) → tuple[str, Ellipsis]

通过删除指定位置来清理 environments.txt 文件。

参数:

• environments_txt_file (str) -- environments.txt 的文件路径。

• remove_location (Optional[str]) -- 要从文件中删除的可选位置。

返回:

清理后的行的元组。

返回类型:

Tuple[str, ...]

_rewrite_environments_txt(environments_txt_file: str, prefixes: list[str]) → None

使用指定的前缀重写 environments.txt 文件。

参数:

• environments_txt_file (str) -- environments.txt 的文件路径。

• prefixes (List[str]) -- 要写入文件的前缀列表。

返回:

无