文章目录
- 前言
- 一、一个例子
- 二、可选参数
- 混合使用
前言
今天来学习命令行参数解析。我们主要学习的是一个标准库----argparse。
argparse 是 Python 内置的一个用于命令项选项与参数解析的模块，通过在程序中定义好我们需要的参数，argparse 将会从 sys.argv 中解析出这些参数，并自动生成帮助和使用信息。当然，Python 也有第三方的库可用于命令行解析，而且功能也更加强大，比如 docopt,Click。
一、一个例子
我们先看一个例子。
# -*- coding: utf-8 -*-
import argparse
parser = argparse.ArgumentParser()
parser.add_argument('integer', type=int, help='display an integer')
args = parser.parse_args()
print(args.integer)我们直接运行上面的代码。
D:\Users\Administrator\PycharmProjects\LeetCodePracitse\venv\Scripts\python.exe D:/Users/Administrator/PycharmProjects/LeetCodePracitse/demo1.py
usage: demo1.py [-h] integer
demo1.py: error: the following arguments are required: integer
Process finished with exit code 2会报上如错误。
对于这种带命令行参数解析的代码，我们的运行方式是不能直接运行的。
我们要在终端运行。
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py 10
10
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py -h
usage: demo1.py [-h] integer
positional arguments:
integer display an integer
optional arguments:
-h, --help show this help message and exit
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>二、可选参数
# -*- 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)我们在添加参数的时候，参数的属性我们可以通过–设置为可选的。我们再来运行上面的代码的时候就不是必须要输入对应的参数了，这两个参数就变成了可选参数，但是有一点需要注意，可选参数都是随意搭配使用但是不能和-h、–help一起使用。
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py --cubic -h
usage: demo1.py [-h] [--square SQUARE] [--cubic CUBIC]
demo1.py: error: argument --cubic: expected one argument
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py --cubic 10 -h
usage: demo1.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
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py --cubic 10
1000
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py --cubic 10 --square 9
81
1000
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>上面展示了一种是位置参数，一种是可选参数，位置参数是在运行脚本的时候必须给的，这个位置参数可以直接给值就可以了，还有就是可选参数，可选参数是必须在参数选项后面跟上对应的值才可以。
混合使用
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)运行结果。
Microsoft Windows [版本 6.1.7601]
版权所有 (c) 2009 Microsoft Corporation。保留所有权利。
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py 10
10
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py 10 --sum
10
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>python demo1.py 10 11 --sum
21
(venv) D:\Users\Administrator\PycharmProjects\LeetCodePracitse>我们可以看到我们上面给了多个位置参数，和一个可选参数。这是因为我们在add_argument的时候里面的方法设置的原因。
下面说说add_argument的方法。
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 - 解析后的参数名称，默认情况下，对于可选参数选取最长的名称，中划线转换为下划线.
这里我们支持输入多个位置参数就是因为 nargs 选项 - 应该读取的命令行参数个数，可以是具体的数字，或者是?号，当不指定值时对于 Positional argument 使用 default，对于 Optional argument 使用 const；或者是 * 号，表示 0 或多个参数；或者是 + 号表示 1 或多个参数。
