Python命令行参数处理：详解argparse模块

Python命令行参数处理：详解argparse模块

在Python开发中，能够处理命令行参数是一项非常实用的技能。argparse模块是Python标准库中用于解析命令行参数的模块，它能够轻松地处理复杂的命令行接口。本文将详细介绍如何使用argparse模块来处理命令行参数，包括创建脚本、定义参数、解析参数以及一些高级用法。

argparse模块简介

argparse模块提供了一种方便的方式来处理命令行参数。它能够自动生成帮助和使用手册，并且能够处理短参数和长参数。

基础用法

创建解析器

首先，需要从argparse模块导入ArgumentParser类，并创建一个解析器对象。

import argparse

parser = argparse.ArgumentParser(description='这是一个示例脚本。')

添加参数

使用add_argument方法来添加命令行参数。

parser.add_argument('echo', help='重复输入的字符串')
parser.add_argument('--verbosity', help='增加输出的详细程度', action='store_true')
parser.add_argument('-o', '--output', help='输出文件')

解析参数

使用parse_args()方法来解析命令行参数。

args = parser.parse_args()

使用参数

根据解析出的参数执行相应的操作。

if args.verbosity:
    print("详细模式开启")
if args.output:
    with open(args.output, 'w') as f:
        f.write(args.echo)
else:
    print(args.echo)

高级用法

默认值和类型检查

可以为参数指定默认值和类型。

parser.add_argument('--version', action='version', version='%(prog)s 2.0')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='一个或多个整数')

可选参数和位置参数

可选参数通常以-或--开头，位置参数则没有。

parser.add_argument('-t', '--test', action='store_const', const=value, default=another_value)
parser.add_argument('files', nargs='*', help='输入文件')

子命令

argparse支持子命令，类似于git命令的add、commit等。

subparsers = parser.add_subparsers(help='子命令帮助')

# 创建第一个子命令的解析器
parser_a = subparsers.add_parser('a', help='a 子命令帮助')
parser_a.add_argument('foo', help='foo 参数')

# 创建第二个子命令的解析器
parser_b = subparsers.add_parser('b', help='b 子命令帮助')
parser_b.add_argument('bar', help='bar 参数')

定制帮助信息

可以定制帮助信息的显示方式。

parser.formatter_class = argparse.RawDescriptionHelpFormatter
parser.description = textwrap.dedent('''
    这个脚本用于演示 argparse 模块。
    它提供了一个非常灵活的命令行接口。
''')

参数冲突处理

argparse能够处理参数冲突，并给出错误提示。

parser.add_argument('--foo', help='foo 的参数')
parser.add_argument('-f', action='store_true',
                    help='-f 和 --foo 不能同时使用')

实际应用案例

假设我们需要编写一个脚本，用于处理文本文件，并支持多种操作，如查看、复制、删除等。

import argparse

# 创建解析器
parser = argparse.ArgumentParser(description='文本文件处理器')

# 添加子命令
subparsers = parser.add_subparsers(dest='command', help='可用的命令')

# 创建查看子命令
parser_view = subparsers.add_parser('view', help='查看文件内容')
parser_view.add_argument('file', help='要查看的文件')

# 创建复制子命令
parser_copy = subparsers.add_parser('copy', help='复制文件')
parser_copy.add_argument('source', help='源文件')
parser_copy.add_argument('destination', help='目标文件')

# 解析参数
args = parser.parse_args()

# 根据子命令执行操作
if args.command == 'view':
    with open(args.file, 'r') as f:
        print(f.read())
elif args.command == 'copy':
    with open(args.source, 'r') as f:
        data = f.read()
    with open(args.destination, 'w') as f:
        f.write(data)

结论

argparse模块是Python中处理命令行参数的强大工具。它不仅能够简化参数解析的过程，还能够自动生成帮助和使用手册，支持短参数和长参数，以及复杂的子命令结构。通过本文的介绍和示例，你应该能够掌握argparse模块的基础和高级用法，从而编写出功能强大且用户友好的命令行程序。