作者:rainyear
原文地址:
https://github.com/rainyear/pytips/blob/master/Markdowns/2016-03-14-Command-Line-tools-in-Python.md
Python 作為一種腳本語言,可以非常方便地用于系統(tǒng)(尤其是*nix系統(tǒng))命令行工具的開發(fā)。Python 自身也集成了一些標準庫,專門用于處理命令行相關的問題。
命令行工具的一般結構

1. 標準輸入輸出
*nix 系統(tǒng)中,一切皆為文件,因此標準輸入、輸出可以完全可以看做是對文件的操作。標準化輸入可以通過管道(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
# 輸出結果同上
2. 命令行參數(shù)
一般在命令行后追加的參數(shù)可以通過 sys.argv 獲取, sys.argv 是一個列表,其中第一個元素為當前腳本的文件名:
# script argv.py
#!/usr/bin/env python
import sys
print(sys.argv) # 下面返回的是 Jupyter 運行的結果
['/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']
運行上面的腳本:
chmod +x argv.py
./argv.py hello world
python argv.py hello world
# 返回的結果是相同的
# ['./test.py', 'hello', 'world']
對于比較復雜的命令行參數(shù),例如通過 --option 傳遞的選項參數(shù),如果是對 sys.argv 逐項進行解析會很麻煩,Python 提供標準庫 argparse(舊的庫為 optparse,已經停止維護)專門解析命令行參數(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") # 設定命令信息,用于輸出幫助信息
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 可以很方便地解析選項參數(shù),同時可以定義指定參數(shù)的相關屬性(是否必須、默認值等),同時還可以自動生成幫助文檔。執(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)命令
當 Python 能夠準確地解讀輸入信息或參數(shù)之后,就可以通過 Python 去做任何事情了。這里主要介紹通過 Python 調用系統(tǒng)命令,也就是替代 Shell 腳本完成系統(tǒng)管理的功能。我以前的習慣是將命令行指令通過 os.system(command) 執(zhí)行,但是更好的做法應該是用 subprocess 標準庫,它的存在就是為了替代舊的 os.system; os.spawn* 。
subprocess 模塊提供簡便的直接調用系統(tǒng)指令的call()方法,以及較為復雜可以讓用戶更加深入地與系統(tǒng)命令進行交互的Popen對象。
# script list_files.py
#!/usr/bin/env python
import subprocess as sb
res = sb.check_output("ls -lh ./*.ipynb", shell=True) # 為了安全起見,默認不通過系統(tǒng) Shell 執(zhí)行,因此需要設定 shell=True
print(res.decode()) # 默認返回值為 bytes 類型,需要進行解碼操作
-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
如果只是簡單地執(zhí)行系統(tǒng)命令還不能滿足你的需求,可以使用 subprocess.Popen 與生成的子進程進行更多交互:
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",