python: argparse库 & 命令行解析工具

2018-09-27 17:13:26 浏览数 (1)

API

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 或多个参数。
  • const - action 和 nargs 所需要的常量值。
  • default - 不指定参数时的默认值。
  • type - 命令行参数应该被转换成的类型。
  • choices - 参数可允许的值的一个容器。
  • required - 可选参数是否可以省略 (仅针对可选参数)。
  • help - 参数的帮助信息,当指定为 argparse.SUPPRESS 时表示不显示该参数的帮助信息.
  • metavar - 在 usage 说明中的参数名称,对于必选参数默认就是参数名称,对于可选参数默认是全大写的参数名称.
  • dest - 解析后的参数名称,默认情况下,对于可选参数选取最长的名称,中划线转换为下划线.

实验代码

1.py:

代码语言:javascript复制
import argparse

parser = argparse.ArgumentParser()

parser.add_argument('integer', type=int, help='display an integer')
parser.add_argument("--square", help="display a square of a given number", type=int)
parser.add_argument("--cubic", help="display a cubic of a given number", type=int)

args = parser.parse_args()

print args.integer
if args.square:
    print args.square**2
if args.cubic:
    print args.cubic**3

bash:

代码语言:javascript复制
$ python 1.py 10 --square=2 --cubic=3
10
4
27


Ref:

  • argparse 使用
  • argparse - 命令行选项与参数解析(译)
  • Argparse简易教程
  • python argparse用法总结


0 人点赞