Python腳本argparse使用

Python的腳本可以自然而然寫成可運行腳本霸琴,在文件頭加入

#!/usr/bin/env python

或者

#!/usr/bin/python

即可。當(dāng)然也可以通過執(zhí)行python target.py來運行腳本昭伸。實際編寫Python腳本的時候梧乘,需要考慮編寫參數(shù),當(dāng)可選參數(shù)比較多的時候庐杨,通過sys.argv是非常麻煩的选调。幸好Python自帶argparse工具幫助我們快速實現(xiàn)各種參數(shù),而且自動生成幫助文檔灵份,這里介紹其基本使用方法仁堪。

最基本配置

如果一個腳本沒有參數(shù),只有幫助文檔填渠,Python腳本可以寫作

#!/usr/bin/env python
import argparse
parser = argparse.ArgumentParser() # 生成參數(shù)分析器
parser.parse_args()

此時弦聂,該腳本為無參數(shù)腳本鸟辅,一系列運行結(jié)果為

./prog_base.py -h
usage: prog_base.py [-h]

optional arguments:
  -h, --help  show this help message and exit

如果添加錯誤的參數(shù)信息,會自動輸出錯誤提示莺葫,例如我們添加可選參數(shù)--verbose

> ./prog_base.py --verbose
usage: prog_base.py [-h]
prog_base.py: error: unrecognized arguments: --verbose

會自動告訴用戶未識別該參數(shù)匪凉。

添加位置參數(shù)

位置參數(shù)一般是命令的主要參數(shù),一般在命令最尾端捺檬,例如我們希望編寫一個簡單的腳本再层,將一個位置參數(shù)的值輸出,Python代碼寫作

import argparse
parser = argparse.ArgumentParser() # 生成參數(shù)分析器
parser.add_argument("echo") # 添加位置參數(shù)
args = parser.parse_args()
print args.echo

此時欺冀,python腳本會將參數(shù)值輸出

> python prog_pos.py haha
haha

如果沒有添加參數(shù)則會報錯

> python prog_pos.py 
usage: prog_pos.py [-h] echo
prog_pos.py: error: too few arguments

并且可以使用-h或者--help參數(shù)查看腳本幫助文檔

> python prog_pos.py haha -h
usage: prog_pos.py [-h] echo

positional arguments:
  echo

optional arguments:
  -h, --help  show this help message and exit

可以發(fā)現(xiàn)現(xiàn)在echo沒有任何幫助說明树绩,要啟用非常簡單,在添加這個參數(shù)的時候加入help可選參數(shù)即可隐轩,如

parser.add_argument("echo", help = "echo the string you use here")

同時Python的 argparse可以給定輸入類型饺饭,比如我們想寫一個計算輸入平方數(shù)的程序,假定調(diào)用方法為

prog_square.py [-h] number

我們可以這樣編寫腳本

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("number", help="display a square of a given number", type=int)
args = parser.parse_args()
print args.square**2

add_argument的時候指定其可選參數(shù)typeint類型职车,則在分析輸入命令的時候會自動解析為整數(shù)型瘫俊,此時調(diào)用結(jié)果為

> python prog_square.py 4
16

可以發(fā)現(xiàn)使用Python的argparse非常方便易用。

可選參數(shù)添加

比如我們想給一個腳本添加一個打印詳細程度的指標(biāo)悴灵,當(dāng)verbose開啟的時候會打印出相應(yīng)的信息扛芽。

import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity")
args = parser.parse_args()
if args.verbose: 
     print "verbosity turned on"

當(dāng)直接運行腳本的時候沒有任何輸出,當(dāng)加入verbose之后會打印出多出來的內(nèi)容

> python prog_verbose.py
> python prog_verbose.py --verbose
verbosity turned on

小結(jié)

有了這些基本功能积瞒,可以使用Python寫出功能很強的執(zhí)行腳本川尖,個人覺得比bash好用一些。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末茫孔,一起剝皮案震驚了整個濱河市叮喳,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌缰贝,老刑警劉巖馍悟,帶你破解...
    沈念sama閱讀 218,755評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異剩晴,居然都是意外死亡锣咒,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,305評論 3 395
  • 文/潘曉璐 我一進店門赞弥,熙熙樓的掌柜王于貴愁眉苦臉地迎上來毅整,“玉大人,你說我怎么就攤上這事绽左∶担” “怎么了?”我有些...
    開封第一講書人閱讀 165,138評論 0 355
  • 文/不壞的土叔 我叫張陵妇菱,是天一觀的道長承粤。 經(jīng)常有香客問我,道長闯团,這世上最難降的妖魔是什么辛臊? 我笑而不...
    開封第一講書人閱讀 58,791評論 1 295
  • 正文 為了忘掉前任,我火速辦了婚禮房交,結(jié)果婚禮上彻舰,老公的妹妹穿的比我還像新娘。我一直安慰自己候味,他們只是感情好刃唤,可當(dāng)我...
    茶點故事閱讀 67,794評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著白群,像睡著了一般尚胞。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上帜慢,一...
    開封第一講書人閱讀 51,631評論 1 305
  • 那天笼裳,我揣著相機與錄音,去河邊找鬼粱玲。 笑死躬柬,一個胖子當(dāng)著我的面吹牛,可吹牛的內(nèi)容都是我干的抽减。 我是一名探鬼主播允青,決...
    沈念sama閱讀 40,362評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼卵沉!你這毒婦竟也來了颠锉?” 一聲冷哼從身側(cè)響起,我...
    開封第一講書人閱讀 39,264評論 0 276
  • 序言:老撾萬榮一對情侶失蹤偎箫,失蹤者是張志新(化名)和其女友劉穎木柬,沒想到半個月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體淹办,經(jīng)...
    沈念sama閱讀 45,724評論 1 315
  • 正文 獨居荒郊野嶺守林人離奇死亡眉枕,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,900評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現(xiàn)自己被綠了怜森。 大學(xué)時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片速挑。...
    茶點故事閱讀 40,040評論 1 350
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖副硅,靈堂內(nèi)的尸體忽然破棺而出姥宝,到底是詐尸還是另有隱情,我是刑警寧澤恐疲,帶...
    沈念sama閱讀 35,742評論 5 346
  • 正文 年R本政府宣布腊满,位于F島的核電站套么,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏碳蛋。R本人自食惡果不足惜胚泌,卻給世界環(huán)境...
    茶點故事閱讀 41,364評論 3 330
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望肃弟。 院中可真熱鬧玷室,春花似錦、人聲如沸笤受。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,944評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽箩兽。三九已至津肛,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間比肄,已是汗流浹背快耿。 一陣腳步聲響...
    開封第一講書人閱讀 33,060評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留芳绩,地道東北人掀亥。 一個月前我還...
    沈念sama閱讀 48,247評論 3 371
  • 正文 我出身青樓,卻偏偏與公主長得像妥色,于是被迫代替她去往敵國和親搪花。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點故事閱讀 44,979評論 2 355

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