argparse 的使用

原创已于 2024-07-01 23:58:58 修改 · 1.4k 阅读

24 ·

CC 4.0 BY-SA版权

文章标签：

#python

于 2024-07-01 23:40:23 首次发布

argparse是一个用来解析命令行参数的 Python 库

1、简单使用

导入argparse包
创建ArgumentParser()对象
调用add_argument()方法往参数对象中添加参数
使用parse_args()解析参数，把每个参数转换为适当的类型然后调用相应的操作，获得解析对象
程序其他部分，当需要使用命令行参数时，使用解析对象.参数获取

2、`add_argument()`的参数

可选参数：前面含有-或者--的参数。
位置参数：也就是必选参数，前面没有-和--。可选和位置参数顺序无关紧要。
--help：缩写-h：帮助，表明该参数的含义。
--dest：默认情况下，argparse会根据定义的参数名称来自动生成属性名称。例如，定义了一个选项 --foo，那么解析后的结果命名空间中会有一个args.foo属性。使用dest参数，可以自定义这个属性名称。如dest='foo1'，则可以使用args.foo1。
type：表明输入该参数的类型是什么。

# prog.py
# 一个位置参数square，类型为int，输出所给数的平方
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)

输出：

# 命令行中的输入和输出
python prog.py 4
# 16    输出
python prog.py four
# usage: prog.py [-h] square    输出
# prog.py: error: argument square: invalid int value: 'four'  输出

action="store_true"：选用该参数时，值为True。
短选项：指定某参数的缩写。

# prog.py
# 可选参数--verbose，短选项为-v，作用为输出详细信息，选用时值为True
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity",action="store_true")
args = parser.parse_args()
if args.verbose:
    print("verbosity turned on")

输出：

# 命令行中的输入和输出
python prog.py -v
# verbosity turned on
python prog.py --help
# usage: prog.py [-h] [-v]

#options:
#  -h, --help     show this help message and exit  
#  -v, --verbose  increase output verbosity

choices：限定参数的取值范围。

# prog.py
# 位置参数square
# 可选参数--verbosity，值类型为int，范围为0，1，2
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display a square of a given number")
parser.add_argument("-v", "--verbosity", type=int, choices=[0, 1, 2],help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity == 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity == 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

输出：

# 命令行中的输入和输出
python prog.py 4 -v 3
#usage: prog.py [-h] [-v {0,1,2}] square
#prog.py: error: argument -v/--verbosity: invalid choice: 3 (choose from 0, 1, 2)
python prog.py 4 -h
#usage: prog.py [-h] [-v {0,1,2}] square
#positional arguments:
#  square                display a square of a given number
#options:
#  -h, --help            show this help message and exit
#  -v {0,1,2}, --verbosity {0,1,2}    increase output verbosity

action:"count"：统计特定参数出现的次数。
default：默认的值，如果有action="store_true"，那么选用该参数时值为True，否则值为default的值。

# prog.py
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int,help="display a square of a given number")
parser.add_argument("-v", "--verbosity", action="count", default=0,help="increase output verbosity")
args = parser.parse_args()
answer = args.square**2
if args.verbosity >= 2:
    print(f"the square of {args.square} equals {answer}")
elif args.verbosity >= 1:
    print(f"{args.square}^2 == {answer}")
else:
    print(answer)

输出：

# 命令行中的输入和输出
python prog.py 4
# 16
python prog.py 4 -vvv
# the square of 4 equals 16
python prog.py 4 -vv
# the square of 4 equals 16
python prog.py 4 --verbosity --verbosity
# the square of 4 equals 16
python prog.py 4 -vvvv
# the square of 4 equals 16
python prog.py 4 -v 1
# usage: prog.py [-h] [-v] square
# prog.py: error: unrecognized arguments: 1

3、互斥组

add_mutually_exclusive_group()该方法用于创建一个互斥组，在同一命令行中只能选择该组中的一个参数。

# prog.py
import argparse

parser = argparse.ArgumentParser(description="calculate X to the power of Y")
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", action="store_true")
group.add_argument("-q", "--quiet", action="store_true")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
args = parser.parse_args()
answer = args.x**args.y

if args.quiet:
    print(answer)
elif args.verbose:
    print(f"{args.x} to the power {args.y} equals {answer}")
else:
    print(f"{args.x}^{args.y} == {answer}")

补充：参数description="calculate X to the power of Y"是描述该程序的作用

输出：

python prog.py 4 2
# 4^2 == 16
python prog.py 4 2 -q
# 16
python prog.py 4 2 -v
# 4 to the power 2 equals 16
python prog.py 4 2 -vq
# usage: prog.py [-h] [-v | -q] x y
# prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose
python prog.py 4 2 -v --quiet
# usage: prog.py [-h] [-v | -q] x y
# prog.py: error: argument -q/--quiet: not allowed with argument -v/--verbose

4、`action`参数值

store：默认动作，存储参数的值。

parser = argparse.ArgumentParser()
parser.add_argument('--foo')
parser.parse_args('--foo 1'.split())
# Namespace(foo='1')

store_const：存储由const关键字参数指定的值，const关键字参数默认为None。
```
parser.add_argument('--foo', action='store_const', const=42)
```
store_true 和 store_false：分别存储值True或False。

append：存储一个列表，并将每个参数值添加到该列表。

parser = argparse.ArgumentParser()
parser.add_argument('--foo', action='append')
parser.parse_args('--foo 1 --foo 2'.split())
# Namespace(foo=['1', '2'])

append_const：存储一个列表，并将由const关键字参数指定的值添加到列表中，const关键字参数默认为None。

parser.add_argument('--str', dest='types', action='append_const', const=str)
parser.add_argument('--int', dest='types', action='append_const', const=int)
parser.parse_args('--str --int'.split())
# Namespace(types=[<class 'str'>, <class 'int'>])

count：计算选项在命令行中出现的次数。常用于增加详细程度等。
help：打印所有当前解析器中的选项和参数的完整帮助信息，然后退出。
version：打印版本信息并退出。通常与version参数一起使用。
```
parser.add_argument('--version', action='version', version='%(prog)s 1.0')
```

extend：存储一个列表，并将每个参数值加入到列表中。

parser.add_argument("--foo", action="extend", nargs="+", type=str)
parser.parse_args(["--foo", "f1", "--foo", "f2", "f3", "f4"])
# Namespace(foo=['f1', 'f2', 'f3', 'f4'])