Python 開發(fā)命令行工具

作者: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 自身也集成了一些標(biāo)準(zhǔn)庫,專門用于處理命令行相關(guān)的問題。

命令行工具的一般結(jié)構(gòu)

CL-in-Python

1. 標(biāo)準(zhǔn)輸入輸出

*nix 系統(tǒng)中,一切皆為文件,因此標(biāo)準(zhǔn)輸入、輸出可以完全可以看做是對文件的操作。標(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']

對于比較復(fù)雜的命令行參數(shù),例如通過 --option 傳遞的選項(xiàng)參數(shù),如果是對 sys.argv 逐項(xiàng)進(jìn)行解析會(huì)很麻煩,Python 提供標(biāo)準(zhǔn)庫 argparse(舊的庫為 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)庫,它的存在就是為了替代舊的 os.system; os.spawn*

subprocess 模塊提供簡便的直接調(diào)用系統(tǒng)指令的call()方法,以及較為復(fù)雜可以讓用戶更加深入地與系統(tǒng)命令進(jìn)行交互的Popen對象。

# 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

如果只是簡單地執(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",
最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,923評(píng)論 6 535
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 98,740評(píng)論 3 420
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,856評(píng)論 0 380
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經(jīng)常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,175評(píng)論 1 315
  • 正文 為了忘掉前任,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 71,931評(píng)論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 55,321評(píng)論 1 324
  • 那天,我揣著相機(jī)與錄音,去河邊找鬼。 笑死,一個(gè)胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,383評(píng)論 3 443
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 42,533評(píng)論 0 289
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 49,082評(píng)論 1 335
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 40,891評(píng)論 3 356
  • 正文 我和宋清朗相戀三年,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 43,067評(píng)論 1 371
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,618評(píng)論 5 362
  • 正文 年R本政府宣布,位于F島的核電站,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 44,319評(píng)論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,732評(píng)論 0 27
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,987評(píng)論 1 289
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個(gè)月前我還...
    沈念sama閱讀 51,794評(píng)論 3 394
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 48,076評(píng)論 2 375

推薦閱讀更多精彩內(nèi)容