Python的命令行参数（argparse）

时间：2023-12-25 22:26:02

参考：https://www.cnblogs.com/lindaxin/p/7975697.html

参考：https://www.cnblogs.com/dengtou/p/8413609.html

简单示例：

import argparse

parser = argparse.ArgumentParser()

parser.add_argument('integer', type=int, help='display an integer')

args = parser.parse_args()

print(args.integer)

保存为py脚本，终端运行-h，输出结果如下：

Python的命令行参数（argparse）

若添加int类型数据，输出结果如下：

Python的命令行参数（argparse）

定位参数：

import argparse

parser = argparse.ArgumentParser()

parser.add_argument("square", help="display a square of a given number", type=int)

args = parser.parse_args()

print(args.square**2)

由于如上读取参数args.square，那么在终端命令行后加入参数，输出结果如下：

Python的命令行参数（argparse）

可选参数：

import argparse

parser = argparse.ArgumentParser()

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()

if args.square:

    print(args.square**2)

if args.cubic:

    print(args.cubic**3)

通过选择命令行参数类型来进行计算：

选择参数：--square

Python的命令行参数（argparse）

选择参数：--cubic

Python的命令行参数（argparse）

若未进行参数选择，则会报错：

Python的命令行参数（argparse）

混合使用（定位参数和选项参数混合使用）：

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')

parser.add_argument('integers', metavar='N', type=int, nargs='+',

                   help='an integer for the accumulator')

parser.add_argument('--sum', dest='accumulate', action='store_const',       #默认为取最大值，加上命令参数--sum 则为求和

                   const=sum, default=max,

                   help='sum the integers (default: find the max)')

args = parser.parse_args()

print(args.accumulate(args.integers))

命令行显示

Python的命令行参数（argparse）

读取最大值：

Python的命令行参数（argparse）

求和：

Python的命令行参数（argparse）

tip: parameter和argument的区别，做如下的简单说明。
　　1. parameter是指函数定义中参数，而argument指的是函数调用时的实际参数。
　　2. 简略描述为：parameter=形参(formal parameter)， argument=实参(actual parameter)

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

相关文章