PyTips 0x06 - Python 開發命令行工具

項目地址：https://git.io/pytips

Python 做爲一種腳本語言，能夠很是方便地用於系統（尤爲是*nix系統）命令行工具的開發。Python 自身也集成了一些標準庫，專門用於處理命令行相關的問題。

命令行工具的通常結構：

1. 標準輸入輸出

*nix 系統中，一切皆爲文件，所以標準輸入、輸出能夠徹底能夠看作是對文件的操做。標準化輸入能夠經過管道（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. 命令行參數

通常在命令行後追加的參數能夠經過 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']

對於比較複雜的命令行參數，例如經過 --option 傳遞的選項參數，若是是對 sys.argv 逐項進行解析會很麻煩，Python 提供標準庫 argparse（舊的庫爲 optparse，已經中止維護）專門解析命令行參數：

# 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 能夠很方便地解析選項參數，同時能夠定義指定參數的相關屬性（是否必須、默認值等），同時還能夠自動生成幫助文檔。執行上面的腳本：

./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. 執行系統命令

當 Python 可以準確地解讀輸入信息或參數以後，就能夠經過 Python 去作任何事情了。這裏主要介紹經過 Python 調用系統命令，也就是替代 Shell 腳本完成系統管理的功能。我之前的習慣是將命令行指令經過 os.system(command) 執行，可是更好的作法應該是用 subprocess 標準庫，它的存在就是爲了替代舊的 os.system; os.spawn* 。

subprocess 模塊提供簡便的直接調用系統指令的call()方法，以及較爲複雜可讓用戶更加深刻地與系統命令進行交互的Popen對象。

# script list_files.py
#!/usr/bin/env python
import subprocess as sb
res = sb.check_output("ls -lh ./*.ipynb", shell=True) # 爲了安全起見，默認不經過系統 Shell 執行，所以須要設定 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

若是隻是簡單地執行系統命令還不能知足你的需求，可使用 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",

---

歡迎關注公衆號 PyHub！