argparse 详细介绍 python
时间: 2023-10-16 21:14:20 浏览: 148
Python的argparse库使用详解
argparse是Python标准库中用于解析命令行参数和选项的模块。它可以使命令行接口更加友好和规范,使得用户输入参数更加方便,同时也可以减少编写命令行解析代码的工作量。
下面是argparse的详细介绍:
1. 基本用法
argparse模块的基本用法非常简单。首先,你需要创建一个ArgumentParser对象,然后向它添加参数和选项。
```
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("echo", help="echo the string you use here")
args = parser.parse_args()
print(args.echo)
```
这个例子中,我们创建了一个ArgumentParser对象`parser`,然后添加了一个位置参数`echo`。位置参数是指在命令行中不带前缀的参数。
在执行`parser.parse_args()`时,argparse会解析命令行参数,将结果存储在一个Namespace对象中,并返回该对象。我们可以通过`args.echo`来访问`echo`参数的值。
2. 添加选项
除了位置参数,argparse还支持添加选项。选项是指在命令行中带前缀的参数,如`--verbose`、`-f`等。
```
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbose", help="increase output verbosity", action="store_true")
args = parser.parse_args()
if args.verbose:
print("verbosity turned on")
```
这个例子中,我们添加了一个选项`--verbose`,并且指定了它的作用是将`args.verbose`设为True。如果在命令行中输入了`--verbose`选项,则输出`verbosity turned on`。
3. 参数类型
argparse支持多种参数类型,例如字符串、整数、浮点数、布尔值等。
```
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("square", type=int, help="display a square of a given number")
args = parser.parse_args()
print(args.square**2)
```
这个例子中,我们将`square`参数的类型指定为整数,然后输出它的平方。
4. 默认值
你可以为参数和选项设置默认值,当用户没有输入该参数或选项时,argparse会使用默认值。
```
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("--verbosity", help="increase output verbosity", type=int, choices=[0, 1, 2], default=0)
args = parser.parse_args()
if args.verbosity == 2:
print("verbosity level 2")
elif args.verbosity == 1:
print("verbosity level 1")
else:
print("verbosity turned off")
```
这个例子中,我们将`--verbosity`选项的类型指定为整数,并设置了默认值为0。如果用户没有输入`--verbosity`选项,则使用默认值。如果用户输入了`--verbosity`选项,则根据输入值输出不同的信息。
5. 多个参数
你可以同时添加多个参数和选项。
```
import argparse
parser = argparse.ArgumentParser(description="calculate X to the power of Y")
parser.add_argument("x", type=int, help="the base")
parser.add_argument("y", type=int, help="the exponent")
parser.add_argument("-v", "--verbose", action="store_true", help="increase output verbosity")
args = parser.parse_args()
result = args.x**args.y
if args.verbose:
print("{} to the power {} equals {}".format(args.x, args.y, result))
else:
print(result)
```
这个例子中,我们同时添加了两个位置参数`x`和`y`,和一个选项`--verbose`。当用户输入`--verbose`选项时,输出详细信息。
6. 子命令
argparse还支持添加子命令,例如`git`命令中的`git add`、`git commit`等。
```
import argparse
parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(title="subcommands", description="valid subcommands", help="additional help")
parser_a = subparsers.add_parser("a", help="subcommand a")
parser_a.add_argument("foo", type=int, help="foo argument")
parser_a.set_defaults(func=lambda args: print("subcommand a: {}".format(args.foo)))
parser_b = subparsers.add_parser("b", help="subcommand b")
parser_b.add_argument("bar", type=int, help="bar argument")
parser_b.set_defaults(func=lambda args: print("subcommand b: {}".format(args.bar)))
args = parser.parse_args()
args.func(args)
```
这个例子中,我们创建了一个ArgumentParser对象,并添加了两个子命令`a`和`b`。每个子命令都有自己的参数,我们可以为每个子命令设置一个默认函数。当用户输入`a`或`b`时,argparse会调用相应的函数并传递参数。
7. 更多用法
argparse还支持更多用法,例如互斥选项、可选参数、自定义帮助信息等。你可以参考Python官方文档或其他教程来学习这些用法。
阅读全文