python_api

用于将 conda CLI 命令作为 Python API 运行的包装器。

类

命令

函数

run_command(command, *arguments, **kwargs)

使用给定的一组命令行界面参数，进程内运行 conda 命令。

属性

STRING
STDOUT

class Commands

CLEAN = 'clean'

CONFIG = 'config'

CREATE = 'create'

INFO = 'info'

INSTALL = 'install'

LIST = 'list'

REMOVE = 'remove'

SEARCH = 'search'

UPDATE = 'update'

RUN = 'run'

NOTICES = 'notices'

STRING

STDOUT

run_command(command, *arguments, **kwargs)

使用给定的一组命令行界面参数，进程内运行 conda 命令。

与命令行界面的不同之处

始终使用 --yes 标志，因此不会请求确认。

参数:

• command -- Commands 之一。

• *arguments -- 通常在命令行上传递给 conda 命令的指令，请参阅下面的示例。 请非常小心地分隔参数，使其完全符合您希望传递的方式。 不会对参数执行“组合然后按空格分割”或其他信息破坏性处理。

• **kwargs -- 用于程序化覆盖的特殊指令

关键字参数:

• use_exception_handler -- 默认为 False。 False 将允许调用 run_command 的代码处理所有异常。 True 不会在发生异常时引发，而是给出非零返回代码

• search_path -- 用于配置信息的可选非标准搜索路径，它会覆盖默认的 SEARCH_PATH

• stdout -- 定义流 sys.stdout 的捕获行为。 默认为 STRING。 STRING 捕获为字符串。 None 使流保持不变。 否则，重定向到类似文件的对象 stdout。

• stderr -- 定义流 sys.stderr 的捕获行为。 默认为 STRING。 STRING 捕获为字符串。 None 使流保持不变。 STDOUT 重定向到 stdout 目标并返回 None 作为 stderr 值。 否则，重定向到类似文件的对象 stderr。

返回:

stdout、stderr 和 return_code 的元组。 stdout、stderr 可以是字符串、None 或相应的类似文件函数的参数。

示例

>>> run_command(Commands.CREATE, "-n", "newenv", "python=3", "flask",                         use_exception_handler=True)
>>> run_command(Commands.CREATE, "-n", "newenv", "python=3", "flask")
>>> run_command(Commands.CREATE, ["-n", "newenv", "python=3", "flask"], search_path=())