Python模块subprocess小记

在熟悉了Qt的QProcess以后，再回头来看python的subprocess总算不觉得像以前那么恐怖了。

和QProcess一样，subprocess的目标是启动一个新的进程并与之进行通讯。

subprocess.Popen

这个模块主要就提供一个类Popen：

class subprocess.Popen( args, 
      bufsize=0, 
      executable=None,
      stdin=None,
      stdout=None, 
      stderr=None, 
      preexec_fn=None, 
      close_fds=False, 
      shell=False, 
      cwd=None, 
      env=None, 
      universal_newlines=False, 
      startupinfo=None, 
      creationflags=0)

这堆东西真让人抓狂：

args	字符串或者列表
bufsize	0 无缓冲 1 行缓冲 其他正值 缓冲区大小 负值 采用默认系统缓冲(一般是全缓冲)
executable	一般不用吧，args字符串或列表第一项表示程序名。 参数executable用于指定可执行程序。一般情况下我们通过args参数来设置所要运行的程序。如果将参数shell设为 True，executable将指定程序使用的shell。在windows平台下，默认的shell由COMSPEC环境变量来指定。
stdin stdout stderr	None 没有任何重定向，继承父进程 PIPE 创建管道 文件对象 文件描述符(整数) stderr 还可以设置为 STDOUT 参数stdin, stdout, stderr分别表示程序的标准输入、输出、错误句柄。他们可以是PIPE，文件描述符或文件对象，也可以设置为None，表示从父进程继承：
preexec_fn	钩子函数， 在fork和exec之间执行。(unix) 只在Unix平台下有效，用于指定一个可执行对象（callable object），它将在子进程运行之前被调用。
close_fds	unix 下执行新进程前是否关闭0/1/2之外的文件 windows下不继承还是继承父进程的文件描述符 在windows平台下，如果close_fds被设置为True，则新创建的子进程将不会继承父进程的输入、输出、错误管 道。我们不能将close_fds设置为True同时重定向子进程的标准输入、输出与错误(stdin, stdout, stderr)。
shell	为真的话 unix下相当于args前面添加了 "/bin/sh“ ”-c” window下，相当于添加"cmd.exe /c"
cwd	设置工作目录
env	设置环境变量 参数env是字典类型，用于指定子进程的环境变量。如果env = None，子进程的环境变量将从父进程中继承。
universal_newlines	各种换行符统一处理成 '\n' 不同操作系统下，文本的换行符是不一样的。如：windows下用’/r/n’表示换，而Linux下用 ‘/n’。 如果将此参数设置为True，Python统一把这些换行符当作’/n’来处理。
startupinfo	window下传递给CreateProcess的结构体
creationflags	windows下，传递CREATE_NEW_CONSOLE创建自己的控制台窗口

• 当初最感到困扰的就是 args 参数。可以是一个字符串，可以是一个列表。

subprocess.Popen(["gedit","abc.txt"])
subprocess.Popen("gedit abc.txt")

这两个之中，后者将不会工作。因为如果是一个字符串的话，必须是程序的路径才可以。(考虑unix的api函数 exec，接受的是字符串列表)

• 但是下面的可以工作

subprocess.Popen("gedit abc.txt", shell=True)

这是因为它相当于

subprocess.Popen(["/bin/sh", "-c", "gedit abc.txt"])

都成了sh的参数，就无所谓了

• 在Windows下，下面的却又是可以工作的

subprocess.Popen(["notepad.exe", "abc.txt"])
subprocess.Popen("notepad.exe abc.txt")

这是由于windows下的api函数CreateProcess接受的是一个字符串。即使是列表形式的参数，也需要先合并成字符串再传递给api函数。

• 类似上面

subprocess.Popen("notepad.exe abc.txt" shell=True)

等价于

subprocess.Popen("cmd.exe /C "+"notepad.exe abc.txt" shell=True)

subprocess.call*

模块还提供了几个便利函数（这本身也算是很好的Popen的使用例子了）

• call() 执行程序，并等待它完成。          该函数将一直等待到子进程运行结束，并返回进程的returncode。文章一开始的例子就演示了call函数。如果子进程不需要进行交 互,就可以使用该函数来创建。

def call(*popenargs, **kwargs):
    return Popen(*popenargs, **kwargs).wait()

• check_call() 调用前面的call，如果返回值非零，则抛出异常。    如果子进程返回的returncode不为0的话，将触发CalledProcessError异常。在异常对象中，包 括进程的returncode信息。

def check_call(*popenargs, **kwargs):
    retcode = call(*popenargs, **kwargs)
    if retcode:
        cmd = kwargs.get("args")
        raise CalledProcessError(retcode, cmd)
    return 0

• check_output() 执行程序，并返回其标准输出

def check_output(*popenargs, **kwargs):
    process = Popen(*popenargs, stdout=PIPE, **kwargs)
    output, unused_err = process.communicate()
    retcode = process.poll()
    if retcode:
        cmd = kwargs.get("args")
        raise CalledProcessError(retcode, cmd, output=output)
    return output

Popen对象

该对象提供有不少方法函数可用。而且前面已经用到了wait()/poll()/communicate()

poll()	检查是否结束，设置返回值 检查子进程是否已经结束。设置并返回returncode属性。
wait()	等待结束，设置返回值 等待子进程结束。设置并返回returncode属性。
communicate()	参数是标准输入，返回标准输出和标准出错 与子进程进行交互。向stdin发送数据，或从stdout和stderr中读取数据。可选参数input指定发送到子进程的参数。 Communicate()返回一个元组：(stdoutdata, stderrdata)。注意：如果希望通过进程的stdin向其发送数据，在创建Popen对象的时候，参数stdin必须被设置为PIPE。同样，如 果希望从stdout和stderr获取数据，必须将stdout和stderr设置为PIPE。
send_signal()	发送信号 (主要在unix下有用)
terminate()	终止进程，unix对应的SIGTERM信号，windows下调用api函数TerminateProcess()
kill()	杀死进程(unix对应SIGKILL信号)，windows下同上
stdin stdout stderr	参数中指定PIPE时，有用。 如果在创建Popen对象是，参数 [stdin/stdout/stderr] 被设置为PIPE，Popen. [stdin/ stdout/ stderr] 将返回一个文件对象用于策子进程发送指令。否则返回None。
pid	子进程的进程ID。
returncode	进程返回值 ,  如果进程还没有结束，返回None。

参考

• http://docs.python.org/library/subprocess.htcml

• http://www.python.org/dev/peps/pep-0324/

实例1：

下面是一个非常简单的例子，来演示supprocess模块如何与一个控件台应用程序进行交 互。

app2.exe也是一个非常简单的控制台程序，它从界面上接收两个数值，执行加操作，并将结 果打印到控制台上。代码如下：

---------------------------C++:------------------------------------

#include <iostream>  
using namespace std;  
int main(int argc, const char *artv[])  
{  
     int x, y;  
     cout << “input x: ” << endl;  
     cin >> x;  
     cout << “input y: ” << endl;  
     cin >> y;  
     cout << x << ” + ” << y << ” = ” << x + y << endl;  

     return 0;  
}

---------------------------python:------------------------------------
import subprocess  

p = subprocess.Popen(“app2.exe”, \
  stdin = subprocess.PIPE, \
  stdout = subprocess.PIPE, \
  stderr = subprocess.PIPE, \
  shell = False)  

p.stdin.write(’3\n’)  
p.stdin.write(’4\n’)  
print p.stdout.read()  

#—- 结果 —-  
input x:   
input y:   
3 + 4 = 7 

实例2：

def RunCmd(curCmd,wait = 1):
    pipe = subprocess.Popen(curCmd,shell = True,stdin = subprocess.PIPE,stdout = subprocess.PIPE,\
                            stderr = subprocess.PIPE)
    if(wait == 1):
        pipe.wait()
        #pipe.stdin.write('%s\n'%curCmd)
        #pipe.stdin.close()
   
        stdoutStr = pipe.stdout.readlines()
        #stderrStr = pipe.stderr.read()
        if(DebugMode == 1):
            print stdoutStr
        return stdoutStr