python-argparse.ArgumentParser()用法解析

argparse.ArgumentParser()用法解析

argparse是一個Python模塊：命令行選項、參數和子命令解析器。
主要有三個步驟：
創建 ArgumentParser() 對象
調用 add_argument() 方法添加參數
使用 parse_args() 解析添加的參數

1. 創建解析器

parser = argparse.ArgumentParser(description='Process some integers.')

使用 argparse 的第一步是創建一個 ArgumentParser 對象。
ArgumentParser 對象包含將命令行解析成 Python 數據類型所需的全部信息。

2. 添加參數

parser.add_argument('integers', metavar='N', type=int, nargs='+', help='an integer for the accumulator')

3. 解析參數

parser.parse_args(['--sum', '7', '-1', '42'])
Namespace(accumulate= , integers=[7, -1, 42])
1
2
ArgumentParser 對象

class argparse.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, allow_abbrev=True)

prog - 程序的名稱（默認：sys.argv[0]）
usage - 描述程序用途的字符串（默認值：從添加到解析器的參數生成）
description - 在參數幫助文檔之前顯示的文本（默認值：無）
epilog - 在參數幫助文檔之后顯示的文本（默認值：無）
parents - 一個 ArgumentParser 對象的列表，它們的參數也應包含在內
formatter_class - 用於自定義幫助文檔輸出格式的類
prefix_chars - 可選參數的前綴字符集合（默認值：’-’）
fromfile_prefix_chars - 當需要從文件中讀取其他參數時，用於標識文件名的前綴字符集合（默認值：None）
argument_default - 參數的全局默認值（默認值： None）
conflict_handler - 解決沖突選項的策略（通常是不必要的）
add_help - 為解析器添加一個 -h/–help 選項（默認值： True）
allow_abbrev - 如果縮寫是無歧義的，則允許縮寫長選項 （默認值：True）

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

name or flags - 一個命名或者一個選項字符串的列表，例如 foo 或 -f, --foo。
action - 當參數在命令行中出現時使用的動作基本類型。
nargs - 命令行參數應當消耗的數目。
const - 被一些 action 和 nargs 選擇所需求的常數。
default - 當參數未在命令行中出現時使用的值。
type - 命令行參數應當被轉換成的類型。
choices - 可用的參數的容器。
required - 此命令行選項是否可省略 （僅選項可用）。
help - 一個此選項作用的簡單描述。
metavar - 在使用方法消息中使用的參數值示例。
dest - 被添加到 parse_args() 所返回對象上的屬性名。

參數源碼getopt

def usage():
    print('-h help \n' \
          '-v vmname\n' \
          '--VmName=vmname\n' \
          '')


if __name__ == '__main__':
    import getopt
    import sys

    if len(sys.argv) <= 1:
        usage()
        sys.exit()
    try:
        # sys.argv[1:] 取值范圍 "hv:"  ：前的一個字母為必選項 ['VmName='] 參數別名
        options, args = getopt.getopt(sys.argv[1:], "hv:", ['VmName='])
        for name, value in options:
            if name in ('-h'):
                usage()
            if name in ('-v', '--VmName'):
                start(value)
    except getopt.GetoptError:
        usage()
        sys.exit()