Python子进程 subprocess模块

青旅半醒 2024-04-18 23:00 0阅读 0赞

这里的内容以[Linux进程基础][Linux]和[Linux文本流][Linux 1]为基础。subprocess包主要功能是执行外部的命令和程序。比如说，我需要使用wget下载文件。我在Python中调用wget程序。从这个意义上来说，subprocess的功能与shell类似。

1. subprocess以及常用的封装函数

当我们运行python的时候，我们都是在创建并运行一个进程。正如我们在[Linux进程基础][Linux]中介绍的那样，一个进程可以fork一个子进程，并让这个子进程exec另外一个程序。在Python中，我们通过标准库中的subprocess包来fork一个子进程，并运行一个外部的程序(fork，exec见[Linux进程基础][Linux])。

subprocess包中定义有数个创建子进程的函数，这些函数分别以不同的方式创建子进程，所以我们可以根据需要来从中选取一个使用。另外subprocess还提供了一些管理[标准流(standard stream)和管道][Linux 1][(pipe)][Linux 1]的工具，从而在进程间使用文本通信。

使用subprocess包中的函数创建子进程的时候，要注意:

1) 在创建子进程之后，父进程是否暂停，并等待子进程运行。

2) 函数返回什么

3) 当returncode不为0时，父进程如何处理。

subprocess.call()  
父进程等待子进程完成  
返回退出信息(returncode，相当于exit code，见[Linux进程基础][Linux])

subprocess.check\_call()

父进程等待子进程完成

返回0

检查退出信息，如果returncode不为0，则举出错误subprocess.CalledProcessError，该对象包含有returncode属性，可用try...except...来检查(见[Python错误处理][Python])。

subprocess.check\_output()

父进程等待子进程完成

返回子进程向标准输出的输出结果

检查退出信息，如果returncode不为0，则举出错误subprocess.CalledProcessError，该对象包含有returncode属性和output属性，output属性为标准输出的输出结果，可用try...except...来检查。

这三个函数的使用方法相类似，我们以subprocess.call()来说明:

![复制代码][copycode.gif]

import subprocess
    rc = subprocess.call(["ls","-l"])

![复制代码][copycode.gif]

我们将程序名(ls)和所带的参数(-l)一起放在一个表中传递给subprocess.call()

可以通过一个shell来解释一整个字符串:

![复制代码][copycode.gif]

import subprocess
    out = subprocess.call("ls -l", shell=True)
    out = subprocess.call("cd ..", shell=True)

![复制代码][copycode.gif]

我们使用了shell=True这个参数。这个时候，我们使用一整个字符串，而不是一个表来运行子进程。Python将先运行一个shell，再用这个shell来解释这整个字符串。

shell命令中有一些是[shell的内建命令][shell]，这些命令必须通过shell运行，$cd。shell=True允许我们运行这样一些命令。

2. Popen

实际上，我们上面的三个函数都是基于Popen()的封装(wrapper)。这些封装的目的在于让我们容易使用子进程。当我们想要更个性化我们的需求的时候，就要转向Popen类，该类生成的对象用来代表子进程。

与上面的封装不同，Popen对象创建后，主程序不会自动等待子进程完成。我们必须调用对象的wait()方法，父进程才会等待 (也就是阻塞block)：

![复制代码][copycode.gif]

import subprocess
    child = subprocess.Popen(["ping","-c","5","www.google.com"])
    print("parent process")

![复制代码][copycode.gif]

从运行结果中看到，父进程在开启子进程之后并没有等待child的完成，而是直接运行print。

对比等待的情况:

![复制代码][copycode.gif]

import subprocess
    child = subprocess.Popen(["ping","-c","5","www.google.com"])
    child.wait()
    print("parent process")

![复制代码][copycode.gif]

此外，你还可以在父进程中对子进程进行其它操作，比如我们上面例子中的child对象:

child.poll() \# 检查子进程状态

child.kill() \# 终止子进程

child.send\_signal() \# 向子进程发送信号

child.terminate() \# 终止子进程

子进程的PID存储在child.pid

3. 子进程的文本流控制

(沿用child子进程) 子进程的标准输入，标准输出和标准错误也可以通过如下属性表示:

child.stdin

child.stdout

child.stderr

我们可以在Popen()建立子进程的时候改变标准输入、标准输出和标准错误，并可以利用subprocess.PIPE将多个子进程的输入和输出连接在一起，构成管道(pipe):

![复制代码][copycode.gif]

import subprocess
    child1 = subprocess.Popen(["ls","-l"], stdout=subprocess.PIPE)
    child2 = subprocess.Popen(["wc"], stdin=child1.stdout,stdout=subprocess.PIPE)
    out = child2.communicate()
    print(out)

![复制代码][copycode.gif]

subprocess.PIPE实际上为文本流提供一个缓存区。child1的stdout将文本输出到缓存区，随后child2的stdin从该PIPE中将文本读取走。child2的输出文本也被存放在PIPE中，直到communicate()方法从PIPE中读取出PIPE中的文本。

要注意的是，communicate()是Popen对象的一个方法，该方法会阻塞父进程，直到子进程完成。

我们还可以利用communicate()方法来使用PIPE给子进程输入:

![复制代码][copycode.gif]

import subprocess
    child = subprocess.Popen(["cat"], stdin=subprocess.PIPE)
    child.communicate("vamei")

![复制代码][copycode.gif]

我们启动子进程之后，cat会等待输入，直到我们用communicate()输入"vamei"。

通过使用subprocess包，我们可以运行外部程序。这极大的拓展了Python的功能。如果你已经了解了操作系统的某些应用，你可以从Python中直接调用该应用(而不是完全依赖Python)，并将应用的结果输出给Python，并让Python继续处理。shell的功能(比如利用文本流连接各个应用)，就可以在Python中实现。

总结:

subprocess.call, subprocess.check\_call(), subprocess.check\_output()

subprocess.Popen(), subprocess.PIPE

Popen.wait(), Popen.communicate()

## 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)

这堆东西真让人抓狂：

<table style="padding:0px; margin:0.5em 0px 0px 0.5em; border-collapse:collapse"> 
 <tbody style="padding:0px; margin:0px"> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> args </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 字符串或者列表 </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> bufsize </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 0 无缓冲 1 行缓冲 其他正值 缓冲区大小 负值 采用默认系统缓冲(一般是全缓冲) </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> executable </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 一般不用吧，args字符串或列表第一项表示程序名 </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> stdin stdout stderr </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> None 没有任何重定向，继承父进程 PIPE 创建管道 文件对象 文件描述符(整数) stderr 还可以设置为 STDOUT </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> preexec_fn </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 钩子函数， 在fork和exec之间执行。(unix) </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> close_fds </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> unix 下执行新进程前是否关闭0/1/2之外的文件 windows下不继承还是继承父进程的文件描述符 </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> shell </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 为真的话 unix下相当于args前面添加了&nbsp;"/bin/sh“&nbsp;”-c” window下，相当于添加"cmd.exe&nbsp;/c" </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> cwd </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 设置工作目录 </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> env </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 设置环境变量 </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> universal_newlines </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> 各种换行符统一处理成 '\n' </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> startupinfo </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> window下传递给CreateProcess的结构体 </td> 
 </tr> 
 <tr style="padding:0px; margin:0px"> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> creationflags </td> 
 <td style="padding:0.25em 0.5em; margin:0px; border:1px solid rgb(4,115,7)"> windows下，传递CREATE_NEW_CONSOLE创建自己的控制台窗口 </td> 
 </tr> 
 </tbody> 
</table>

*  当初最感到困扰的就是 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() 执行程序，并等待它完成

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

*  check\_call() 调用前面的call，如果返回值非零，则抛出异常

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()

## 参考 ##

*  [http://docs.python.org/library/subprocess.htcml][http_docs.python.org_library_subprocess.htcml]
 *  [http://www.python.org/dev/peps/pep-0324/][http_www.python.org_dev_peps_pep-0324]

[Linux]: http://www.cnblogs.com/vamei/archive/2012/09/20/2694466.html
[Linux 1]: http://www.cnblogs.com/vamei/archive/2012/09/14/2683756.html
[Python]: http://www.cnblogs.com/vamei/archive/2012/07/10/2582787.html
[copycode.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/15/60290f415d594762b700eda18076e36b.gif
[shell]: http://www.cnblogs.com/vamei/archive/2012/09/10/2676740.html
[http_docs.python.org_library_subprocess.htcml]: http://docs.python.org/library/subprocess.htcml
[http_www.python.org_dev_peps_pep-0324]: http://www.python.org/dev/peps/pep-0324/