python执行shell命令行

概述

python中一般推荐的执行shell命令行的方式有两种，os.popen与subprocess.Popen。本文(python 3.7环境)说明下两者的使用，关联与差异。

os.popen

os.popen的函数签名比较简单：

def popen(cmd, mode="r", buffering=-1):

其中 cmd 必须为 string 类型，mode只能为 r 或者 w，buffering参数与内建函数 open 一致，就不叙述了。

其返回值为 stdin 或者 stdout的wrapper，wrapper中实现了迭代特性，因此可以使用像普通文件对象一样遍历内容。

import os

dirs = os.popen('dir')

[dir for dir in dirs]

从参数上看，popen只支持单工通信(read mode 或 write mode)。

从内部实现上来说，os.popen内部调用了 subprocess.Popen函数，调用如下：

if mode == "r":

    proc = subprocess.Popen(cmd, shell=True, stdout=subprocess.PIPE, bufsize=buffering)

    return _wrap_close(io.TextIOWrapper(proc.stdout), proc)

else:

    proc = subprocess.Popen(cmd, shell=True, stdin=subprocess.PIPE, bufsize=buffering)

    return _wrap_close(io.TextIOWrapper(proc.stdin), proc)

关于 subprocess.Popen 中的 shell 参数与 stdin/stdout参数我们会在后面分析。

subprocess.Popen

Popen是一个类，并不是一个函数。内部实现比较复杂，隔离了操作系统的差异。

def __init__(self, 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=None, startupinfo=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None, text=None):

其构造函数相当复杂，我们逐步进行解析。

这些参数中，部分分属不同的操作系统，Popen会做简单检查后再进行下一步处理。

posix：preexec_fn

windows：startupinfo，createionflag

这些参数如果熟悉windows与Liunx创建进程的API，应该不会有什么疑问，具体可以查看 MSDN 与 man 手册。

args就是我们的命令行参数了，args可以是一个string，也可以是一个list。如果是一个srting的话，Popen内部会将其转换成 list。

bufsize 与 os.popen的 buffering参数含义相同

executable 参数指的是需要运行的可执行文件，如果 这个参数不等于None，那么 args就作为参数传递给executable所指向的可执行文件。executable会受到shell参数的影响，后续我们会分析到。

stdin/stdout/strerr 主要用于输入输出的重定向功能。实参可以是 PIPE/DEVNULL/文件描述符/文件对象/None。

熟悉linux编程的朋友应该都知道PIPE与devnull。如果输入PIPE，那么Popen会在父进程与子进程之间创建输入输出的pipe用于相互通信。

如果实参是已经打开的 文件描述符或文件对象时，那么输入输出就会重定向到相应的文件中。

如果实参等于 None，那么直接使用 标准输入输出接口。

注意 bufsize 参数是针对 stdin/stdout/stderr 的缓冲设置。

preexec_fn 参数只有在 posix环境中才有用。在 child_exec 执行到 exec* 函数前会执行 result = PyObject_Call(preexec_fn, preexec_fn_args_tuple, NULL); 作用显而易见，在child exec之前设置一个回调函数，在这个特殊的时机做一些特殊的操作。

close_fds 这个参数感觉在posix环境中更有意义一些，如果设置为True，相当于为0，1，2以外的文件设置了 CLOSEXEC 标志。在windows中则将默认的文件继承属性设置为FALSE。

pass_fds 用于在父子进程间传递文件句柄。在posix中，如果pass_fds不为None，那么close_fds必须为True。也就是说pass_fds中的句柄会被关掉。

查看源码的时候发现比较奇怪的地方，在posix中，pass_fds 设置完继承属性后，如果close_fds为True，那么所有的句柄都会被关掉，那么pass_fds还能正常继承到子进程中吗？这里需要测试一下。

cwd是个人所共知的参数，不细说。只是要注意 cwd 会影响py脚本的查找与执行。

restore_signals参数也是在posix中作用比较大，因为windows中信号功能实在太弱。具体功能就是将 SIGPIPE/SIGXFZ/SIGXFSZ 由SIG_IGN设置成 SIG_DFL。具体可以参考任意的linux参考书。

start_new_session 应该只能在posix中使用，如果设置为True，那么子进程在执行过程中会调用 setsid，开启一个新的会话。

env简单，忽略不讲。

encoding/errors/universal_newline/text都是与 stdin/stdout/stderr相关的参数。

结语

os.popen的参数简单，使用方便；subprocess.Popen参数复杂，能实现精细控制。并且os.popen只能用于单工环境，即重定向stdin或者stdout文件，但是subprocess.Popen可以实现 0/1/2 三个描述符同时重定向。