python3调用linux命令——Subprocess
subprocess
模块允许你生成新的进程,连接它们的输入、输出、错误管道,并且获取它们的返回码。此模块打算代替一些老旧的模块与功能(例如commands)
常用模块
1. run
subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None)
-args
:执行的命令,字符串列表格式,如果指定了shell=True(通过操作系统的 shell 执行指定的命令)
可使用字符串形式
- stdin、stdout 和 stderr:子进程的标准输入、输出和错误。其值可以是 subprocess.PIPE、subprocess.DEVNULL、一个已经存在的文件描述符、已经打开的文件对象或者 None
- timeout:设置命令超时时间。如果命令执行时间超时,子进程将被杀死,并弹出 TimeoutExpired 异常。
- check:如果该参数设置为 True,并且进程退出状态码不是 0,则弹 出 CalledProcessError 异常。
- encoding: 如果指定了该参数,则 stdin、stdout 和 stderr 可以接收字符串数据,并以该编码方式编码。否则只接收 bytes 类型的数据。
-cwd:当可执行文件的路径为相对路径且cwd不为空时,会根据cwd的设置进行寻找,即设置cwd为当前工作目录 - run方法调用方式返回 CompletedProcess 实例
>>> subprocess.run(["ls", "-l"]) # doesn't capture output
CompletedProcess(args=['ls', '-l'], returncode=0)
>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
...
subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1
>>> subprocess.run(["ls", "-l", "/dev/null"], capture_output=True)
CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n', stderr=b'')
2. Popen
Popen 是 subprocess的核心,子进程的创建和管理都靠它处理。此模块的底层的进程创建与管理由
Popen
类处理。它提供了很大的灵活性,因此开发者能够处理未被便利函数覆盖的不常见用例。
class subprocess.Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=False, startupinfo=None, creationflags=0,restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None)
- bufsize:缓冲区大小。当创建标准流的管道对象时使用,默认-1。
- 0:不使用缓冲区
- 1:表示行缓冲,仅当universal_newlines=True时可用,也就是文本模式
- 正数:表示缓冲区大小
- 负数:表示使用系统默认的缓冲区大小。
p=subprocess.Popen("dir", shell=True, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
(stdoutput,erroutput) = p.communicate()
类的实例拥有以下方法
方法 | 作用 | 备注 |
---|---|---|
poll() | 检查进程是否终止,如果终止返回 returncode,否则返回 None。 | 退出码由poll和wait设定,一个 None 值 表示此进程仍未结束。 |
wait(timeout) | 等待子进程终止。 | 当 stdout=PIPE 或者 stderr=PIPE 并且子进程产生了足以阻塞 OS 管道缓冲区接收更多数据的输出到管道时,将会发生死锁。当使用管道时用 Popen.communicate() 来规避它 |
communicate(input,timeout) | 和子进程交互,发送和读取数据。 | 1. 可选的 input 参数应当未被传输给子进程的数据,如果没有数据应被传输给子进程则为 None。如果流以文本模式打开, input 必须为字符串。否则,它必须为字节。2. communicate() 返回一个 (stdout_data, stderr_data) 元组 |
kill() | 杀死子进程。发送 SIGKILL 信号到子进程。 | 如果超时到期,子进程不会被杀死,所以为了正确清理一个行为良好的应用程序应该杀死子进程并完成通讯 |
>>> import subprocess
>>> p = subprocess.Popen('ls -l', shell=True)
>>> total 164
-rw-r--r-- 1 root root 133 Jul 4 16:25 admin-openrc.sh
-rw-r--r-- 1 root root 268 Jul 10 15:55 admin-openrc-v3.sh
...
>>> p.returncode
>>> p.wait()
0
>>> p.returncode
---打印ping的返回值
# Import the module
import subprocess
# Ask the user for input
host = raw_input("Enter a host to ping: ")
# Set up the echo command and direct the output to a pipe
p1 = subprocess.Popen(['ping', '-c 2', host], stdout=subprocess.PIPE)
# Run the command
output = p1.communicate()[0]
print output
3.call
call系列的命令主要是针对返回码做相关处理,在run之上的扩展,call(执行命令,返回状态码)、check_call(执行命令,如果执行状态码是0,则返回0,否则抛出异常)、check_output(执行命令,如果状态码是0,则返回执行结果,否则抛出异常)