argparse · Magic_sword2

[TOC] # 簡介說明 原文鏈接： - [argparse](https://docs.python.org/zh-cn/3.9/library/argparse.html#module-argparse) ``` 版本：argparse 作用：命令行參數解析包 ``` # argparse.ArgumentParser # [new]-ArgumentParser() ***** 創建解析參數對象 ### 參數說明 prog: * 類型：字符串 * 默認值：sys.argv[0] * 描述：程序的名稱 * 可選值：[ ] usage: * 類型：字符串 * 默認值：sys.argv[0] * 描述：描述程序用途的字符串 * 可選值：[ ] description: * 類型：字符串 * 默認值：無 * 描述：在參數幫助文檔之前顯示的文本 * 可選值：[ ] epilog: * 類型：字符串 * 默認值：無 * 描述：在參數幫助文檔之后顯示的文本 * 可選值：[ ] parents: * 類型：列表 * 默認值：無 * 描述：一個 ArgumentParser 對象的列表，它們的參數也應包含在內 * 可選值：[ ] formatter_class: * 類型：argparse.HelpFormatter * 默認值：無 * 描述：用于自定義幫助文檔輸出格式的類 * 可選值：[ ] prefix_chars: * 類型：字符串 * 默認值：\- * 描述：可選參數的前綴字符集合，許多命令行會使用 - 當作前綴，比如 \-f/\-\-foo * 可選值：[ ] fromfile_prefix_chars: * 類型：字符串 * 默認值：無 * 描述：當需要從文件中讀取其他參數時，用于標識文件名的前綴字符集合 * 可選值：[ ] argument_default: * 類型：字符串 * 默認值：無 * 描述：參數的全局默認值，默認情況參數會有None的默認值，想要禁用設置SUPPRESS * 可選值：[ argparse.SUPPRESS ] conflict_handler: * 類型：字符串 * 默認值：error * 描述：解決沖突選項的策略 * 可選值：[ ] add_help: * 類型：布爾 * 默認值：無 * 描述：為解析器添加一個 -h/--help 選項 * 可選值：[ ] allow_abbrev: * 類型：布爾 * 默認值：False * 描述：是否允許識別參數縮寫 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` parser = argparse.ArgumentParser(description='Process some integers.') ``` 2. fromfile_prefix_chars使用方式 ``` >>> with open('args.txt', 'w') as fp: ... fp.write('-f\nbar') >>> parser = argparse.ArgumentParser(fromfile_prefix_chars='@') >>> parser.add_argument('-f') >>> parser.parse_args(['-f', 'foo', '@args.txt']) Namespace(f='bar') ``` # add_argument() ***** 添加操作參數 ### 參數說明 name | flags: * 類型：字符串 * 默認值：無 * 描述：一個命名或者一個選項字符串的列表，例如 foo 或 -f, -\-foo * 可選值：[ ] type: * 類型：obj * 默認值：無 * 描述：命令行參數應當被轉換成的類型 * 可選值：[ ] const: * 類型：字符串 * 默認值：無 * 描述：被一些 action 和 nargs 選擇所需求的常數 * 可選值：[ ] default: * 類型：字符串 * 默認值：無 * 描述：當參數未在命令行中出現時使用的值 * 可選值：[ ] action: * 類型：字符串 * 默認值：store * 描述：當參數在命令行中出現時使用的動作基本類型 * 可選值：[ count | help | extend ] ![action](https://img.kancloud.cn/0c/4f/0c4f50687635c66f62caa227c5a11818_705x1265.png) nargs: * 類型：字符串 * 默認值：無 * 描述：命令行參數應當處理的數目 * 可選值：[ argarse.REMAINDER ] ![nargs](https://img.kancloud.cn/ea/5b/ea5bec2487919f64146d853ff0a48e09_717x1235.png) help: * 類型：字符串 * 默認值：無 * 描述：一個此選項作用的簡單描述 * 可選值：[ ] metavar: * 類型：列表或字符串 * 默認值：無 * 描述：打印幫助時提示的格式，可選參數的占位名稱 * 可選值：[ ] dest: * 類型：字符串 * 默認值：無 * 描述：指定被添加到 parse_args() 所返回對象上的屬性名 * 可選值：[ ] choices: * 類型：列表 * 默認值：無 * 描述：可用的參數的容器 * 可選值：[ ] required: * 類型：布爾 * 默認值：無 * 描述：此命令行選項是否可省略 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` # 直接輸入參數，必須的位置參數 parser.add_argument("echo") # 操作符號參數，可選參數 parser.add_argument("-SV", "--set_version", help="set version", action="store_true", default='1') parser.add_argument("-I", "--number", type=int, help="get number", choices=[0, 1, 2]) ``` # add_subparsers() ***** 添加子命令 ### 返回類型 ``` _SubParsersAction ``` ### 參數說明 title: * 類型：字符串 * 默認值：無 * 描述：幫助輸出中子解析器組的標題 * 可選值：[ ] description: * 類型：字符串 * 默認值：無 * 描述：幫助輸出中子解析器組的描述 * 可選值：[ ] prog: * 類型：字符串 * 默認值：無 * 描述：用法信息將與子命令幫助一起顯示 * 可選值：[ ] parser_class: * 類型：Parser * 默認值：無 * 描述：用于創建子解析器實例的類 * 可選值：[ ] action: * 類型：字符串 * 默認值：無 * 描述：默認執行動作 * 可選值：[ ] dest: * 類型：字符串 * 默認值：無 * 描述：屬性名 * 可選值：[ ] required: * 類型：布爾 * 默認值：無 * 描述：是否必須 * 可選值：[ ] help: * 類型：字符串 * 默認值：無 * 描述：一個此選項作用的簡單描述 * 可選值：[ ] metavar: * 類型：列表或字符串 * 默認值：無 * 描述：打印幫助時提示的格式 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` import argparse def install_callback(path): print("install", path) parser = argparse.ArgumentParser(prog='PROG') subparsers = parser.add_subparsers(help='sub-command help') # 添加子命令 add parser_a = subparsers.add_parser('add', help='add help') parser_a.add_argument('-x', type=int, help='x value') parser_a.add_argument('-y', type=int, help='y value') # 添加子命令 sub parser_s = subparsers.add_parser('sub', help='sub help') parser_s.add_argument('-x', type=int, help='x value') parser_s.add_argument('-y', type=int, help='y value') install = subparsers.add_parser("install") install.set_defaults(cb=install_callback) install.add_argument("path") args = parser.parse_args(["install", "hardoor"]) args.cb(args.path) ``` # add_argument_group() ***** 僅僅是概念上的分組，獲取時候并不能安裝組名獲取 ### 參數說明 title: * 類型：字符串 * 默認值：無 * 描述：組名 * 可選值：[ ] description: * 類型：字符串 * 默認值：無 * 描述：描述作用的內容 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` >>> parser = argparse.ArgumentParser(prog='PROG', add_help=False) >>> group = parser.add_argument_group('group') >>> group.add_argument('--foo', help='foo help') >>> group.add_argument('bar', help='bar help') >>> parser.print_help() usage: PROG [--foo FOO] bar group: bar bar help --foo FOO foo help ``` # add_mutually_exclusive_group() ***** 添加互斥操作參數組 ### 示例內容 1. 舉例說明 ``` # 添加操作參數 group = parser.add_mutually_exclusive_group() # 互斥參數組 group.add_argument("-v", "--verbose", action="store_true") group.add_argument("-q", "--quiet", action="store_true") ``` # set_defaults() ***** 設置默認屬性值 ### 示例內容 1. 舉例說明 ``` parser = argparse.ArgumentParser() parser.add_argument('foo', type=int) parser.set_defaults(bar=42, baz='badger') parser.parse_args(['736']) 輸出結果： Namespace(bar=42, baz='badger', foo=736) ``` # get_default() ***** 獲取默認屬性值 ### 示例內容 1. 舉例說明 ``` parser = argparse.ArgumentParser() parser.add_argument('--foo', default='badger') parser.get_default('foo') 輸出結果： 'badger' ``` # format_usage() ***** 定義usage信息格式 # format_help() ***** 定義help信息格式 # print_help() ***** 打印幫助信息 # print_usage() ***** 打印有關應如何在命令行上調用ArgumentParser的簡要說明 # exit() ***** 此方法將終結程序，退出時附帶指定的 status，并且如果給出了 message 則會在退出前將其打印輸出 # error() ***** 此方法將向標準錯誤打印包括 message 的用法消息并附帶狀態碼 2 終結程序 # parse_known_args() ***** 前綴解析，使用該解析模式產生額外參數會加入一個額外列表而不會報錯 # parse_args() ***** 解析參數內容，并返回 ### 參數說明 args: * 類型：字符串 * 默認值：sys.argv * 描述：要解析的字符串列表 * 可選值：[ ] namespace: * 類型：namespace * 默認值：store * 描述：帶有屬性的對象。默認值為一個新的空命名空間對象。 * 可選值：[ ] ### 示例內容 1. 舉例說明 ``` content = parser.parse_args() 獲取解析內容，如--number的內容 print(content.number) ``` # parse_known_intermixed_args() ***** 混雜解析已知參數 # parse_intermixed_args() ***** 混雜解析 # argparse.FileType # [new]-FileType() ***** FileType對象 ### 示例內容 1. 舉例說明 ``` parser.add_argument('--raw', type=argparse.FileType('wb', 0)) parser.add_argument('out', type=argparse.FileType('w', encoding='UTF-8')) parser.parse_args(['--raw', 'raw.dat', 'file.txt']) ``` # argparse.RawDescriptionHelpFormatter # [new]-RawDescriptionHelpFormatter() ***** 可選格式風格，在正文的描述和展示上給與了更多的控制 # argparse.RawTextHelpFormatter # [new]-RawTextHelpFormatter() ***** 可選格式風格，在正文的描述和展示上給與了更多的控制 # argparse.ArgumentDefaultsHelpFormatter # [new]-ArgumentDefaultsHelpFormatter() ***** 可選格式風格，自動添加默認的值的信息到每一個幫助信息的參數中 # argparse.MetavarTypeHelpFormatter # [new]-MetavarTypeHelpFormatter() ***** 可選格式風格，為它的值在每一個參數中使用 type 的參數名當作它的顯示名