argparse模組

在每個 add_argument() 呼叫中，dest 引數指定解析結果被指派給屬性的名字。 metavar 引數被用來生成幫助資訊。action 引數指定跟屬性對應的處理邏輯， 通常的值為 store ,被用來儲存某個值或將多個引數值收集到一個列表中。

# search.py
'''
Hypothetical command-line tool for searching a collection of
files for one or more text patterns.
'''
import argparse
parser = argparse.ArgumentParser(description='Search some files')

parser.add_argument(dest='filenames',metavar='filename', nargs='*')

parser.add_argument('-p', '--pat',metavar='pattern', required=True,
                    dest='patterns', action='append',
                    help='text pattern to search for')

parser.add_argument('-v', dest='verbose', action='store_true',
                    help='verbose mode')

parser.add_argument('-o', dest='outfile', action='store',
                    help='output file')

parser.add_argument('--speed', dest='speed', action='store',
                    choices={'slow','fast'}, default='slow',
                    help='search speed')

args = parser.parse_args()

# Output the collected arguments
print(args.filenames)
print(args.patterns)
print(args.verbose)
print(args.outfile)
print(args.speed)
 

下面的引數收集所有剩餘的命令列引數到一個列表中：

parser.add_argument(dest='filenames',metavar='filename', nargs='*')

下面的引數根據引數是否存在來設定一個 Boolean 標誌：

parser.add_argument('-v', dest='verbose', action='store_true',
                    help='verbose mode')

下面的引數接受一個單獨值並將其儲存為一個字串：

parser.add_argument('-o', dest='outfile', action='store',
                    help='output file')
 

下面的引數說明允許某個引數重複出現多次，並將它們追加到一個列表中去。 required 標誌表示該引數至少要有一個。-p 和 --pat 表示兩個引數名形式都可使用。

parser.add_argument('-p', '--pat',metavar='pattern', required=True,
                    dest='patterns', action='append',
                    help='text pattern to search for')

最後，下面的引數說明接受一個值，但是會將其和可能的選擇值做比較，以檢測其合法性：

parser.add_argument('--speed', dest='speed', action='store',
                    choices={'slow','fast'}, default='slow',
                    help='search speed')

一旦引數選項被指定，你就可以執行 parser.parse() 方法了。 它會處理 sys.argv 的值並返回一個結果例項。 每個引數值會被設定成該例項中 add_argument() 方法的 dest 引數指定的屬性值。