argparse 是 Python内置的一个用于命令项选项与参数解析的模块,通过在程序中定义好我们需要的参数,argparse将会从 sys.argv 中解析出这些参数,并自动生成帮助和使用信息。 当然,Python也有第三方的库可用于命令行解析,而且功能也更加强大,比如 docopt, Click。
argparse 使用
简单示例
我们先来看一个简单示例。主要有三个步骤:
1. 创建ArgumentParser()对象
2. 调用add_argument() 方法添加参数
3. 使用parse_args() 解析添加的参数
1 2 3 4 5 6 | import argparse parser = argparse.ArgumentParser() parser.add_argument( 'integer' , type = int , help = 'display an integer' ) args = parser.parse_args() print (args.integer) |
将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | $ python argparse_usage.py usage: argparse_usage.py [ - h] integer argparse_usage.py: error: too few arguments $ python argparse_usage.py abcd usage: argparse_usage.py [ - h] integer argparse_usage.py: error: argument integer: invalid int value: 'abcd' $ python argparse_usage.py - h usage: argparse_usage.py [ - h] integer positional arguments: integer display an integer optional arguments: - h, - - help show this help message and exit $ python argparse_usage.py 10 10 |
定位参数
上面的示例,其实就是展示了定位参数的使用,我们再来看一个例子 - 计算一个数的平方:
1 2 3 4 5 6 7 8 9 | # -*- coding: utf-8 -*- 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 ) |
将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:
1 2 | $ python argparse_usage.py 9 81 |
可选参数
现在看下可选参数的用法,所谓可选参数,也就是命令行参数是可选的,废话少说,看下面例子:
1 2 3 4 5 6 7 8 9 10 11 12 13 | # -*- coding:utf-8 -*- 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 ) |
将上面的代码保存为文件 argparse_usage.py,在终端运行,结果如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | $ python argparse_usage.py - - h usage: argparse_usage.py [ - h] [ - - square SQUARE] [ - - cubic CUBIC] optional arguments: - h, - - help show this help message and exit - - square SQUARE display a square of a given number - - cubic CUBIC display a cubic of a given number $ python argparse_usage.py - - square 8 64 $ python argparse_usage.py - - cubic 8 512 $ python argparse_usage.py 8 usage: argparse_usage.py [ - h] [ - - square SQUARE] [ - - cubic CUBIC] argparse_usage.py: error: unrecognized arguments: 8 $ python argparse_usage.py # 没有输出 |
混合使用
定位参数和选项参数可以混合使用,看下面一个例子,给一个整数序列,输出它们的和或最大值(默认):
1 2 3 4 5 6 7 8 9 | # -*- coding:utf-8 -*- 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' ,const = sum , default = max , help = 'sum the integers (default:find the max)' ) args = parser.parse_args() print (args.accumulate(args.integers)) |
结果:
1 2 3 4 5 6 7 | $ python argparse_usage.py usage: argparse_usage.py [ - h] [ - - sum ] N [N ...] argparse_usage.py: error: too few arguments $ python argparse_usage.py 1 2 3 4 4 $ python argparse_usage.py 1 2 3 4 - - sum 10 |
add_argument() 方法
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 - 解析后的参数名称,默认情况下,对于可选参数选取最大的名称,中划线转换为下划线。
参考资料
本站仅用于个人学习的笔记和记录,有时候是阅读别人的文章的时候做着笔记整理,有些是在实际工作中遇到的问题以及解决小问题的记录。
当前仅用于作为一个萌新程序媛的查漏补缺地检索地。
【推荐】编程新体验,更懂你的AI,立即体验豆包MarsCode编程助手
【推荐】凌霞软件回馈社区,博客园 & 1Panel & Halo 联合会员上线
【推荐】抖音旗下AI助手豆包,你的智能百科全书,全免费不限次数
【推荐】轻量又高性能的 SSH 工具 IShell:AI 加持,快人一步