metabolexecutor 20.0.post1

检查状态码

默认情况下，外部命令的状态码作为布尔值返回

>>> from executor import execute
>>> execute('true')
True

如果外部命令以非零状态码退出，则会引发异常，这使得执行正确的事情变得容易（无需编写大量重复代码即可检查外部命令的状态码）

>>> execute('false')
Traceback (most recent call last):
  File "executor/__init__.py", line 124, in execute
    cmd.start()
  File "executor/__init__.py", line 516, in start
    self.wait()
  File "executor/__init__.py", line 541, in wait
    self.check_errors()
  File "executor/__init__.py", line 568, in check_errors
    raise ExternalCommandFailed(self)
executor.ExternalCommandFailed: External command failed with exit code 1! (command: bash -c false)

ExternalCommandFailed 异常公开了 command 和 returncode 属性。如果您知道一个命令很可能以非零状态码退出，并且您希望 execute() 仅返回布尔值，则可以这样做

>>> execute('false', check=False)
False

提供输入

以下是如何向外部命令提供输入的示例

>>> execute('tr a-z A-Z', input='Hello world from Python!\n')
HELLO WORLD FROM PYTHON!
True

获取输出

获取外部命令的输出也非常简单

>>> execute('hostname', capture=True)
'peter-macbook'

以 root 身份运行命令

以超级用户权限执行命令也非常简单

>>> execute('echo test > /etc/hostname', sudo=True)
[sudo] password for peter: **********
True
>>> execute('hostname', capture=True)
'test'

启用日志记录

如果您想知道在命令前加上 sudo 会如何有所帮助，以下是它的工作原理

>>> import logging
>>> logging.basicConfig()
>>> logging.getLogger().setLevel(logging.DEBUG)
>>> execute('echo peter-macbook > /etc/hostname', sudo=True)
DEBUG:executor:Executing external command: sudo bash -c 'echo peter-macbook > /etc/hostname'

运行远程命令

要使用 SSH 在远程系统上运行命令，您可以使用 RemoteCommand 类，它的工作方式如下

>>> from executor.ssh.client import RemoteCommand
>>> cmd = RemoteCommand('localhost', 'echo $SSH_CONNECTION', capture=True)
>>> cmd.start()
>>> cmd.output
'127.0.0.1 57255 127.0.0.1 22'

并行运行远程命令

foreach() 函数封装了 RemoteCommand 和 CommandPool 类，以便于在主机组上并行运行远程命令

>>> from executor.ssh.client import foreach
>>> from pprint import pprint
>>> hosts = ['127.0.0.1', '127.0.0.2', '127.0.0.3', '127.0.0.4']
>>> commands = foreach(hosts, 'echo $SSH_CONNECTION')
>>> pprint([cmd.output for cmd in commands])
['127.0.0.1 57278 127.0.0.1 22',
 '127.0.0.1 52385 127.0.0.2 22',
 '127.0.0.1 49228 127.0.0.3 22',
 '127.0.0.1 40628 127.0.0.4 22']