最近在研究pathon的命令行解析工具,argparse,它是Python標(biāo)準(zhǔn)庫中推薦使用的編寫命令行程序的工具。
以前老是做UI程序,今天試了下命令行程序,感覺相當(dāng)好,不用再花大把時(shí)間去研究界面問題,尤其是vc++中尤其繁瑣。
現(xiàn)在用python來實(shí)現(xiàn)命令行,核心計(jì)算模塊可以用c自己寫擴(kuò)展庫,效果挺好。
學(xué)習(xí)了argparse,在官方文檔中找到一篇toturial,簡單翻譯了下。
http://docs.python.org/2/howto/argparse.html#id1
Argparse Tutorial
這篇教程簡明地介紹了Python標(biāo)準(zhǔn)庫推薦使用的命令行參數(shù)解析模塊——Argparse的使用。
1、基本概念
在這篇教程中我們通過一個(gè)常見的ls命令來展示argparse的功能。
$ lscpython devguide prog.py pypy rm-unused-function.patch$ ls pypyctypes_configure demo dotviewer include lib_pypy lib-python ...$ ls -ltotal 20drwxr-xr-x 19 wena wena 4096 Feb 18 18:51 cpythondrwxr-xr-x 4 wena wena 4096 Feb 8 12:04 devguide-rwxr-xr-x 1 wena wena 535 Feb 19 00:05 prog.pydrwxr-xr-x 14 wena wena 4096 Feb 7 00:59 pypy-rw-r--r-- 1 wena wena 741 Feb 18 01:01 rm-unused-function.patch$ ls --helpUsage: ls [OPTION]... [FILE]...List information about the FILEs (the current directory by default).Sort entries alphabetically if none of -cftuvSUX nor --sort is specified.
從以上的四個(gè)命令中,我們能夠了解以下幾個(gè)基本概念:
1)、ls命令在沒有參數(shù)的情況下也是可以運(yùn)行的,默認(rèn)打印出當(dāng)前目錄下的所有內(nèi)容。
2)、如果我們想讓它展示更多內(nèi)容,那么我們需要給它多一點(diǎn)參數(shù)。在這種情況下,我們想顯示一個(gè)不同的目錄,pypy。我們所做的就是明確了常見的定位參數(shù)(positional argument),這樣命名是因?yàn)樾枰绦蚋鶕?jù)參數(shù)在命令行中的位置而決定做什么。這個(gè)概念與命令cp更為接近,它的用法是cp src dest,src表示的是你想要拷貝的文件,dest表示你想要將文件拷貝到哪里。
3)、現(xiàn)在,我想要改變程序的行為。在我們的例子中,我想顯示文件的向西信息而不僅僅是文件名,參數(shù)-l 則是我們所知道的可選參數(shù)(optinal argument)
4)、最后一句是顯示幫助的文檔的一個(gè)片段,當(dāng)你遇到你從未使用過的命令時(shí),你可以通過它學(xué)習(xí)怎么使用。
2、基本認(rèn)識
我們從一個(gè)基本的程序開始(它什么也不做)
import argparseparser = argparse.ArgumentParser()parser.parse_args()
運(yùn)行結(jié)果:
$ python prog.py$ python prog.py --helpusage: prog.py [-h]optional arguments: -h, --help show this help message and exit$ python prog.py --verboseusage: prog.py [-h]prog.py: error: unrecognized arguments: --verbose$ python prog.py foousage: prog.py [-h]prog.py: error: unrecognized arguments: foo
結(jié)果分析:
1)、若不給參數(shù)而運(yùn)行這個(gè)程序,將不會得到任何結(jié)果。
2)、第二條命名顯示了使用的argparse的好處,你什么也沒做,卻得到了一個(gè)很好的幫助信息。
3)、我們無需人為設(shè)置--help參數(shù),就能得到一個(gè)良好的幫助信息。但是若給其他參數(shù)(比如foo)就會產(chǎn)生一個(gè)錯(cuò)誤。
3、位置參數(shù)
首先,給一個(gè)例子:
import argparseparser = argparse.ArgumentParser()parser.add_argument("echo")args = parser.parse_args()print args.echo 運(yùn)行結(jié)果:
$ python prog.pyusage: prog.py [-h] echoprog.py: error: the following arguments are required: echo$ python prog.py --helpusage: prog.py [-h] echopositional arguments: echooptional arguments: -h, --help show this help message and exit$ python prog.py foofoo
結(jié)果分析:
這次,我們增加了一個(gè)add_argument()方法,用來設(shè)置程序可接受的命令行參數(shù)。
現(xiàn)在要運(yùn)行程序,就必須設(shè)置一個(gè)參數(shù)。
parse_args()方法實(shí)際上從我們的命令行參數(shù)中返回了一些數(shù)據(jù),在上面的例子中是echo
這個(gè)像“魔法”一樣的過程,是argparse自動(dòng)完成的。
盡管自動(dòng)產(chǎn)生的幫助信息展示地很美觀,但是我們?nèi)匀粺o法只根據(jù)echo這個(gè)參數(shù)知道它是做什么的。所以,我們增加了一些東西,使得它變得更有用。
import argparseparser = argparse.ArgumentParser()parser.add_argument("echo", help="echo the string you use here")args = parser.parse_args()print args.echo 運(yùn)行結(jié)果:
$ python prog.py -husage: prog.py [-h] echopositional arguments: echo echo the string you use hereoptional arguments: -h, --help show this help message and exit
在此基礎(chǔ)上,我們再多改變一點(diǎn):(計(jì)算輸入?yún)?shù)square的平方)
import argparseparser = argparse.ArgumentParser()parser.add_argument("square", help="display a square of a given number")args = parser.parse_args()print args.square**2 下面是運(yùn)行結(jié)果:
$ python prog.py 4Traceback (most recent call last): File "prog.py", line 5, in <module> print args.square**2TypeError: unsupported operand type(s) for ** or pow(): 'str' and 'int'
這個(gè)程序并不能正確運(yùn)行,因?yàn)閍rgparse會將輸入當(dāng)作字符串處理,所以我們需要設(shè)置它的類型:(type=int)
import argparseparser = argparse.ArgumentParser()parser.add_argument("square", help="display a square of a given number", type=int)args = parser.parse_args()print args.square**2 下面是運(yùn)行結(jié)果:
$ python prog.py 416$ python prog.py fourusage: prog.py [-h] squareprog.py: error: argument square: invalid int value: 'four'
現(xiàn)在,這個(gè)程序能夠順利運(yùn)行,而且能夠處理一些錯(cuò)誤輸入。
以上就是關(guān)于Python命令行解析工具Argparse的簡單使用教程,希望對大家有幫助。



















