Python argparse: 命令行参数解析器

一、什么是argparse

在开发python应用程序时，我们经常需要从命令行获取一些参数，例如输入文件名、输出文件名、执行的操作、以及一些其他的选项和参数。python标准库中的argparse模块提供了一种简单、灵活的方法来处理命令行参数。

argparse模块可以自动生成帮助信息、处理参数的默认值和类型、支持命令行补全，以及在用户输入非法参数时输出错误信息，并提供友好的提示信息等功能。

import argparse

parser = argparse.ArgumentParser(description='命令行参数解析器')
parser.add_argument('file', help='输入文件名')
parser.add_argument('-o', '--output', help='输出文件名')
parser.add_argument('-v', '--verbose', action='store_true', help='详细输出')

args = parser.parse_args()

以上代码创建了一个ArgumentParser对象，并向其添加三个参数：

• file：一个必需参数，用于指定输入文件的文件名。
• --output或-o：一个可选参数，用于指定输出文件名。
• --verbose或-v：一个开关参数，用于控制是否输出详细信息。

当用户输入python argparse_demo.py --help时，argparse会自动生成一个帮助信息，并显示给用户。

usage: argparse_demo.py [-h] [-o OUTPUT] [-v] file

命令行参数解析器

positional arguments:
  file                  输入文件名

optional arguments:
  -h, --help            show this help message and exit
  -o OUTPUT, --output OUTPUT
                        输出文件名
  -v, --verbose         详细输出

二、argparse的用法

1. 添加参数

可以使用add_argument()方法向ArgumentParser对象中添加各种参数。

• add_argument()方法必须指定参数的名称或缩写。
• 如果参数是必需的，则不需要指定缩写。
• 如果需要支持负数参数，可以在参数名称前加上--，例如--foo。

# 添加一个必需参数
parser.add_argument('file', help='输入文件名')

# 添加一个可选参数
parser.add_argument('-o', '--output', help='输出文件名')

# 添加一个开关参数
parser.add_argument('-v', '--verbose', action='store_true', help='详细输出')

2. 参数的类型

argparse模块支持指定参数的类型。

• 字符串类型：默认类型为字符串类型。可以使用type=str指定类型。
• 整数类型：可以使用type=int指定类型。
• 浮点数类型：可以使用type=float指定类型。
• 布尔类型：可以使用type=bool指定类型，并使用action='store_true'或action='store_false'指定开关参数。

# 添加一个整数类型的参数
parser.add_argument('-n', '--count', type=int, help='重复次数')

3. 参数的默认值

可以使用default参数指定参数的默认值。

# 添加一个默认值为3的参数
parser.add_argument('-n', '--count', type=int, default=3, help='重复次数')

4. 参数的取值范围

可以使用choices参数指定参数的取值范围。

# 添加一个取值范围为['py', 'js', 'go']的参数
parser.add_argument('-l', '--lang', choices=['py', 'js', 'go'], help='编程语言')

5. 参数的互斥组

如果某些参数之间是互斥的，可以使用add_mutually_exclusive_group()方法创建一个互斥组，将这些参数添加到互斥组中。

group = parser.add_mutually_exclusive_group()
group.add_argument('-a', '--add', action='store_true', help='添加模式')
group.add_argument('-d', '--delete', action='store_true', help='删除模式')

6. 参数的处理函数

可以使用type参数指定参数的类型，并使用action参数指定参数的处理函数。

def read_file(filename):
    with open(filename, 'r') as f:
        return f.read()

parser.add_argument('file', type=read_file, help='输入文件名（读取文件内容）')

7. 自定义帮助文本

可以使用add_help=False禁用默认帮助信息，使用description指定自定义帮助信息。

parser = argparse.ArgumentParser(description='命令行参数解析器', add_help=False)
parser.add_argument('-h', '--help', action='help', help='帮助信息')

当用户输入python argparse_custom_help.py -h时，输出自定义的帮助信息。

三、结语

argparse模块提供了一种简单、灵活的方法来处理命令行参数，可以处理参数的默认值和类型、生成帮助信息、支持命令行补全等功能。使用argparse可以快速编写具有良好交互性的命令行工具。