开发者

Python之parser.add_argument解读

开发者 https://www.devze.com 2023-02-04 09:25 出处:网络 作者: Nicola-Zhang
目录python parser.add_argument1.Python解析参数2.parser.add_argument参数actionPython parser.add_argument函数及sys.argv[]1.argparse2.步骤3.add_argument() 命令行参数4.sys.argv[]总结Python parser.add_argu
目录
  • python parser.add_argument
    • 1.Python解析参数
    • 2.parser.add_argument参数action
  • Python parser.add_argument函数及sys.argv[]
    • 1.argparse
    • 2.步骤
    • 3.add_argument() 命令行参数
    • 4.sys.argv[]
  • 总结

    Python parser.add_argument

    1.Python解析参数

    import argparse
    
    parser = argparse.ArgumentP开发者_JAVA学习arser(description = 'TEST')
    parser.add_argument ('--start-epoch', default = 0, type = int, help = 'please input number')
    
    def main():
      global args
      args = parser.parse_args()
    
      print(args)
      print(args.start_epoch)
    
    if __name__ == '__main__':
      main()

    注:在参数解析时,参数中并不区分字符‘-’和‘_’;如上所述,在添加是使用的是’–start-epoch’,但是在解析时使用的是args.start_epoch。

    2.parser.add_argument参数action

    在使用parser进行传参时,遇到参数action,一直不得其解,终有所获,解释如下:

    parser.add_argument(‘--is_train', action='store_true', default=False)

    其中“–is_train”参数在调用时,如下:

    python demo1.py       #无参数传入时,使用默认值False
    python demo1.py --is_train   #当使用此参数时,表示该参数是True, 注意在这里并没有对其赋值,
                 #其作用是作为开关使用,来控制action动作

    Python parser.add_argument函数及sys.argv[]

    1.argparse

    argparse 模块是 Python 内置的javascript一个用于命令项选项与参数解析的模块,argparse 模块可以让js人轻松编写用户友好的命令行接口。

    通过在程序中定义好我们需要的参数,然后 argparse 将会从 sys.argv 解析出这些参数。

    argparse 模块还会自动生成帮助和使用手册,并在用户给程序传入无效参数时报出错误信息。

    2.步骤

    1、创建一个解析器——创建 ArgumentParser() 对象

    parser = argparse.ArgumentParser(description='PyTorch ImageNet Training')

    变量名为parser,ArgumentParser 对象包含将命令行解析成 编程Python 数据类型所需的全部信息。

    关键词description:

    description= '关键字参数'

    这个参数简要描述这个程度做什么以及怎么做。在帮助消息中,这个描述会显示在命令行用法字符串和各种参数的帮助消息之间。

    2、添加参数——调用 add_argument() 方法添加参数

    调用 add_argument() 给程序添加参数信息。这些调用指定 ArgumentParser 如何获取命令行字符串并将其转换为对象。

    常用的有,

    parser.add_argument('data', metavar='DIR',help='path to dataset') # 设置数据路径
    parser.add_argument('--epochs', default=200, type=int, metavar='N', # 训练循环最高次数
              help='number of total epochs to run')
    parser.add_argument('--lr', '--learning-rate', default=0.03, type=float, # 学习率
              metavar='LR', help='initial learning rate', dest='lr')
    parser.add_argument('--seed', default=None, type=int,
              help='seed for initializing training. ') # 用于指定随机数生成时所用算法开始的整数值

    3、解析参数——使用 parse_args() 解析添加的参数

    ArgumentParser 通过 parse_args() 方法解析参数。它将检查命令行,把每个参数转换为适当的类型然后调用相应的操作。

    在大多数情况下,这意味着一个简单的 Namespace 对象将从命令行解析出的属性构建。

    args = parser.parse_args()

    3.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 - 命令行遇到参数时的动作,默认值是 store。
    • store_const,表示赋值为const;
    • append,将遇到的值存储成列表,也就是如果参数重复则会保存多个值;
    • append_const,将参数规范中定义的一个值保存到一个列表;
    • count,存储遇到的次数;此外,也可以继承 argparse.Action 自定义参数解析;
    • nargs - 应该读取的命令行参数个数,可以是具体的数字,或者是?号,当不指定值时对于 Positional argument 使用 default,对于 编程Optional argument 使用 const;或者是 * 号,表示 0 或多个参数;或者是 + 号表示 1 或多个参数。
    • default - 不指定参数时的默认值。
    • type - 命令行参数应该被转换成的类型。
    • choices - 参数可允许的值的一个容器。
    • required - 可编程客栈选参数是否可以省略 (仅针对可选参数)。
    • help - 参数的帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
    • metavar - 在 usage 说明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称。用来控制部分命令行参数的显示,注意:它只是影响部分参数的显示信息,不影响代码内部获取命令行参数的对象。
    • dest - 解析后的参数名称,默认情况下,对于可选参数选取最长的名称,中划线转换为下划线.

    4.sys.argv[]

    是一个从程序外部获取参数的桥梁,获得的是一个列表(list),其第一个元素是程序本身,随后才依次是外部给予的参数。

    sys.argv[0]

    对应的是程序本身,即xxx.py,xxx表示程序的名称。

    sys.argv[1]

    表示命令行外部输入的第一个参数。

    sys.argv[1:]

    表示遍历外部输入参数的所有。

    总结

    以上为个人经验,希望能给大家一个参考,也希望大家多多支持我们。

    0

    精彩评论

    暂无评论...
    验证码 换一张
    取 消

    关注公众号