python - argparse 模块学习

python - argparse 模块学习

 

设置一个解析器

使用argparse的第一步就是创建一个解析器对象，并告诉它将会有些什么参数。那么当你的程序运行时，该解析器就可以用于处理命令行参数。

解析器类是 ArgumentParser 。构造方法接收几个参数来设置用于程序帮助文本的描述信息以及其他全局的行为或设置。

# 实例化ArgumentParser，ArgumentParser 是argparse 的一个类,而该类有两个基类
# parser = argparse.ArgumentParser()

# add_argument() 是其基类 _ActionsContainer 的方法，这里继承使用
# parser.add_argument()

 import argparse

 parser = argparse.ArgumentParser(description='manual to this script') 
 parser.add_argument('--appId', type=str, help='ops_user_client app_id column')
 parser.add_argument('--data', type=str, help='request the http restfull api params')
 parser.add_argument('--appKey', type=str, help='ops_user_client app_key column')

定义参数

argparse是一个全面的参数处理库。参数可以触发不同的动作，动作由 add_argument() 方法的 action 参数指定。 支持的动作包括保存参数（逐个地，或者作为列表的一部分），当解析到某参数时保存一个常量值（包括对布尔开关真/假值的特殊处理），统计某个参数出现的次数，以及调用一个回调函数。

默认的动作是保存参数值。在这种情况下，如果提供一个类型，那么在存储之前会先把该参数值转换成该类型。如果提供 dest 参数，参数值就保存为命令行参数解析时返回的命名空间对象中名为该 dest 参数值的一个属性。

解析一个命令行

定义了所有参数之后，你就可以给 parse_args() 传递一组参数字符串来解析命令行。默认情况下，参数是从 sys.argv[1:] 中获取，但你也可以传递自己的参数列表。选项是使用GNU/POSIX语法来处理的，所以在序列中选项和参数值可以混合。

parse_args() 的返回值是一个命名空间，包含传递给命令的参数。该对象将参数保存其属性，因此如果你的参数 dest 是 "myoption"，那么你就可以args.myoption 来访问该值。

 

# 解析命令行参数 返回解析后的信息
args = parser.parse_args()

# 返回 Namespace(appId='ggdfFRnf4UsuQfgAAk9nAA==', appKey='zXKoeppLgNL3Ii0vbibs2g==', \
# data='\'{"supplierSn":"748307065314700","itemOuterId":"10200009","outUserId":"DWI00006671"}\'')

print  args

print args.appId  # ggdfFRnf4UsuQfgAAk9nAA==

print args.data   # '{"supplierSn":"748307065314700","itemOuterId":"10200009","outUserId":"DWI00006671"}'