項(xiàng)目地址:https://git.io/pytips
Python 作為一種腳本語言,可以非常方便地用于系統(tǒng)(尤其是*nix系統(tǒng))命令行工具的開發(fā)骤公。Python 自身也集成了一些標(biāo)準(zhǔn)庫(kù)幼东,專門用于處理命令行相關(guān)的問題。
命令行工具的一般結(jié)構(gòu)
1. 標(biāo)準(zhǔn)輸入輸出
*nix 系統(tǒng)中,一切皆為文件铭拧,因此標(biāo)準(zhǔn)輸入时肿、輸出可以完全可以看做是對(duì)文件的操作庇茫。標(biāo)準(zhǔn)化輸入可以通過管道(pipe)或重定向(redirect)的方式傳遞:
# script reverse.py
#!/usr/bin/env python
import sys
for l in sys.stdin.readlines():
sys.stdout.write(l[::-1])
保存為 reverse.py
,通過管道 |
傳遞:
chmod +x reverse.py
cat reverse.py | ./reverse.py
nohtyp vne/nib/rsu/!#
sys tropmi
:)(senildaer.nidts.sys ni l rof
)]1-::[l(etirw.tuodts.sys
通過重定向 <
傳遞:
./reverse.py < reverse.py
# 輸出結(jié)果同上
2. 命令行參數(shù)
一般在命令行后追加的參數(shù)可以通過 sys.argv
獲取螃成, sys.argv
是一個(gè)列表旦签,其中第一個(gè)元素為當(dāng)前腳本的文件名:
# script argv.py
#!/usr/bin/env python
import sys
print(sys.argv) # 下面返回的是 Jupyter 運(yùn)行的結(jié)果
['/Users/rainy/Projects/GitHub/pytips/venv3/lib/python3.5/site-packages/ipykernel/__main__.py', '-f', '/Users/rainy/Library/Jupyter/runtime/kernel-0533e681-bd7c-4c4d-9094-a78fde7fc2ed.json']
運(yùn)行上面的腳本:
chmod +x argv.py
./argv.py hello world
python argv.py hello world
# 返回的結(jié)果是相同的
# ['./test.py', 'hello', 'world']
對(duì)于比較復(fù)雜的命令行參數(shù),例如通過 --option
傳遞的選項(xiàng)參數(shù)寸宏,如果是對(duì) sys.argv
逐項(xiàng)進(jìn)行解析會(huì)很麻煩宁炫,Python 提供標(biāo)準(zhǔn)庫(kù) argparse
(舊的庫(kù)為 optparse
,已經(jīng)停止維護(hù))專門解析命令行參數(shù):
# script convert.py
#!/usr/bin/env python
import argparse as apa
def loadConfig(config):
print("Load config from: {}".format(config))
def setTheme(theme):
print("Set theme: {}".format(theme))
def main():
parser = apa.ArgumentParser(prog="convert") # 設(shè)定命令信息氮凝,用于輸出幫助信息
parser.add_argument("-c", "--config", required=False, default="config.ini")
parser.add_argument("-t", "--theme", required=False, default="default.theme")
parser.add_argument("-f") # Accept Jupyter runtime option
args = parser.parse_args()
loadConfig(args.config)
setTheme(args.theme)
if __name__ == "__main__":
main()
Load config from: config.ini
Set theme: default.theme
利用 argparse
可以很方便地解析選項(xiàng)參數(shù)羔巢,同時(shí)可以定義指定參數(shù)的相關(guān)屬性(是否必須、默認(rèn)值等)罩阵,同時(shí)還可以自動(dòng)生成幫助文檔竿秆。執(zhí)行上面的腳本:
./convert.py -h
usage: convert [-h] [-c CONFIG] [-t THEME]
optional arguments:
-h, --help show this help message and exit
-c CONFIG, --config CONFIG
-t THEME, --theme THEME
3. 執(zhí)行系統(tǒng)命令
當(dāng) Python 能夠準(zhǔn)確地解讀輸入信息或參數(shù)之后,就可以通過 Python 去做任何事情了永脓。這里主要介紹通過 Python 調(diào)用系統(tǒng)命令袍辞,也就是替代 Shell
腳本完成系統(tǒng)管理的功能。我以前的習(xí)慣是將命令行指令通過 os.system(command)
執(zhí)行常摧,但是更好的做法應(yīng)該是用 subprocess
標(biāo)準(zhǔn)庫(kù)搅吁,它的存在就是為了替代舊的 os.system; os.spawn*
。
subprocess
模塊提供簡(jiǎn)便的直接調(diào)用系統(tǒng)指令的call()
方法落午,以及較為復(fù)雜可以讓用戶更加深入地與系統(tǒng)命令進(jìn)行交互的Popen
對(duì)象谎懦。
# script list_files.py
#!/usr/bin/env python
import subprocess as sb
res = sb.check_output("ls -lh ./*.ipynb", shell=True) # 為了安全起見,默認(rèn)不通過系統(tǒng) Shell 執(zhí)行溃斋,因此需要設(shè)定 shell=True
print(res.decode()) # 默認(rèn)返回值為 bytes 類型界拦,需要進(jìn)行解碼操作
-rw-r--r-- 1 rainy staff 3.4K 3 8 17:36 ./2016-03-06-The-Zen-of-Python.ipynb
-rw-r--r-- 1 rainy staff 6.7K 3 8 17:45 ./2016-03-07-iterator-and-generator.ipynb
-rw-r--r-- 1 rainy staff 6.0K 3 10 12:35 ./2016-03-08-Functional-Programming-in-Python.ipynb
-rw-r--r-- 1 rainy staff 5.9K 3 9 16:28 ./2016-03-09-List-Comprehension.ipynb
-rw-r--r-- 1 rainy staff 10K 3 10 14:14 ./2016-03-10-Scope-and-Closure.ipynb
-rw-r--r-- 1 rainy staff 8.0K 3 11 16:30 ./2016-03-11-Arguments-and-Unpacking.ipynb
-rw-r--r-- 1 rainy staff 8.5K 3 14 19:31 ./2016-03-14-Command-Line-tools-in-Python.ipynb
如果只是簡(jiǎn)單地執(zhí)行系統(tǒng)命令還不能滿足你的需求,可以使用 subprocess.Popen
與生成的子進(jìn)程進(jìn)行更多交互:
import subprocess as sb
p = sb.Popen(['grep', 'communicate'], stdin=sb.PIPE, stdout=sb.PIPE)
res, err = p.communicate(sb.check_output('cat ./*', shell=True))
if not err:
print(res.decode())
" \"p = sb.Popen(['grep', 'communicate'], stdout=sb.PIPE)\\n\",\n",
" \"# res = p.communicate(sb.check_output('cat ./*'))\"\n",
"p = sb.Popen(['grep', 'communicate'], stdin=sb.PIPE, stdout=sb.PIPE)\n",
"res, err = p.communicate(sb.check_output('cat ./*', shell=True))\n",