如何在Python中使用argparse模塊

本篇文章為大家展示了如何在Python中使用argparse模塊，內容簡明扼要并且容易理解，絕對能使你眼前一亮，通過這篇文章的詳細介紹希望你能有所收獲。

如果腳本很簡單或臨時使用，沒有多個復雜的參數選項，可以直接利用sys.argv將腳本后的參數依次讀取(讀進來的默認是字符串格式)。比如如下名為test.py的腳本：

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

在shell腳本中運行python test.py help可以得到Input argument is help的結果。

1) 一般形式

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

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

import argparse

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

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

$ 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) 必需參數

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

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

required標簽就是說--verbose參數是必需的，并且類型為int，輸入別的類型會報錯。

3）位置參數（positional arguments）

位置參數與sys.argv調用比較像，參數沒有顯式的--xxx或者-xxx標簽，因此調用屬性也與sys.argv相同。

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

輸入python test.py test.txt則會輸出Read in test.txt

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

比如用：

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

就可以運行python test.py text.txt 1 2

由于沒有標簽，所以用位置參數的時候需要比較小心。

4）輸入類型

之前已經提到了用type參數就可以指定輸入的參數類型。而這個type類型還可以表示文件操作的類型從而直接進行文件的讀寫操作。

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

5）參數默認值

一般情況下會設置一些默認參數從而不需要每次輸入某些不需要變動的參數，利用default參數即可實現。

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

這個時候至直接運行python text.py就能得到Read in text.txt而不需要輸入文件名了。

6）候選參數選擇

表示該參數能接受的值只能來自某幾個值候選值中，除此以外會報錯，用choices參數即可。比如：

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

參考：

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

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

以下是其他網友的補充：

一、簡介：

argparse是python用于解析命令行參數和選項的標準模塊，用于代替已經過時的optparse模塊。argparse模塊的作用是用于解析命令行參數，例如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()

解釋：首先導入該模塊；然后創建一個解析對象；然后向該對象中添加你要關注的命令行參數和選項，每一個add_argument方法對應一個你要關注的參數或選項；最后調用parse_args()方法進行解析；解析成功之后即可使用，下面簡單說明一下步驟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)

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

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

其中：

name or flags：命令行參數名或者選項，如上面的address或者-p,--port.其中命令行參數如果沒給定，且沒有設置defualt，則出錯。但是如果是選項的話，則設置為None

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

default：默認值

type：參數的類型，默認是字符串string類型，還有float、int等類型

help：和ArgumentParser方法中的參數作用相似，出現的場合也一致

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

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>

運行該腳本：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.

上述內容就是如何在Python中使用argparse模塊，你們學到知識或技能了嗎？如果還想學到更多技能或者豐富自己的知識儲備，歡迎關注億速云行業資訊頻道。