Python的argparse库怎么使用

# Python的argparse库怎么使用

## 1. 简介

`argparse` 是 Python 标准库中用于解析命令行参数的模块，它能够轻松地编写用户友好的命令行界面。相比于手动解析 `sys.argv`，`argparse` 提供了更强大、更灵活的功能，包括：

- 自动生成帮助和使用信息
- 支持位置参数和可选参数
- 参数类型检查和自动转换
- 子命令支持

## 2. 基本用法

### 2.1 创建解析器

首先需要创建一个 `ArgumentParser` 对象：

```python
import argparse

parser = argparse.ArgumentParser(description='这是一个示例程序')

description 参数用于简要描述程序的用途，会显示在帮助信息中。

2.2 添加参数

使用 add_argument() 方法添加参数：

parser.add_argument('filename', help='输入文件名')
parser.add_argument('-v', '--verbose', help='显示详细信息', action='store_true')

• 不带 - 的参数是位置参数（必须提供）
• 带 - 或 -- 的是可选参数
• help 参数用于描述参数的用途
• action='store_true' 表示当指定该选项时，参数值为 True

2.3 解析参数

使用 parse_args() 方法解析参数：

args = parser.parse_args()
print(args.filename)
if args.verbose:
    print("详细模式已开启")

3. 参数类型详解

3.1 位置参数

parser.add_argument('input', help='输入文件')

3.2 可选参数

parser.add_argument('-o', '--output', help='输出文件')

3.3 参数类型

可以指定参数类型：

parser.add_argument('--count', type=int, help='重复次数')

3.4 默认值

parser.add_argument('--level', type=int, default=1, help='处理级别')

3.5 多值参数

parser.add_argument('--numbers', nargs='+', type=int, help='一组数字')

nargs 可以是： - ? - 0或1个值 - * - 0或多个值 - + - 1或多个值 - 数字 - 确切数量的值

3.6 互斥参数

group = parser.add_mutually_exclusive_group()
group.add_argument('--fast', action='store_true', help='快速模式')
group.add_argument('--slow', action='store_true', help='慢速模式')

4. 高级功能

4.1 子命令

subparsers = parser.add_subparsers(dest='command', help='子命令')

# 创建子命令 'init'
parser_init = subparsers.add_parser('init', help='初始化项目')
parser_init.add_argument('--name', required=True, help='项目名称')

# 创建子命令 'build'
parser_build = subparsers.add_parser('build', help='构建项目')
parser_build.add_argument('--debug', action='store_true', help='调试模式')

4.2 自定义动作

class CustomAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        print(f"处理参数: {self.dest}={values}")
        setattr(namespace, self.dest, values.upper())

parser.add_argument('--custom', action=CustomAction)

4.3 参数组

group = parser.add_argument_group('输出选项')
group.add_argument('--output', help='输出文件')
group.add_argument('--format', choices=['json', 'xml'], default='json')

5. 实用示例

5.1 文件处理工具

import argparse

parser = argparse.ArgumentParser(description='文件处理工具')

parser.add_argument('input', help='输入文件路径')
parser.add_argument('-o', '--output', help='输出文件路径')
parser.add_argument('-v', '--verbose', action='store_true', help='详细输出')
parser.add_argument('--encoding', default='utf-8', help='文件编码')
parser.add_argument('--lines', type=int, help='处理的行数')

args = parser.parse_args()

if args.verbose:
    print(f"正在处理文件: {args.input}")
    if args.output:
        print(f"输出到: {args.output}")

5.2 计算器

parser = argparse.ArgumentParser(description='简单计算器')

subparsers = parser.add_subparsers(dest='operation', required=True)

# 加法
add_parser = subparsers.add_parser('add', help='加法运算')
add_parser.add_argument('numbers', nargs='+', type=float, help='要相加的数字')

# 乘法
mul_parser = subparsers.add_parser('mul', help='乘法运算')
mul_parser.add_argument('numbers', nargs='+', type=float, help='要相乘的数字')

args = parser.parse_args()

if args.operation == 'add':
    result = sum(args.numbers)
    print(f"结果: {result}")
elif args.operation == 'mul':
    result = 1
    for num in args.numbers:
        result *= num
    print(f"结果: {result}")

6. 总结

argparse 是 Python 中处理命令行参数的标准方法，它提供了：

1. 简洁的 API 来定义参数
2. 自动生成帮助信息
3. 强大的参数验证功能
4. 支持复杂的命令行界面设计

掌握 argparse 可以让你轻松创建专业级的命令行工具，提高脚本的可用性和用户体验。 “`