subprocess 是一個(gè)可以創(chuàng)建進(jìn)程和管理進(jìn)程的python模塊，使用它我們就能在python種1實(shí)現(xiàn)執(zhí)行外部命令的效果。今天小編帶來subprocess的詳細(xì)介紹，對(duì)此感興趣的小伙伴歡迎來跟小編交流。
一、Python執(zhí)行外部命令
1、subprocess模塊簡介
subprocess 模塊允許我們啟動(dòng)一個(gè)新進(jìn)程，并連接到它們的輸入/輸出/錯(cuò)誤管道，從而獲取返回值。
這個(gè)模塊用來創(chuàng)建和管理子進(jìn)程。它提供了高層次的接口，用來替換os.system*()、 os.spawn*()、 os.popen*()、os,popen2.*()和commands.*等模塊和函數(shù)。
subprocess提供了一個(gè)名為Popen的類啟動(dòng)和設(shè)置子進(jìn)程的參數(shù)，由于這個(gè)類比較復(fù)雜, subprocess還提供了若干便利的函數(shù)，這些函數(shù)都是對(duì)Popen類的封裝。
2、subprocess模塊的遍歷函數(shù)
linux安裝ipython
pip3 install ipython
（1）call函數(shù)
call函數(shù)的定義如下:
subprocess.ca11(args, *, stdin=None, stdout=None, stderr=None, she11=False)
#運(yùn)行由args參數(shù)提供的命令，等待命令執(zhí)行結(jié)束并返回返回碼。args參數(shù)由字符串形式提供且有多個(gè)命令參數(shù)時(shí)，需要提供shell=True參數(shù)
- args：表示要執(zhí)行的命令。必須是一個(gè)字符串，字符串參數(shù)列表。
- stdin、stdout 和 stderr：子進(jìn)程的標(biāo)準(zhǔn)輸入、輸出和錯(cuò)誤。其值可以是 subprocess.PIPE、subprocess.DEVNULL、一個(gè)已經(jīng)存在的文件描述符、已經(jīng)打開的文件對(duì)象或者 None。subprocess.PIPE 表示為子進(jìn)程創(chuàng)建新的管道。subprocess.DEVNULL 表示使用 os.devnull。默認(rèn)使用的是 None，表示什么都不做。另外，stderr 可以合并到 stdout 里一起輸出。
- shell：如果該參數(shù)為 True，將通過操作系統(tǒng)的 shell 執(zhí)行指定的命令。
示例代碼:
[root@python ~]# ipython #啟動(dòng)ipython
Python 3.8.1 (default, Mar 9 2020, 12:35:12)
Type 'copyright', 'credits' or 'license' for more information
IPython 7.13.0 -- An enhanced Interactive Python. Type '?' for help.
In [1]: import subprocess #調(diào)用函數(shù)
In [2]: subprocess.call(['ls','-l'])
drwxr-xr-x. 2 root root 6 10月 31 23:04 公共
drwxr-xr-x. 2 root root 6 10月 31 23:04 模板
drwxr-xr-x. 2 root root 6 10月 31 23:04 視頻
drwxr-xr-x. 2 root root 4096 10月 31 22:40 圖片
drwxr-xr-x. 2 root root 6 10月 31 23:04 文檔
drwxr-xr-x. 2 root root 6 10月 31 23:04 下載
drwxr-xr-x. 2 root root 6 10月 31 23:04 音樂
drwxr-xr-x. 2 root root 6 10月 31 15:27 桌面
Out[2]: 0
In [3]: subprocess.call('exit 1',shell=True)
Out[3]: 1
（2）check_call函數(shù)
check_call函數(shù)的作用與call函數(shù)類似，區(qū)別在于異常情況下返回的形式不同。
對(duì)于call函數(shù)，工程師通過捕獲call命令的返回值判斷命令是否執(zhí)行成功，如果成功則返回0，否則的話返回非0，對(duì)于check_call函數(shù)，如果執(zhí)行成功，返回0，如果執(zhí)行失敗，拋出subrocess.CalledProcessError異常。如下所示：
In [5]: subprocess.check_call(['ls','-l'])
drwxr-xr-x. 2 root root 6 10月 31 23:04 公共
drwxr-xr-x. 2 root root 6 10月 31 23:04 模板
drwxr-xr-x. 2 root root 6 10月 31 23:04 視頻
drwxr-xr-x. 2 root root 4096 10月 31 22:40 圖片
drwxr-xr-x. 2 root root 6 10月 31 23:04 文檔
drwxr-xr-x. 2 root root 6 10月 31 23:04 下載
drwxr-xr-x. 2 root root 6 10月 31 23:04 音樂
drwxr-xr-x. 2 root root 6 10月 31 15:27 桌面
Out[5]: 0
In [6]: subprocess.check_call('exit 1',shell=True)
-------------------------------------------------------------
CalledProcessError Traceback (most recent call last)
<ipython-input-6-5e148d3ce640> in <module>
----> 1 subprocess.check_call('exit 1',shell=True)
/usr/local/python381/lib/python3.8/subprocess.py in check_call(*popenargs, **kwargs)
362 if cmd is None:
363 cmd = popenargs[0]
--> 364 raise CalledProcessError(retcode, cmd)
365 return 0
366
CalledProcessError: Command 'exit 1' returned non-zero exit status 1.
（3）check_output
Python3中的subprocess.check_output函數(shù)可以執(zhí)行一條sh命令，并返回命令的輸出內(nèi)容，用法如下：
In [10]: output = subprocess.check_output(['df','-h'])
In [11]: print(output.decode())
文件系統(tǒng) 容量 已用 可用 已用% 掛載點(diǎn)
/dev/mapper/cl-root 17G 5.2G 12G 31% /
devtmpfs 473M 0 473M 0% /dev
tmpfs 489M 92K 489M 1% /dev/shm
tmpfs 489M 7.1M 482M 2% /run
tmpfs 489M 0 489M 0% /sys/fs/cgroup
/dev/sda1 1014M 173M 842M 18% /boot
tmpfs 98M 16K 98M 1% /run/user/42
tmpfs 98M 0 98M 0% /run/user/0
In [12]: lines = output.decode().split('
')
In [13]: lines
Out[13]:
['文件系統(tǒng) 容量 已用 可用 已用% 掛載點(diǎn)',
'/dev/mapper/cl-root 17G 5.2G 12G 31% /',
'devtmpfs 473M 0 473M 0% /dev',
'tmpfs 489M 92K 489M 1% /dev/shm',
'tmpfs 489M 7.1M 482M 2% /run',
'tmpfs 489M 0 489M 0% /sys/fs/cgroup',
'/dev/sda1 1014M 173M 842M 18% /boot',
'tmpfs 98M 16K 98M 1% /run/user/42',
'tmpfs 98M 0 98M 0% /run/user/0',
'']
In [14]: for line in lines[1:-1]:
...: if line:
...: print(line.split()[-2])
...: #截取掛載點(diǎn)數(shù)據(jù)
31%
0%
1%
2%
0%
18%
1%
0%
在子進(jìn)程執(zhí)行命令，以字符串形式返回執(zhí)行結(jié)果的輸出。如果子進(jìn)程退出碼不是0，拋出subprocess.CalledProcessError異常，異常的output字段包含錯(cuò)誤輸出：
In [19]: try:
...: output = subprocess.check_output(['df','-h']).decode() #正確的
...: except subprocess.CalledProcessError as e:
...: output = e.output
...: code = e.returncode
//正確的沒有任何輸出In [23]: try:
...: output = subprocess.check_output(['wsd','-h'], stderr=subprocess.STDOUT)
...: .decode() #錯(cuò)誤的
...: except subprocess.CalledProcessError as e:
...: output = e.output
...: code = e.returncode
...://前面的錯(cuò)誤代碼省略
FileNotFoundError: [Errno 2] No such file or directory: 'wsd'
3、subprocess模塊的Popen類（PyCharm）
實(shí)際上，我們上面的三個(gè)函數(shù)都是基于Popen()的封裝(wrapper)。這些封裝的目的在于讓我們?nèi)菀资褂米舆M(jìn)程。當(dāng)我們想要更個(gè)性化我們的需求的時(shí)候，就要轉(zhuǎn)向Popen類，該類生成的對(duì)象用來代表子進(jìn)程。
- subprocess模塊中基本的進(jìn)程創(chuàng)建和管理由Popen類來處理
- subprocess.popen是用來替代os.popen的
- Popen 是 subprocess的核心，子進(jìn)程的創(chuàng)建和管理都靠它處理。
構(gòu)造函數(shù)：
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, startupinfo=None, creationflags=0,restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None)
（1）常用參數(shù)：
args：shell命令，可以是字符串或者序列類型（如：list，元組）
bufsize：緩沖區(qū)大小。當(dāng)創(chuàng)建標(biāo)準(zhǔn)流的管道對(duì)象時(shí)使用，默認(rèn)-1。
- 0：不使用緩沖區(qū)
- 1：表示行緩沖，僅當(dāng)universal_newlines=True時(shí)可用，也就是文本模式
- 正數(shù)：表示緩沖區(qū)大小
- 負(fù)數(shù)：表示使用系統(tǒng)默認(rèn)的緩沖區(qū)大小。
stdin, stdout, stderr：分別表示程序的標(biāo)準(zhǔn)輸入、輸出、錯(cuò)誤句柄
preexec_fn：只在 Unix 平臺(tái)下有效，用于指定一個(gè)可執(zhí)行對(duì)象（callable object），它將在子進(jìn)程運(yùn)行之前被調(diào)用
shell：如果該參數(shù)為 True，將通過操作系統(tǒng)的 shell 執(zhí)行指定的命令。
cwd：用于設(shè)置子進(jìn)程的當(dāng)前目錄。
env：用于指定子進(jìn)程的環(huán)境變量。如果 env = None，子進(jìn)程的環(huán)境變量將從父進(jìn)程中繼承。
創(chuàng)建一個(gè)子進(jìn)程，然后執(zhí)行一個(gè)簡單的命令：
>>> import subprocess
>>> p = subprocess.Popen('ls -l', shell=True)
>>> total 164
-rw-r--r-- 1 root root 133 Jul 4 16:25 admin-openrc.sh
-rw-r--r-- 1 root root 268 Jul 10 15:55 admin-openrc-v3.sh
...
>>> p.returncode
>>> p.wait()
0
>>> p.returncode
0
這里也可以使用 p = subprocess.Popen(['ls', '-cl']) 來創(chuàng)建子進(jìn)程。
（2）Popen 對(duì)象的屬性
<1> p.pid：
子進(jìn)程的PID。
<2> p.returncode：
該屬性表示子進(jìn)程的返回狀態(tài)，returncode可能有多重情況：
- None —— 子進(jìn)程尚未結(jié)束；
- ==0 —— 子進(jìn)程正常退出；
- > 0—— 子進(jìn)程異常退出，returncode對(duì)應(yīng)于出錯(cuò)碼；
- < 0—— 子進(jìn)程被信號(hào)殺掉了。
<3> p.stdin, p.stdout, p.stderr：
子進(jìn)程對(duì)應(yīng)的一些初始文件，如果調(diào)用Popen()的時(shí)候?qū)?yīng)的參數(shù)是subprocess.PIPE，則這里對(duì)應(yīng)的屬性是一個(gè)包裹了這個(gè)管道的 file 對(duì)象。
（3）Popen 對(duì)象方法
- poll(): 檢查進(jìn)程是否終止，如果終止返回 returncode，否則返回 None。
- wait(timeout): 等待子進(jìn)程終止。
- communicate(input,timeout): 和子進(jìn)程交互，發(fā)送和讀取數(shù)據(jù)。
- send_signal(singnal): 發(fā)送信號(hào)到子進(jìn)程 。
- terminate(): 停止子進(jìn)程,也就是發(fā)送SIGTERM信號(hào)到子進(jìn)程。
- kill(): 殺死子進(jìn)程。發(fā)送 SIGKILL 信號(hào)到子進(jìn)程。
子進(jìn)程的PID存儲(chǔ)在child.pid
import time
import subprocess
def cmd(command):
subp = subprocess.Popen(command,shell=True,stdout=subprocess.PIPE,stderr=subprocess.PIPE,encoding="utf-8")
subp.wait(2)
if subp.poll() == 0:
print(subp.communicate()[1])
else:
print("失敗")
cmd("java -version")
cmd("exit 1")
輸出結(jié)果如下：
java version "1.8.0_31"
失敗
Java(TM) SE Runtime Environment (build 1.8.0_31-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.31-b07, mixed mode)
（4）子進(jìn)程的文本流控制
(沿用child子進(jìn)程) 子進(jìn)程的標(biāo)準(zhǔn)輸入，標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤也可以通過如下屬性表示:
- child.stdin
- child.stdout
- child.stderr
我們可以在Popen()建立子進(jìn)程的時(shí)候改變標(biāo)準(zhǔn)輸入、標(biāo)準(zhǔn)輸出和標(biāo)準(zhǔn)錯(cuò)誤，并可以利用subprocess.PIPE將多個(gè)子進(jìn)程的輸入和輸出連接在一起，構(gòu)成管道(pipe):
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)
執(zhí)行結(jié)果如下：
(b' 2 11 60 ', None)
subprocess.PIPE實(shí)際上為文本流提供一個(gè)緩存區(qū)。child1的stdout將文本輸出到緩存區(qū)，隨后child2的stdin從該P(yáng)IPE中將文本讀取走。child2的輸出文本也被存放在PIPE中，直到communicate()方法從PIPE中讀取出PIPE中的文本。
要注意的是，communicate()是Popen對(duì)象的一個(gè)方法，該方法會(huì)阻塞父進(jìn)程，直到子進(jìn)程完成。
我們還可以利用communicate()方法來使用PIPE給子進(jìn)程輸入:
import subprocess
child = subprocess.Popen(["cat"], stdin=subprocess.PIPE)
child.communicate("vamei".encode())
我們啟動(dòng)子進(jìn)程之后，cat會(huì)等待輸入，直到我們用communicate()輸入"vamei"。
通過使用subprocess包，我們可以運(yùn)行外部程序。這極大的拓展了Python的功能。如果你已經(jīng)了解了操作系統(tǒng)的某些應(yīng)用，你可以從Python中直接調(diào)用該應(yīng)用(而不是完全依賴Python)，并將應(yīng)用的結(jié)果輸出給Python，并讓Python繼續(xù)處理。shell的功能(比如利用文本流連接各個(gè)應(yīng)用)，就可以在Python中實(shí)現(xiàn)。
4、使用python自動(dòng)安i裝并啟動(dòng)mongodb
PyCharm記得連接linux
簡易流程
- Python自動(dòng)化運(yùn)維 --> 基于shell命令進(jìn)行封裝
- 編寫自動(dòng)化腳本 --> 用Python語法封裝shell命令的執(zhí)行過程
- python執(zhí)行shell命令 --> python外部命令
- python函數(shù)執(zhí)行shell命令
- os.system(cmd)：執(zhí)行cmd指令
- subprocess模塊
subprocess.call(['ls','-l'])
subprocess.call('ll' , shell=True)
運(yùn)行成功: 返回0
運(yùn)行失敗: 返回非0
subprocess. check_call (['ls', '-l'])
subprocess. check_call ('ll', shell=True)
運(yùn)行成功: 返回0
運(yùn)行失敗: 返回CalledProcessError
subprocess. check_ output(['cat', 'apache.log'], stderr= subprocess.STDOUT)
運(yùn)行成功:返回命令的輸出結(jié)果
運(yùn)行失敗:自定義錯(cuò)誤輸出stderr
subprocess模塊的Popen類
（1）PyCharm創(chuàng)建文件
# coding=utf-8
import subprocess
import os
import shutil
import tarfile
# 執(zhí)行外部命令的函數(shù)
def execute_cmd(cmd):
'''執(zhí)行shell命令'''
p = subprocess.Popen(cmd, shell=True,
stdin=subprocess.PIPE,
stdout=subprocess.PIPE,
stderr=subprocess.PIPE)
stdout, stderr = p.communicate()
if p.returncode != 0:
return p.returncode, stderr
return p.returncode, stdout
# 解壓
def unpackage_mongo(package, package_dir):
# 獲取MongoDB壓縮包的主文件名，也就是解壓后的目錄名稱
# mongodb-linux-x86_64-rhe170-4.2.3
unpackage_dir = os.path.splitext(package)[0]
if os.path.exists(unpackage_dir):
shutil.rmtree(unpackage_dir)
if os.path.exists(package_dir):
shutil.rmtree(package_dir)
# 解壓
try:
t = tarfile.open(package, 'r:gz')
t.extractall('.')
print('tar is ok.')
except Exception as e:
print(e)
# 重命名
shutil.move(unpackage_dir, 'mongo')
# 創(chuàng)建mongodata
def create_datadir(data_dir):
if os.path.exists(data_dir):
shutil.rmtree(data_dir)
os.mkdir(data_dir)
# 拼接啟動(dòng)MongoDB
def format_mongod_commamd(package_dir, data_dir, logfile):
# mongo/bin/mongod
mongod = os.path.join(package_dir, 'bin', 'mongod')
# mongo/bin/mongod --fork --logpath mongodata/mongod.log --dbpath mongodata
mongod_format = """{0} --fork --dbpath {1} --logpath {2}"""
return mongod_format.format(mongod, data_dir, logfile)
# 啟動(dòng)MongoDB
def start_mongod(cmd):
returncode, out = execute_cmd(cmd)
if returncode != 0:
raise SystemExit('execute {0} error:{1}'.format(cmd, out))
else:
print('execute {0} successfuly.'.format(cmd))
#入口函數(shù)
def main():
package = 'mongodb-linux-x86_64-rhel70-4.2.3.tgz'
cur_dir = os.path.abspath('.')
package_dir = os.path.join(cur_dir, 'mongo')
data_dir = os.path.join(cur_dir, 'mongodata')
logfile = os.path.join(data_dir, 'mongod.log')
# 判斷MongoDB壓縮包是否存在
if not os.path.exists(package):
raise SystemExit('{0} not found.'.format(package))
# 解壓
unpackage_mongo(package, package_dir)
create_datadir(data_dir)
# 啟動(dòng)mongodb
start_mongod(format_mongod_commamd(package_dir, data_dir, logfile))
# 配置環(huán)境變量
os.system('echo "export PATH=./mongo/bin:$PATH" > ~/.bash_profile')
os.system('source ~/.bash_profile')
os.system('./mongo/bin/mongo')
main()
- 在這段程序中，我們首先在main函數(shù)中定義了幾個(gè)變量，包括當(dāng)前目錄的路徑、MongoDB二進(jìn)制文件所在的路徑、MongoDB數(shù)據(jù)目錄所在的路徑，以及MongoDB的日志文件。
- 隨后，我們判斷MongoDB的安裝包是否存在，如果不存在，則通過拋出SystemExit異常的方式結(jié)束程序。
- 在unpackage_mongo函數(shù)中，我們通過Python程序得到MongoDB安裝包解壓以后的目錄。如果目錄已經(jīng)存在，則刪除該目錄。隨后，我們使用tarfile解MongoDB數(shù)據(jù)庫，解壓完成后，將命令重命名為mongo目錄。
- 在create_datadir目錄中，我們首先判斷MongoDB數(shù)據(jù)庫目錄是否存在，如果存在，則刪除該目錄，隨后再創(chuàng)建MongoDB數(shù)據(jù)庫目錄。
- 在start_mongod函數(shù)中， 我們執(zhí)行MongoDB數(shù)據(jù)庫的啟動(dòng)命令啟動(dòng)MongoDB數(shù)據(jù)庫。為了在Python代碼中執(zhí)行shell命令，我們使用了subprocess庫。 我們將subprocess庫執(zhí)行she11命令的邏輯封裝成execute_cmd函數(shù)，在執(zhí)行shell命令時(shí)，直接調(diào)用該函數(shù)即可。
（2）將PyCharm中的文件上傳到Linux
如果，是直接調(diào)用Linux中文件可用：
如果是本地創(chuàng)建：
（3）Linux執(zhí)行腳本，并測試
記得進(jìn)入PyCharm與linux連接的目錄（目前是/opt）
[root@python opt]# python auto_install_mongodb.py #執(zhí)行提前編寫好的腳本
tar is ok.
execute /opt/mongo/bin/mongod --fork --dbpath /opt/mongodata --logpath /opt/mongodata/mongod.log successfuly.
[root@python opt]# netstat -anpt | grep mongo #查看mongo是否啟動(dòng)
tcp 0 0 127.0.0.1:27017 0.0.0.0:* LISTEN 4616mongod
[root@python opt]# ls #查看是否生成mongo目錄
01find_cmd.py bb.bmp mongodb-linux-x86_64-rhel70-4.2.3.tgz
aaa.jpg cc.png rh
adc.txt mongo subprocess_demo
auto_install_mongodb.py mongodata
[root@python opt]# cd mongo
[root@python mongo]# cd bin/
[root@python bin]# ./mongo #進(jìn)入mongo
MongoDB shell version v4.2.3
connecting to: mongodb://127.0.0.1:27017/?compressors=disabled&gssapiServiceName=mongodb
Implicit session: session { "id" : UUID("c302ff50-7e27-40b7-8046-8441af8cb965") }
MongoDB server version: 4.2.3
> show databases; #查看數(shù)據(jù)庫
admin 0.000GB
config 0.000GB
local 0.000GB
到此這篇關(guān)于Python實(shí)現(xiàn)subprocess執(zhí)行外部命令的文章就介紹到這了,希望能對(duì)各位小伙伴有所幫助，也希望大家以后多多支持W3Cschool！
