Python學習筆記之argparse高級使用

       在有些開發中，尤其是小工具中，有時會用到命令行輸入，那怎麼樣把命令行輸入做的美觀，顯得高大上呢。

如下所示，請仔細看註釋說明：

# -*- coding: utf-8 -*-

import argparse

_args1 = "-f hello.txt -n 1 2 3 -x 100 -y b -z a -q hello".split()
_args2 = "@args.txt i_am_bar".split()
_args3 = "-h".split()

# 使用@args.txt要求fromfile_prefix_chars="@"
# args.txt文件中應該一行一個參數，想改變行爲參考convert_arg_line_to_args()


# ArgumentParser參數的簡單說明
## description - 命令行幫助的開始文字，大部分情況下，我們只會用到這個參數
# epilog - 命令行幫助的結尾文字
# prog - (default: sys.argv[0])程序的名字，一般不需要修改，另外，如果你需要在help中使用到程序的名字，可以使用%(prog)s
# prefix_chars - 命令的前綴，默認是-，例如-f/--file。有些程序可能希望支持/f這樣的選項，可以使用prefix_chars="/"
# fromfile_prefix_chars - (default: None)如果你希望命令行參數可以從文件中讀取，就可能用到。例如，如果fromfile_prefix_chars='@',命令行參數中有一個爲"@args.txt"，args.txt的內容會作爲命令行參數
# add_help - 是否增加-h/-help選項 (default: True)，一般help信息都是必須的，所以不用設置啦。
##  parents - 類型是list，如果這個parser的一些選項跟其他某些parser的選項一樣，可以用parents來實現繼承，例如parents=[parent_parser]
## formatter_class - 自定義幫助信息的格式（description和epilog）。默認情況下會將長的幫助信息進行<自動換行和消除多個連續空白>。
# 三個允許的值：
# class argparse.RawDescriptionHelpFormatter 直接輸出description和epilog的原始形式（不進行自動換行和消除空白的操作）
# class argparse.RawTextHelpFormatter 直接輸出description和epilog以及add_argument中的help字符串的原始形式（不進行自動換行和消除空白的操作）
## class argparse.ArgumentDefaultsHelpFormatter 在每個選項的幫助信息後面輸出他們對應的缺省值，如果有設置的話。這個最常用吧！
# argument_default - (default: None)設置一個全局的選項的缺省值，一般每個選項單獨設置，所以這個參數用得少，不細說
# usage - (default: generated)如果你需要修改usage的信息（usage: PROG [-h] [--foo [FOO]] bar [bar ...]），那麼可以修改這個，一般不要修改。
# conflict_handler - 不建議使用。這個在極端情況下才會用到，主要是定義兩個add_argument中添加的選項的名字發生衝突時怎麼處理，默認處理是拋出異常。
# 註釋一行有##表示這幾個參數比較常用
parser = argparse.ArgumentParser(description="This is a description of %(prog)s", epilog="This is a epilog of %(prog)s",
                                 prefix_chars="-+", fromfile_prefix_chars="@",
                                 formatter_class=argparse.ArgumentDefaultsHelpFormatter)

# ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
# add_argument的參數是比較複雜的。。。

# name or flags - 指定參數的形式，想寫幾個寫幾個，不過我們一般就寫兩個，一個短參數，一個長參數，看下面的例子"-f", "--file"
# 可選的選項，位置不固定，想怎麼寫就怎麼寫，默認是可選的
parser.add_argument("-f", "--file", help="test test test")
# 位置固定的選項，例如"prog i_am_bar"，這樣子的話，i_am_bar就是bar選項的值啦，默認是必須有的
parser.add_argument("bar", help="test test test")

# nargs - 指定這個參數後面的value有多少個，例如，我們希望使用-n 1 2 3 4，來設置n的值爲[1, 2, 3, 4]
parser.add_argument("-n", "--num", nargs="+", type=int)
# 這裏nargs="+"表示，如果你指定了-n選項，那麼-n後面至少要跟一個參數，+表示至少一個,?表示一個或0個,*0個或多個，

# default - 如果命令行沒有出現這個選項，那麼使用default指定的默認值
parser.add_argument("+g", "++gold", help="test test test", default="test_gold")  # 需要prefix_chars包含"+"

# type - 如果希望傳進來的參數是指定的類型（例如 float, int or file等可以從字符串轉化過來的類型），可以使用
parser.add_argument("-x", type=int)

# choices - 設置參數值的範圍，如果choices中的類型不是字符串，記得指定type哦
parser.add_argument("-y", choices=['a', 'b', 'd'])

# required - 通常-f這樣的選項是可選的，但是如果required=True那麼就是必須的了
parser.add_argument("-z", choices=['a', 'b', 'd'], required=True)

# metavar - 參數的名字，在顯示 幫助信息時纔用到.
parser.add_argument("-o", metavar="OOOOOO")

# help - 設置這個選項的幫助信息
# dest - 設置這個選項的值就是解析出來後放到哪個屬性中
parser.add_argument("-q", dest="world")

# _argsx：_args1，_args2，_args3
args = parser.parse_args(_argsx)  
# 如果你沒有args參數，那麼就使用sys.argv，也就是命令行參數啦。有這個參數，就方便我們調試啊
# args.world就是-q的值啦

# action - The basic type of action to be taken when this argument is encountered at the command line.
# const - A constant value required by some action and nargs selections.
# 這兩個自己看幫助文檔啦，比較複雜
# http://docs.python.org/library/argparse.html

print(args)

文中對每種類型的參數形式都進行了說明，請自行參考使用：

在裏面應該注意到到了。
 

# _argsx：_args1，_args2，_args3
args = parser.parse_args(_args1)
args = parser.parse_args(_args2) 

返回都是一樣：

"D:\Program Files\Python37\python.exe" I:/mySVN/pytools/lesson_args.py
usage: lesson_args.py [-h] [-f FILE] [-n NUM [NUM ...]] [+g GOLD] [-x X]
                      [-y {a,b,d}] -z {a,b,d} [-o OOOOOO] [-q WORLD]
                      bar
lesson_args.py: error: the following arguments are required: bar

_args2 = @args.txt 比較特別，其實跟命令輸入一樣的；

如下所示，參數按行輸入就行：

而使用：

args = parser.parse_args(_args3) 

返回請看如下所示：

"D:\Program Files\Python37\python.exe" I:/mySVN/pytools/lesson_args.py
usage: lesson_args.py [-h] [-f FILE] [-n NUM [NUM ...]] [+g GOLD] [-x X]
                      [-y {a,b,d}] -z {a,b,d} [-o OOOOOO] [-q WORLD]
                      bar

This is a description of lesson_args.py

positional arguments:
  bar                   test test test

optional arguments:
  -h, --help            show this help message and exit
  -f FILE, --file FILE  test test test (default: None)
  -n NUM [NUM ...], --num NUM [NUM ...]
  +g GOLD, ++gold GOLD  test test test (default: test_gold)
  -x X
  -y {a,b,d}
  -z {a,b,d}
  -o OOOOOO
  -q WORLD

This is a epilog of lesson_args.py