python 3 中 argparse 模块的简单应用

简单介绍

argparse 模块是 python 的一个命令行解析包，可以十分方便地对 python 文件进行命令行读写（就是不依靠IDE，只用命令行来操作我们写好的python文件）

argparse 模块是 python 中自带的模块，不需要再安装

简单使用

# 使用前先导入
import argparse
 
if __name__ == '__main__':
 
    # 创建命令行解析器
    parser = argparse.ArgumentParser(description='自定义描述信息，本脚本执行功能为：演示 argparse 模块')
    # 引入必填参数（positional arg），type来帮我们转换接收的参数类型
    # 参数名称不要有前缀（- 或 --）
    parser.add_argument("echo",help='help属性用来提供帮助信息'，type = int)
  
    # 没有横杠‘-’开头的是必填参数，并且按照输入顺序进行设定
    parser.add_argument('positionArg',help='定义必选参数 positionArg')
  
    # --verbosity1：两个横线 -- 开头，指的是变量名或者称为标签
    # -v1：一个横线 - 开头，指的是变量的别名或者标签别名
    parser.add_argument('--verbosity1', '-v1', help='定义可选参数 verbosity1') 
   
    # 定义可选参数 state
    # 设定 action='store_true' 表示该选项不需要接收参数
    # 若不设 action，则默认是需要接收参数的，否则会报错
    parser.add_argument(
        '--state', 
        '-s', 
        action='store_true', 
        help='若有 "-s" ，则 state = Ture,否则 state = False'
    )
     
    # 执行参数的类型
    parser.add_argument(
        '-int',
        '-i', 
        type=int, 
        help='指定参数类型（默认是 str）'
    )
 
    parser.add_argument(
        '-c', 
        help='设置参数的可选值，即输入值必须为 choices 列表中的某个值，若未设置则默认值为 None',
        choices=['one', 'two', 'three', 'four'],
    )
 
    parser.add_argument(
        '--default',
        '-d', 
        help='default 可以设置默认值',
        choices=['one', 'two', 'three', 'four'],
        default = 'one',
    )
  
    # 参数是否必填，使用 required 属性
    parser.add_argument(
        '--required',
        '-r', 
        help='required 的值为：True 或者 False',
        required=True,
    )
  
    # 最后：获取、解析参数的值
    args = parser.parse_args()  # 返回一个命名空间
    print(args)
    params = vars(args)  # 返回字典
    print(params,type(params))

查看 -h 帮助信息

通过命令行python argparsetest.py -h，我们就可以知道设置哪些值来帮助我们运行python文件了

(pytorch(1.2)) E:\02-majorStudy\Python\pytorch-UNet>python argparsetest.py -h
usage: argparsetest.py [-h] [--verbosity1 VERBOSITY1] [--state] [-int INT]
                       [-c {one,two,three,four}]
                       [--default {one,two,three,four}] --required REQUIRED
                       echo positionArg

自定义描述信息，本脚本执行功能为：演示 argparse 模块

positional arguments:
  echo                  help属性用来提供帮助信息
  positionArg           定义必选参数 positionArg

optional arguments:
  -h, --help            show this help message and exit
  --verbosity1 VERBOSITY1, -v1 VERBOSITY1
                        定义可选参数 verbosity1
  --state, -s           若有 "-s" ，则 state = Ture,否则 state = False
  -int INT, -i INT      指定参数类型（默认是 str）
  -c {one,two,three,four}
                        设置参数的可选值，即输入值必须为 choices 列表中的某个值，若未设置则默认值为 None
  --default {one,two,three,four}, -d {one,two,three,four}
                        default 可以设置默认值
  --required REQUIRED, -r REQUIRED
                        required 的值为：True 或者 False

关于位置参数的简单说明

位置参数感觉就是必填参数，位置参数在命令行中的出现和配置顺序，与代码中参数的定义顺序是对应的。如果定义了多个位置参数，命令行输入参数的时候，顺序要与多个参数的定位顺序保持一致！
注意，如果输入的一个值是有空格的情况下，要用引号将值包起来。例如 ‘hello world’

参考文献：
[1]python的官方文档https://docs.python.org/3/howto/argparse.html
[2]https://www.pynote.net/archives/1562
[3]http://www.numberer.net/454.html