Python 超好用標準函式庫 argparse

part 2 在這裡

不管工作或自己電腦，我超愛用 argparse 這個套件。理由無他，因為用了之後可以用 python 簡單地寫出看起來很專業的命令列指令。那今天這篇文章主要就是介紹一下目前為止我常用的功能在幹嘛。

argparse.ArgumentParser

來看看它的樣子:

ArgumentParser(prog=None, usage=None, description=None, epilog=None)

這邊我省略了一些很少用到的 keyword 參數。

• prog : program 的名字，你也可以以把它覆寫成任何你喜歡的字串。以例子來說，假設你是在 example.py 裡用了 ArguemntParser ，而且沒有特別指定 prog 是什麼的話 (也就是保持 None)， prog 會被自動指定成 example.py 。
• usage : 字串，主要是會顯示來告知使用者說應該怎麼使用你寫的 program (也就是 example.py)。保持 None 的話就會自動根據你設定的參數產生相對應的說明字串 (後面會解釋)。
• description : 字串，通常是一段簡短的說明，用來告知使用者說這個程式在做什麼。
• epilog : 字串，會出現在參數說明字串的最後面，通常是一些補充資料。

直接看一個簡單的例子應該就能理解了：

# example.py
from argparse import ArgumentParser
parser1 = ArgumentParser()
parser2 = ArgumentParser(prog="my_example")
parser3 = ArgumentParser(usage="usage")
parser4 = ArgumentParser(description="a simple demo of argparse")
parser5 = ArgumentParser(epilog="see the doc: https://docs.python.org/3/library/argparse.html")
parser1.print_help()
# usage: example.py [-h]
# 
# optional arguments:
#   -h, --help  show this help message and exit
parser2.print_help()
# usage: my_example [-h]
#
# optional arguments:
#   -h, --help  show this help message and exit
parser3.print_help()
# usage: usage
# 
# optional arguments:
#   -h, --help  show this help message and exit
parser4.print_help()
# usage: example.py [-h]
#
# a simple demo of argparse
#
# optional arguments:
#   -h, --help  show this help message and exit
parser5.print_help()
# usage: example.py [-h]
#
# optional arguments:
#   -h, --help  show this help message and exit
# 
# see the doc: https://docs.python.org/3/library/argparse.html

這樣有看出來彼此之間的差別了吧? 其中 -h 這個選擇性參數 (optional argument) 是自動產生的。

加入參數

參數基本上分兩種，一種是位置參數 (positional argument)，另一種就是選擇性參數 (optional argument)，主要差別在於參數指定方式的不同。要說明這個差別，我們要先來介紹怎麼告訴一個 parser 要解析哪些參數？又該以什麼方式解析？

你可以使用 ArgumentParser.add_argument 來加入想解析的參數。用例子說明會比較好懂：

# example2.py
from __future__ import print_function
from argparse import ArgumentParser
parser = ArgumentParser()
parser.add_argument("pos1", help="positional argument 1")
parser.add_argument("-o", "--optional-arg", help="optional argument", dest="opt", default="default")
args = parser.parse_args()
print("positional arg:", args.pos1)
print("optional arg:", args.opt)

如果執行 python example2.py -h 就會出現

usage: example2.py [-h] [-o OPT] pos1
positional arguments:
  pos1                  positional argument 1
optional arguments:
  -h, --help            show this help message and exit
  -o OPT, --optional-arg OPT
                        optional argument
optional argument

看起來很專業吧 XDDD

根據上面的說明，我們執行 python example2.py hello -o world 就會看到：

positional arg: hello
optional arg: world

執行 python example2.py foo 就會看到：

positional arg: foo
optional arg: default

所以說啦，positional argument 顧名思義，就是根據它出現的位置來指定它的值是多少，而 optional argument 與之相反，與位置無關，是根據前綴來指定 (以上面的例子來說，就是 -o 或 --optional-arg 後面跟著是誰就指定是誰)。

有關 add_argument 的一些參數：

• default 可以用來指定這個參數的預設值是多少。
• dest 可以用來指定解析出來的參數的名字。以上面的例子來說，我指定 -o 的 dest 在 opt ，所以我在 parse_args 回傳的 args 下，可以用 args.opt 拿到 -o 的值是多少。

型別

最後用一個例子示範把參數設定成指定的型別。

# example3.py
from __future__ import print_function
from argparse import ArgumentParser
parser = ArgumentParser()
parser.add_argument("n", help="repeat time", type=int)
parser.add_argument("-u", "--user-name", dest="user_name")
args = parser.parse_args()
for _ in range(args.n):
    print("Hello, {}".format(args.user_name))

這個 script 就是會用指定的名稱打招呼很多次 XD。

執行 python example3.py 3 -u Dboy 你會看到：

Hello, Dboy
Hello, Dboy
Hello, Dboy

基本上，所有參數都會以字串的形式給你，但在 add_argument 裡，可以用 type 這個 keyword 去指定回傳的型別。從 source code 來看也沒啥特別的，就是在回傳前把字串傳給指定型別做轉型，以這個例子來說，剛開始的 n 是字串 "3" ，但會透過 int("3") 把它轉型成 int 。

那就先簡單介紹這樣啦。 argparse 還可以有很多進階用法，譬如說設計自己的 type 或 subcommand 之類的，有機會再介紹囉。