Python-subprocess

1、subprocess 方法

1.1、check_output(cmd)

正确执行返回shell中执行cmd的输出

import subprocess
a = subprocess.check_output("pwd")
print(a)
a
#输出
/root/test

'/root/test\n'

1.2、run(file)

以字符串形式返回file的输出。（该函数已被 Python 丢弃，不建议使用）

import subprocess
print(subprocess.run("/root/test/test.py"))
#输出
-rw-r--r-- 1 root root 182 Dec 18 02:32 /root/test/test.py

1.3、getstatusoutput(cmd)

在shell中执行cmd的返回（状态、输出）。

import subprocess
status, values = subprocess.getstatusoutput("pwd")
print(status, values)
#输出
(0, '/root/test')

1.4、call(cmd)

执行由参数提供的命令，返回命令的结果和执行状态，0或非0

import subprocess
subprocess.call(["ls","-l"])
#输出
total 4
-rw-r--r-- 1 root root 284 Dec 18 19:35 test.py
0

1.5、check_call(cmd)

执行命令，返回结果和状态，正常为0 ，执行错误则抛出异常

import subprocess
subprocess.check_call(["ls","-l"])
#输出
total 4
-rw-r--r-- 1 root root 284 Dec 18 19:35 test.py
0

1.6、getoutput(cmd)

接受字符串形式的命令，查看执行结果

import subprocess
subprocess.check_call(["pwd"])
#输出
'/root/test'

2、subprocess.Popen()

subprocess模块定义了一个类：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)

2.1、args参数:

args参数。可以是一个字符串，可以是一个包含程序参数的列表。要执行的程序一般就是这个列表的第一项，或者是字符串本身。

subprocess.Popen(["cat","test.txt"])
#或
subprocess.Popen("cat test.txt", shell=True)
#或
subprocess.Popen(["/bin/sh", "-c", "cat test.txt"])

2.2、bufsize参数:

如果指定了bufsize参数作用就和内建函数open()一样：0表示不缓冲，1表示行缓冲，其他正数表示近似的缓冲区字节数，负数表示使用系统默认值。默认是0。

2.3、executable参数:

指定要执行的程序。如果shell=True ，executable 可以用于指定用哪个shell来执行（比如bash、csh、zsh等），Linux下，默认是 /bin/sh，windows下，就是环境变量 COMSPEC 的值。

2.4、stdin、stdout和stderr：

stdin：子程序的标准输入

stdout：子程序的标准输出

stderr：子程序的标准错误。

可选的值有PIPE或者一个有效的文件描述符（其实是个正整数）或者一个文件对象，还有None。如果是PIPE，则表示需要创建一个新的管道，如果是None，不会做任何重定向工作，子进程的文件描述符会继承父进程的。另外，stderr的值还可以是STDOUT，表示子进程的标准错误也输出到标准输出。

#标准输出
>>> res = subprocess.Popen("ls /root/test", shell=True, stdout=subprocess.PIPE)
>>> res.stdout.read()	#标准输入
'test.py\n'
>>> res.stdout.close()	#标准关闭

#标准错误
>>> res =subprocess.Popen("lm -l",shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
>>> res.stdout.read()
''
>>> res.stderr.read()
'/bin/sh: lm: command not found\n'

2.5、preexec_fn参数：

如果把preexec_fn设置为一个可调用的对象（比如函数），就会在子进程被执行前被调用。（仅限*nix）

2.6、close_fds参数：

如果把close_fds设置成True，*nix下会在开子进程前把除了0、1、2以外的文件描述符都先关闭。在 Windows下也不会继承其他文件描述符。

2.7、shell参数：

如果把shell设置成True，指定的命令会在shell里解释执行。

2.8、cwd参数：

如果cwd不是None，则会把cwd做为子程序的当前目录。注意，并不会把该目录做为可执行文件的搜索目录，所以不要把程序文件所在目录设置为cwd 。

2.9、env参数：

如果env不是None，则子程序的环境变量由env的值来设置，而不是默认那样继承父进程的环境变量。即使你只在env里定义了某一个环境变量的值，也会阻止子程序得到其他的父进程的环境变量

>>> import subprocess
>>> subprocess.Popen('env', env={'test':'123', 'testtext':'zzz'})
<subprocess.Popen object at 0x7f33889cb710>
>>> test=123
testtext=zzz

2.10、universal_newlines参数:

如果把universal_newlines 设置成True，则子进程的stdout和stderr被视为文本对象，并且不管是Linux的行结束符（'/n'），还是老mac格式的行结束符（'/r' ），还是windows 格式的行结束符（'/r/n' ）都将被视为 '/n' 。

2.11、startupinfo和creationflags参数：

如果指定了startupinfo和creationflags，将会被传递给后面的CreateProcess()函数，用于指定子程序的各种其他属性，比如主窗口样式或者是子进程的优先级等。（仅限Windows）

3、Popen对象

3.1、poll()

定时检查命令有没有执行完毕，执行完毕后返回执行结果的状态，没有执行完毕返回None

>>> res = subprocess.Popen("sleep 5;echo 'hello'",shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
>>> print(res.poll())
None
>>> print(res.poll())
None
>>> print(res.poll())
0

3.2、wait()

等待命令执行完成，并且返回结果状态

>>> res = subprocess.Popen("sleep 5;echo 'hello'",shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
>>> res.wait()
0

3.3、communicate()

如果子进程输出了大量数据到stdout或者stderr的管道，并达到了系统pipe的缓存大小的话，子进程会等待父进程读取管道，而父进程此时正wait着的话，将会产生传说中的死锁，后果是非常严重滴。建议使用communicate() 来避免这种情况的发生。

p.communicate(input=None)

3.4、terminate()

结束进程

>>> res = subprocess.Popen("sleep 5;echo 'hello'",shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
>>> res.terminate()
>>> res.stdout.read()
''

3.5、pid

获取当前执行子shell的程序的进程号

>>> res = subprocess.Popen("sleep 5;echo 'hello'",shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
>>> res.pid
6700

3.6、kill

杀死子进程

>>> res = subprocess.Popen("sleep 5;echo 'hello'",shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE)
>>> res.pid
>>> res.kill
<bound method Popen.kill of <subprocess.Popen object at 0x7f33889cb750>>