python3 使用argparse更

发布时间:2019-10-16 17:29:57编辑:auto阅读(781)

    问题与现状

    通常情况下,我们都会使用sys.argv[n]这样的手段来获取python脚本的输入参数。这样做的缺点如下:
    1 参数输入和获取必须严格按照顺序
    2 在获取参数的同时需要写一点额外的代码对输入参数进行简单的合法性检查
    3 在输入参数过多(通常情况下项目构建时入参很多,尤其是当各个脚本解耦充分的情况下)导致向其他函数传递的参数过多,而通常一个函数的参数最好不要超过7个
    4 如果该python脚本是对外发布给别人用的,则用户不清楚该脚本如何使用,必须在readme文档说明,而每次查看readme文档对用户来说过于繁琐。


    用argparse优雅的组织输入参数

    优势:
    1 不需要安装,直接import argparse即可
    2 使用简单,基本用法如下:

    def get_args():
        parser = argparse.ArgumentParser(description="this is a calculator")  # 脚本描述
        parser.add_argument('--num1', help="input num1")  # add_argument()指定程序可以接受的命令行选项
        parser.add_argument('--num2', help="input num2")  # add_argument()指定程序可以接受的命令行选项
        parser.add_argument('--et', help="excute type", choices=["+", "-"])  #choices 用于约束用户行为
        args = parser.parse_args()
        return args

    3 使用方法对用户友好,可以通过默认的--help查看脚本的简单使用方法

    python argparse_test.py --help
    usage: argparse_test.py [-h] [--num1 NUM1] [--num2 NUM2] [--et {+,-}]
    
    this is a calculator
    
    optional arguments:
      -h, --help   show this help message and exit
      --num1 NUM1  input num1
      --num2 NUM2  input num2
      --et {+,-}   excute type

    4 参数传递简单,只用传递args这个对象,并且通过.操作符就可以获取到输入参数,例如args.et

关键字