在多個(gè)文件或者不同語(yǔ)言協(xié)同的項(xiàng)目中，python腳本經(jīng)常需要從命令行直接讀取參數(shù)。萬(wàn)能的python就自帶了argprase包使得這一工作變得簡(jiǎn)單而規(guī)范。PS：optparse包是類(lèi)似的功能，只不過(guò)寫(xiě)起來(lái)更麻煩一些。

如果腳本很簡(jiǎn)單或臨時(shí)使用，沒(méi)有多個(gè)復(fù)雜的參數(shù)選項(xiàng)，可以直接利用sys.argv將腳本后的參數(shù)依次讀取(讀進(jìn)來(lái)的默認(rèn)是字符串格式)。比如如下名為test.py的腳本：

import sys
print "Input argument is %s" %(sys.argv[0])

在shell腳本中運(yùn)行python test.py help可以得到Input argument is help的結(jié)果。

1) 一般形式

但是大多數(shù)情況下，腳本很可能需要多個(gè)參數(shù)，而且每次參數(shù)的類(lèi)型用處各不相同，那么這個(gè)時(shí)候在參數(shù)前添加標(biāo)簽表明參數(shù)的類(lèi)型和用途便十分有用，而利用argparse模塊可以很方便得實(shí)現(xiàn)這一目的。

同樣用名為test.py的腳本舉個(gè)栗子：

import argparse

parser = argparse.ArgumentParser(description="your script description")      # description參數(shù)可以用于插入描述腳本用途的信息，可以為空
parser.add_argument('--verbose', '-v', action='store_true', help='verbose mode')  # 添加--verbose標(biāo)簽，標(biāo)簽別名可以為-v，這里action的意思是當(dāng)讀取的參數(shù)中出現(xiàn)--verbose/-v的時(shí)候
                                          # 參數(shù)字典的verbose建對(duì)應(yīng)的值為T(mén)rue，而help參數(shù)用于描述--verbose參數(shù)的用途或意義。
args = parser.parse_args()                             # 將變量以標(biāo)簽-值的字典形式存入args字典
if args.verbose:
  print "Verbose mode on!"
else:
  print "Verbose mode off!"

運(yùn)行python test.py后面跟了--verbose/-v的時(shí)候會(huì)輸出前者，如果什么都沒(méi)有會(huì)輸出后者。如果輸入了--verbose/-v以外的參數(shù)則會(huì)報(bào)錯(cuò)：unrecognized arguments
稍微提一下，action參數(shù)表示值賦予鍵的方式，這里用到的是bool類(lèi)型；如果是'count'表示將--verbose標(biāo)簽出現(xiàn)的次數(shù)作為verbose的值；'append'表示將每次出現(xiàn)的該便簽后的值都存入同一個(gè)數(shù)組再賦值。（嘛，一般后面兩種用的比較少就不多說(shuō)了）
PS：--help標(biāo)簽在使用argparse模塊時(shí)會(huì)自動(dòng)創(chuàng)建，因此一般情況不需要我們主動(dòng)定義幫助信息。

$ python test.py --help
usage: test.py [-h] [--verbose]

your script description

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

2) 必需參數(shù)

這種模式用于確保某些必需的參數(shù)有輸入。

parser.add_argument('--verbose', required=True, type=int)

required標(biāo)簽就是說(shuō)--verbose參數(shù)是必需的，并且類(lèi)型為int，輸入別的類(lèi)型會(huì)報(bào)錯(cuò)。

3）位置參數(shù)（positional arguments）

位置參數(shù)與sys.argv調(diào)用比較像，參數(shù)沒(méi)有顯式的--xxx或者-xxx標(biāo)簽，因此調(diào)用屬性也與sys.argv相同。

parser.add_argument('filename')  # 輸入的第一個(gè)參數(shù)賦予名為filename的鍵
args = parser.parse_args()
print "Read in %s" %(args.filename)

輸入python test.py test.txt則會(huì)輸出Read in test.txt

此外，可以用nargs參數(shù)來(lái)限定輸入的位置參數(shù)的個(gè)數(shù)，默認(rèn)為1。當(dāng)然nargs參數(shù)也可用于普通帶標(biāo)簽的參數(shù)。
parser.add_argument('num', nargs=2, type=int)表示腳本可以讀入兩個(gè)整數(shù)賦予num鍵（此時(shí)的值為2個(gè)整數(shù)的數(shù)組）。nargs還可以'*'用來(lái)表示如果有該位置參數(shù)輸入的話，之后所有的輸入都將作為該位置參數(shù)的值；‘+'表示讀取至少1個(gè)該位置參數(shù)。'?'表示該位置參數(shù)要么沒(méi)有，要么就只要一個(gè)。（PS：跟正則表達(dá)式的符號(hào)用途一致。）

比如用：

parser.add_argument('filename')
parser.add_argument('num', nargs='*)

就可以運(yùn)行python test.py text.txt 1 2

由于沒(méi)有標(biāo)簽，所以用位置參數(shù)的時(shí)候需要比較小心。

4）輸入類(lèi)型

之前已經(jīng)提到了用type參數(shù)就可以指定輸入的參數(shù)類(lèi)型。而這個(gè)type類(lèi)型還可以表示文件操作的類(lèi)型從而直接進(jìn)行文件的讀寫(xiě)操作。

parser.add_argument('file', type=argparser.FileType('r'))  # 讀取文件
args = parser.parse_args()
for line in args.file:
  print line.strip()

5）參數(shù)默認(rèn)值

一般情況下會(huì)設(shè)置一些默認(rèn)參數(shù)從而不需要每次輸入某些不需要變動(dòng)的參數(shù)，利用default參數(shù)即可實(shí)現(xiàn)。

parser.add_argument('filename', default='text.txt')

這個(gè)時(shí)候至直接運(yùn)行python text.py就能得到Read in text.txt而不需要輸入文件名了。

6）候選參數(shù)選擇

表示該參數(shù)能接受的值只能來(lái)自某幾個(gè)值候選值中，除此以外會(huì)報(bào)錯(cuò)，用choices參數(shù)即可。比如：

parser.add_argument('filename', choices=['test1.txt', 'text2.txt'])

參考：

https://mkaz.tech/python-argparse-cookbook.html

https://docs.python.org/2/howto/argparse.html

以下是其他網(wǎng)友的補(bǔ)充：

一、簡(jiǎn)介：

argparse是python用于解析命令行參數(shù)和選項(xiàng)的標(biāo)準(zhǔn)模塊，用于代替已經(jīng)過(guò)時(shí)的optparse模塊。argparse模塊的作用是用于解析命令行參數(shù)，例如python parseTest.py input.txt output.txt --user=name --port=8080。

二、使用步驟：

1：import argparse

2：parser = argparse.ArgumentParser()

3：parser.add_argument()

4：parser.parse_args()

解釋?zhuān)菏紫葘?dǎo)入該模塊；然后創(chuàng)建一個(gè)解析對(duì)象；然后向該對(duì)象中添加你要關(guān)注的命令行參數(shù)和選項(xiàng)，每一個(gè)add_argument方法對(duì)應(yīng)一個(gè)你要關(guān)注的參數(shù)或選項(xiàng)；最后調(diào)用parse_args()方法進(jìn)行解析；解析成功之后即可使用，下面簡(jiǎn)單說(shuō)明一下步驟2和3。

三、方法ArgumentParser(prog=None, usage=None,description=None, epilog=None, parents=[],formatter_class=argparse.HelpFormatter, prefix_chars='-',fromfile_prefix_chars=None, argument_default=None,conflict_handler='error', add_help=True)

這些參數(shù)都有默認(rèn)值，當(dāng)調(diào)用parser.print_help()或者運(yùn)行程序時(shí)由于參數(shù)不正確(此時(shí)python解釋器其實(shí)也是調(diào)用了pring_help()方法)時(shí)，會(huì)打印這些描述信息，一般只需要傳遞description參數(shù)，如上。

四、方法add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

其中：

name or flags：命令行參數(shù)名或者選項(xiàng)，如上面的address或者-p,--port.其中命令行參數(shù)如果沒(méi)給定，且沒(méi)有設(shè)置defualt，則出錯(cuò)。但是如果是選項(xiàng)的話，則設(shè)置為None

nargs：命令行參數(shù)的個(gè)數(shù)，一般使用通配符表示，其中，'?'表示只用一個(gè)，'*'表示0到多個(gè)，'+'表示至少一個(gè)

default：默認(rèn)值

type：參數(shù)的類(lèi)型，默認(rèn)是字符串string類(lèi)型，還有float、int等類(lèi)型

help：和ArgumentParser方法中的參數(shù)作用相似，出現(xiàn)的場(chǎng)合也一致

最常用的地方就是這些，其他的可以參考官方文檔。下面給出一個(gè)例子，基本包括了常見(jiàn)的情形：

import argparse
 
def parse_args():
  description = usage: %prog [options] poetry-file
 
This is the Slow Poetry Server, blocking edition.
Run it like this:
 
 python slowpoetry.py <path-to-poetry-file>
 
If you are in the base directory of the twisted-intro package,
you could run it like this:
 
 python blocking-server/slowpoetry.py poetry/ecstasy.txt
 
to serve up John Donne's Ecstasy, which I know you want to do.
 
 
  parser = argparse.ArgumentParser(description = description)
   
  help = The addresses to connect.
  parser.add_argument('addresses',nargs = '*',help = help)
 
  help = The filename to operate on.Default is poetry/ecstasy.txt
  parser.add_argument('filename',help=help)
 
  help = The port to listen on. Default to a random available port.
  parser.add_argument('-p',--port', type=int, help=help)
 
  help = The interface to listen on. Default is localhost.
  parser.add_argument('--iface', help=help, default='localhost')
 
  help = The number of seconds between sending bytes.
  parser.add_argument('--delay', type=float, help=help, default=.7)
 
  help = The number of bytes to send at a time.
  parser.add_argument('--bytes', type=int, help=help, default=10)
 
  args = parser.parse_args();
  return args
 
if __name__ == '__main__':
  args = parse_args()
   
  for address in args.addresses:
    print 'The address is : %s .' % address
   
  print 'The filename is : %s .' % args.filename
  print 'The port is : %d.' % args.port
  print 'The interface is : %s.' % args.iface
  print 'The number of seconds between sending bytes : %f'% args.delay
  print 'The number of bytes to send at a time : %d.' % args.bytes</path-to-poetry-file>

運(yùn)行該腳本：python test.py --port 10000 --delay 1.2 127.0.0.1 172.16.55.67 poetry/ecstasy.txt

輸出為：

The address is : 127.0.0.1 .
The address is : 172.16.55.67 .
The filename is : poetry/ecstasy.txt .
The port is : 10000.
The interface is : localhost.
The number of seconds between sending bytes : 1.200000
The number of bytes to send at a time : 10.

最新評(píng)論