python模块之subprocess

我们经常需要通过Python去执行一条系统命令或脚本，系统的shell命令是独立于你的python进程之外的，每执行一条命令，就是发起一个新进程，通过python调用系统命令或脚本的模块在python2有os.system，

>>> os.system('uname -a')
Darwin Alexs-MacBook-Pro.local 15.6.0 Darwin Kernel Version 15.6.0: Sun Jun  4 21:43:07 PDT 2017; root:xnu-3248.70.3~1/RELEASE_X86_64 x86_64
0

这条命令的实现原理是什么呢？(视频中讲，解释进程间通信的问题...)

除了os.system可以调用系统命令，,commands,popen2等也可以，比较乱，于是官方推出了subprocess,目地是提供统一的模块来实现对系统命令或脚本的调用

The subprocess module allows you to spawn new processes, connect to their input/output/error pipes, and obtain their return codes. This module intends to replace several older modules and functions:

• os.system
• os.spawn*

The recommended approach to invoking subprocesses is to use the run() function for all use cases it can handle. For more advanced use cases, the underlying Popen interface can be used directly.

The run() function was added in Python 3.5; if you need to retain compatibility with older versions, see the Older high-level API section.

三种执行命令的方法

• subprocess.run(*popenargs, input=None, timeout=None, check=False, **kwargs) #官方推荐

• subprocess.call(*popenargs, timeout=None, **kwargs) #跟上面实现的内容差不多，另一种写法

• subprocess.Popen() #上面各种方法的底层封装

run()方法

Run command with arguments and return a CompletedProcess instance.The returned instance will have attributes args, returncode, stdout and stderr. By default, stdout and stderr are not captured, and those attributes will be None. Pass stdout=PIPE and/or stderr=PIPE in order to capture them.

If check is True and the exit code was non-zero, it raises a CalledProcessError. The CalledProcessError object will have the return code in the returncode attribute, and output & stderr attributes if those streams were captured.

If timeout is given, and the process takes too long, a TimeoutExpired exception will be raised.

The other arguments are the same as for the Popen constructor.

标准写法

subprocess.run(['df','-h'],stderr=subprocess.PIPE,stdout=subprocess.PIPE,check=True)

涉及到管道|的命令需要这样写

subprocess.run('df -h|grep disk1',shell=True) #shell=True的意思是这条命令直接交给系统去执行，不需要python负责解析

call()方法 一般用的不多，主要用run

#执行命令，返回命令执行状态 ， 0 or 非0
>>> retcode = subprocess.call(["ls", "-l"])

#执行命令，如果命令结果为0，就正常返回，否则抛异常
>>> subprocess.check_call(["ls", "-l"])
0

#接收字符串格式命令，返回元组形式，第1个元素是执行状态，第2个是命令结果 
>>> subprocess.getstatusoutput('ls /bin/ls')
(0, '/bin/ls')

#接收字符串格式命令，并返回结果
>>> subprocess.getoutput('ls /bin/ls')
'/bin/ls'

#执行命令，并返回结果，注意是返回结果，不是打印，下例结果返回给res
>>> res=subprocess.check_output(['ls','-l'])
>>> res
b'total 0
drwxr-xr-x 12 alex staff 408 Nov 2 11:05 OldBoyCRM
'

Popen()方法 重要，上面两个底层封装的都是Popen

常用参数：

• args：shell命令，可以是字符串或者序列类型（如：list，元组）
• stdin, stdout, stderr：分别表示程序的标准输入、输出、错误句柄
• preexec_fn：只在Unix平台下有效，用于指定一个可执行对象（callable object），它将在子进程运行之前被调用
• shell：同上
• cwd：用于设置子进程的当前目录
• env：用于指定子进程的环境变量。如果env = None，子进程的环境变量将从父进程中继承。

下面这2条语句执行会有什么区别？

a=subprocess.run('sleep 10',shell=True,stdout=subprocess.PIPE)
a=subprocess.Popen('sleep 10',shell=True,stdout=subprocess.PIPE)

区别是Popen会在发起命令后立刻返回，而不等命令执行结果。这样的好处是什么呢？

如果你调用的命令或脚本 需要执行10分钟，你的主程序不需卡在这里等10分钟，可以继续往下走，干别的事情，每过一会，通过一个什么方法来检测一下命令是否执行完成就好了。

Popen调用后会返回一个对象，可以通过这个对象拿到命令执行结果或状态等，该对象有以下方法

poll()

Check if child process has terminated. Returns returncode

wait()

Wait for child process to terminate. Returns returncode attribute.

terminate()终止所启动的进程Terminate the process with SIGTERM

kill() 杀死所启动的进程 Kill the process with SIGKILL

communicate()与启动的进程交互，发送数据到stdin,并从stdout接收输出，然后等待任务结束

>>> a = subprocess.Popen('python3 guess_age.py',stdout=subprocess.PIPE,stderr=subprocess.PIPE,stdin=subprocess.PIPE,shell=True)

>>> a.communicate(b'22')

(b'your guess:try bigger
', b'')

send_signal(signal.xxx)发送系统信号

pid 拿到所启动进程的进程号

 

代码示例：

import subprocess


# run方法

a = subprocess.run(['df', '-h'])  # 发起了一个新的进程，执行 df -h

print(a.stdout)  # None  拿不到结果

# 不同程序之间传输信息也是通过操作系统，比如从浏览器复制信息到qq,是先复制到操作系统，操作系统在复制给qq。因为为了安全，不同程序之间不允许通信。
# PIPE(管道） 就等于是操作系统，命令通过操作系统返回给python的标准库。如果命令执行错误，错误也通过管道返回给stderr=。如果不加check=True,程序出错了也不会报错，只能从
# stderr里面看
a = subprocess.run(['df', '-h'], stderr=subprocess.PIPE, stdout=subprocess.PIPE, check=True)

print(a.stdout)  # 拿到结果

print(a.returncode)  # 0  0代表命令执行成功
print(a.check_returncode())

#  如果用到管道命令，直接写成一个字符串就行，不用列表，还要加上shell=True,告诉run方法你不要解析了，因为有管道你也处理不了，把整个命令交给shell就行。
b = subprocess.run('df -h |grep disk1s1', stdout=subprocess.PIPE, stderr=subprocess.PIPE, check=True, shell=True)
print(b.stdout)  # b'/dev/disk1s1   932Gi  332Gi  597Gi    36% 1597251 9223372036853178556    0%   /
'

# call方法  一般用的不多，主要用run

subprocess.call(['df', '-h'])

# Popen()方法 重要 上面两个底层封装的都是Popen

a = subprocess.run('sleep 10', shell=True, stdout=subprocess.PIPE)   # 等10秒，执行

# Popen会发起一个新进程，不会让主程序停下，相当于是两个程序同时运行,通过poll()来拿结果。
a = subprocess.Popen('sleep 10', shell=True, stdout=subprocess.PIPE)


def sayhi():
    print('run....hello')


#

# preexec_fn
a = subprocess.Popen('sleep 10', shell=True, stdout=subprocess.PIPE, preexec_fn=sayhi)  # 执行这个命令之前，先执行函数
print(a.stdout.read())  # b'run....hello
'

# cwd
a = subprocess.Popen('echo $PWD;sleep 2', shell=True, cwd='/tmp', stdout=subprocess.PIPE, preexec_fn=sayhi)
print(a.stdout.read()) # b'run....hello
/private/tmp
'


# kill
a = subprocess.Popen('sleep 100', shell=True, stdout=subprocess.PIPE)
a.terminate()
a.kill()  #  强制杀死