python--argparse模块

1、背景

        argparse模块是命令行选项、参数和子命令解析器。可以让人轻松编写用户友好的命令行接口。适用于代码需要频繁地修改参数的情况

2、具体用法

1）导入argparse模块：

import argparse

2）创建一个 ArgumentParser 对象，该对象包含将命令行输入内容解析成 Python 数据的过程所需的全部功能。description是该对象的描述信息，可使用python test_argparse.py -h命令查看

parser = argparse.ArgumentParser(description='Calculate volume of a cylinder')

• 3）添加需要输入的命令行参数

parser.add_argument('r', type=int, help='Radius of cycle')

参数依次为：参数名；参数类型，声明这个参数的数据类型为int为了参与运算，默认数据类型为str；描述信息

其它参数解析：

• 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： 解析后的参数名称，默认情况，对于可选参数选取最长的名称，中划线转换为下划线.
   

4）args = parser.parse_args() ArgumentParser 通过 parse_args() 方法解析参数，获取到命令行中输入的参数。 

3、实例一：

import argparse  # 导入argparse模块

# 用来装载参数的容器
parser = argparse.ArgumentParser()
# 给这个解析对象添加命令行参数
parser.add_argument('length', type=int, help='Length of rectangle')
parser.add_argument('weight', type=int, help='Weight of rectangle')
args = parser.parse_args()  # 获取所有参数

def rectangle_arg(length, weight):
    arg = length * weight
    return arg

if __name__ == '__main__':
    print(rectangle_arg(args.length, args.weight))

D:\pythonProject>python ./test_001.py 5 6
30

D:\pythonProject>
 

4、实例二

import argparse

def get_args():
    parser = argparse.ArgumentParser()
    # 给这个解析对象添加命令行参数
    parser.add_argument('-n', dest='n', action='store', help='./py -n
    test_aarch64_glibc_001') # 用例编号
    parser.add_argument('-p', dest='p', action='store', help='./py -p 
    ip,port') # 登录主机的账号信息
    return paser.parse_args()


# 执行时输入：
    python ./test.py -p 10.157.216.83 w119 12352 -n test_aarch64_glibc_001

        在这个函数中，我们使用add_argument方法向ArgumentParser对象中添加了两个参数：-n -p。这些参数分别用于指定用例编号、登录主机的账号信息。每个参数都有一个dest参数，用于指定参数的名称，以及一个action参数，用于指定参数的行为。在这个例子中，我们使用‘action’行为，表示将参数值存储在相应的属性中。

        最后，我们调用parse_args方法来解析命令行参数，并返回解析结果。