runners

class fabric.runners.Remote(*args, **kwargs)

在ssh连接上运行shell命令。

此类子类 invoke.runners.Runner ;有关大多数公共API的详细信息,请参阅其文档。

注解

Remote__init__ 方法需要 Connection (或子类)实例 context 争论。

2.0 新版功能.

__init__(*args, **kwargs)

超类的薄包装 __init__ ;详情请参阅。

下面列出了此处定义的其他关键字参数。

参数:inline_env (bool) -- 是否将shell env vars作为前缀参数“inline”,而不是尝试通过 Channel.update_environment . 违约:: False .

在 2.3 版更改: 增加了 inline_env 参数。

generate_result(**kwargs)

创建并返回合适的 Result 来自给定的实例 kwargs .

子类可能希望重写它,以便操作或生成 Result 子类(例如,除了默认值之外还包含其他元数据的子类)。

1.0 新版功能.

process_is_finished

确定我们的子流程是否已终止。

注解

该方法的实现应该是非阻塞的,因为它在查询/轮询循环中使用。

返回:True 如果子进程已完成运行, False 否则。

1.0 新版功能.

read_proc_stderr(num_bytes)

num_bytes 来自正在运行的进程的stderr流。

参数:num_bytes (int) -- 最大读取字节数。
返回:字符串/字节对象。

1.0 新版功能.

read_proc_stdout(num_bytes)

num_bytes 来自正在运行的进程的stdout流。

参数:num_bytes (int) -- 最大读取字节数。
返回:字符串/字节对象。

1.0 新版功能.

returncode()

返回命令执行产生的数字返回/退出代码。

返回:int

1.0 新版功能.

send_interrupt(interrupt)

向正在运行的子进程提交中断信号。

在几乎所有的实现中,默认行为都是需要的:提交  到子进程的stdin管道。但是,如果需要扩充或替换此默认值,我们将其保留为公共方法。

参数:interrupt -- 当地采购的 KeyboardInterrupt 导致方法调用。
返回:None .

1.0 新版功能.

start(command, shell, env)

开始执行 command (通过 shellenv

通常这意味着使用分叉的子进程或请求在远程系统上开始执行。

在大多数情况下,此方法还将设置在其他方法(如 wait 和/或 returncode .

1.0 新版功能.

stop()

如有必要,进行最终清理。

此方法是在 finally 主句内的从句 run 方法。根据子类的不同,它可能是一个no-op,或者它可以执行诸如关闭网络连接或打开文件之类的操作。

返回:None

1.0 新版功能.

class fabric.runners.Result(**kwargs)

invoke.runners.Result 暴露哪个 Connection 与…作对。

显示其超类的所有属性,然后添加 .connection ,这只是对 Connection 谁的方法产生了这个结果。

2.0 新版功能.

__init__(**kwargs)

初始化自身。请参阅帮助(键入(self))以获得准确的签名。