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ù)添加

比如我們想給一個腳本添加一個打印詳細(xì)程度的指標(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)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點,簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容