我们几乎可以在任何操作系统上通过命令行指令与操作系统进行交互,比如Linux平台下的shell。那么我们如何通过Python来完成这些命令行指令的执行呢?另外,我们应该知道的是命令行指令的执行通常有两个我们比较关注的结果:
早期的 Python 版本中,我们主要是通过 os.system()、os.popen().read() 等函数来执行命令行指令的,另外还有一个很少使用的 commands 模块。但是从 Python 2.4 开始官方文档中建议使用的是 subprocess 模块,所以 os 模块和 commands 模块的相关函数在这里只提供一个简单的使用示例,我们重要要介绍的是 subprocess 模块。
Python 中提供了以下几个函数来帮助我们完成命令行指令的执行:
函数名 | 描述 |
---|---|
os.system(command) | 返回命令执行状态码,而将命令执行结果输出到屏幕 |
os.popen(command).read() | 可以获取命令执行结果,但是无法获取命令执行状态码 |
commands.getstatusoutput(command) | 返回一个元组(命令执行状态码, 命令执行结果) |
说明:
subprocess 是 Python 2.4 中新增的一个模块,它允许你生成新的进程,连接到它们的 input/output/error 管道,并获取它们的返回(状态)码。这个模块的目的在于替换几个旧的模块和方法,如:
- os.system
- os.spawn*
函数 | 描述 |
---|---|
subprocess.run() | Python 3.5中新增的函数。执行指定的命令,等待命令执行完成后返回一个包含执行结果的CompletedProcess类的实例。 |
subprocess.call() | 执行指定的命令,返回命令执行状态,其功能类似于os.system(cmd)。 |
subprocess.check_call() | Python 2.5中新增的函数。 执行指定的命令,如果执行成功则返回状态码,否则抛出异常。其功能等价于subprocess.run(..., check=True)。 |
subprocess.check_output() | Python 2.7中新增的的函数。执行指定的命令,如果执行状态码为0则返回命令执行结果,否则抛出异常。 |
subprocess.getoutput(cmd) | 接收字符串格式的命令,执行命令并返回执行结果,其功能类似于os.popen(cmd).read()和commands.getoutput(cmd)。 |
subprocess.getstatusoutput(cmd) | 执行cmd命令,返回一个元组(命令执行状态, 命令执行结果输出),其功能类似于commands.getstatusoutput()。 |
- subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, shell=False, timeout=None, check=False, universal_newlines=False)
- subprocess.call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None)
- subprocess.check_call(args, *, stdin=None, stdout=None, stderr=None, shell=False, timeout=None)
- subprocess.check_output(args, *, stdin=None, stderr=None, shell=False, universal_newlines=False, timeout=None)
- subprocess.getstatusoutput(cmd)
- subprocess.getoutput(cmd)
-
需要说明的是,subprocess.run() 函数是 Python3.5 中新增的一个高级函数,其返回值是一个 subprocess.CompletedPorcess 类的实例,因此,subprocess.completedPorcess 类也是 Python 3.5 中才存在的。它表示的是一个已结束进程的状态信息,它所包含的属性如下:
subprocess.run()
- >> subprocess.run(["ls", "-l"]) # doesn't capture output
- CompletedProcess(args=['ls', '-l'], returncode=0)
-
- >> subprocess.run("exit 1", shell=True, check=True)
- Traceback (most recent call last):
- ...
- subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1
-
- >> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
- CompletedProcess(args=['ls', '-l', '/dev/null'], returncode=0,
- stdout=b'crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n')
-
subprocess.call()
- >> subprocess.call(['ls', '-l'])
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
- 0
- >> subprocess.call('ls -l', shell=True)
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
- 0
- >> subprocess.call(['ls', '-l'], stdout=subprocess.DEVNULL)
- 0
- >> subprocess.call(['ls', '-l', '/test'])
- ls: 无法访问/test: 没有那个文件或目录
- 2
-
suprocess.check_call()
- >> subprocess.check_call(['ls', '-l'])
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
- 0
- >> subprocess.check_call('ls -l', shell=True)
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
- 0
- >> subprocess.check_call('ls -l /test', shell=True)
- ls: 无法访问/test: 没有那个文件或目录
- Traceback (most recent call last):
- File "<stdin>", line 1, in <module>
- File "/usr/lib/python3.4/subprocess.py", line 557, in check_call
- raise CalledProcessError(retcode, cmd)
- subprocess.CalledProcessError: Command 'ls -l /test' returned non-zero exit status 2
-
sbuprocess.check_output()
- >> ret = subprocess.check_output(['ls', '-l'])
- >> print(ret)
- b' \xe5\x85\xac\xe5\x85\xb1\xe7\x9a\x84\ndrwxr-xr-x 2 wader wader 4096 12\xe6\x9c\x88 7 2015 \xe6\xa8\xa1\xe6\x9d\xbf\ndrwxr-xr-x 2 wader wader 4096 12\xe6\x9c\x88 7 2015 \xe8\xa7\x86\xe9\xa2\x91\ndrwxr-xr-x 2 wader wader 4096 12\xe6\x9c\x88 7 2015 \xe5\x9b\xbe\xe7\x89\x87\ndrwxr-xr-x 2 wader wader 4096 12\xe6\x9c\x88 7 2015 \xe6\x96\x87\xe6\xa1\xa3\ndrwxr-xr-x 2 wader wader 4096 4\xe6\x9c\x88 13 2016 \xe4\xb8\x8b\xe8\xbd\xbd\ndrwxr-xr-x 2 wader wader 4096 12\xe6\x9c\x88 7 2015 \xe9\x9f\xb3\xe4\xb9\x90\ndrwxr-xr-x 7 wader wader 4096 5\xe6\x9c\x88 26 2016 \xe6\xa1\x8c\xe9\x9d\xa2\n'
- >> ret = subprocess.check_output(['ls', '-l'], universal_newlines=True)
- >> print(ret)
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
-
subprocess.getoutput() 与 subprocess.getstatusoutput()
- >> ret = subprocess.getoutput('ls -l')
- >> print(ret)
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
- >> retcode, output = subprocess.getstatusoutput('ls -l')
- >> print(retcode)
- 0
- >> print(output)
- 总用量 160
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 公共的
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 模板
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 视频
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 图片
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 文档
- drwxr-xr-x 2 wader wader 4096 4月 13 2016 下载
- drwxr-xr-x 2 wader wader 4096 12月 7 2015 音乐
- drwxr-xr-x 7 wader wader 4096 5月 26 2016 桌面
- >> retcode, output = subprocess.getstatusoutput('ls -l /test')
- >> print(retcode)
- 2
- >> print(output)
- ls: 无法访问/test: 没有那个文件或目录
-
该类用于在一个新的进程中执行一个子程序。前面我们提到过,上面介绍的这些函数都是基于subprocess.Popen类实现的,通过使用这些被封装后的高级函数可以很方面的完成一些常见的需求。由于 subprocess 模块底层的进程创建和管理是由Popen类来处理的,因此,当我们无法通过上面哪些高级函数来实现一些不太常见的功能时就可以通过subprocess.Popen类提供的灵活的api来完成。
- class subprocess.Popen(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=False,
- startup_info=None, creationflags=0, restore_signals=True, start_new_session=False, pass_fds=())
-
参数说明:
方法 | 描述 |
---|---|
Popen.poll() | 用于检查子进程(命令)是否已经执行结束,没结束返回None,结束后返回状态码。 |
Popen.wait(timeout=None) | 等待子进程结束,并返回状态码;如果在timeout指定的秒数之后进程还没有结束,将会抛出一个TimeoutExpired异常。 |
Popen.communicate(input=None, timeout=None) | 该方法可用来与进程进行交互,比如发送数据到stdin,从stdout和stderr读取数据,直到到达文件末尾。 |
Popen.send_signal(signal) | 发送指定的信号给这个子进程。 |
Popen.terminate() | 停止该子进程。 |
Popen.kill() | 杀死该子进程。 |
该方法中的可选参数 input 应该是将被发送给子进程的数据,或者如没有数据发送给子进程,该参数应该是None。input参数的数据类型必须是字节串,如果universal_newlines参数值为True,则input参数的数据类型必须是字符串。
该方法返回一个元组(stdout_data, stderr_data),这些数据将会是字节穿或字符串(如果universal_newlines的值为True)。
如果在 timeout 指定的秒数后该进程还没有结束,将会抛出一个TimeoutExpired异常。捕获这个异常,然后重新尝试通信不会丢失任何输出的数据。但是超时之后子进程并没有被杀死,为了合理的清除相应的内容,一个好的应用应该手动杀死这个子进程来结束通信。
需要注意的是,这里读取的数据是缓冲在内存中的,所以,如果数据大小非常大或者是无限的,就不应该使用这个方法。
实例 1:
- >>> import subprocess
- >>>
- >>> p = subprocess.Popen('df -Th', stdout=subprocess.PIPE, shell=True)
- >>> print(p.stdout.read())
- Filesystem Type Size Used Avail Use% Mounted on
- /dev/vda1 ext4 40G 12G 26G 31% /
- devtmpfs devtmpfs 3.9G 0 3.9G 0% /dev
- tmpfs tmpfs 3.9G 0 3.9G 0% /dev/shm
- tmpfs tmpfs 3.9G 386M 3.5G 10% /run
- tmpfs tmpfs 3.9G 0 3.9G 0% /sys/fs/cgroup
- tmpfs tmpfs 783M 0 783M 0% /run/user/0
- tmpfs tmpfs 783M 0 783M 0% /run/user/1000
-
实例2:
- >>> obj = subprocess.Popen(["python"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
- >>> obj.stdin.write('print(1) \n')
- >>> obj.stdin.write('print(2) \n')
- >>> obj.stdin.write('print(3) \n')
- >>> out,err = obj.communicate()
- >>> print(out)
- 1
- 2
- 3
-
- >>> print(err)
-
实例3:
- >>> obj = subprocess.Popen(["python"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
- >>> out,err = obj.communicate(input='print(1) \n')
- >>> print(out)
- 1
-
- >>> print(err)
-
实例4
实现类似 df -Th | grep data 命令的功能,实际上就是实现 shell 中管道的共功能。
- >>>
- >>> p1 = subprocess.Popen(['df', '-Th'], stdout=subprocess.PIPE)
- >>> p2 = subprocess.Popen(['grep', 'data'], stdin=p1.stdout, stdout=subprocess.PIPE)
- >>> out,err = p2.communicate()
- >>> print(out)
- /dev/vdb1 ext4 493G 4.8G 463G 2% /data
- /dev/vdd1 ext4 1008G 420G 537G 44% /data1
- /dev/vde1 ext4 985G 503G 432G 54% /data2
-
- >>> print(err)
- None
-
那么我们到底该用哪个模块、哪个函数来执行命令与系统及系统进行交互呢?
下面我们来做个总结: