当前位置：物联沃-IOTWORD物联网 > 技术教程 > Python argparse 模块：命令行参数解析全攻略
代码收藏家代码收藏家 技术教程

Python argparse 模块：命令行参数解析全攻略

在 Python 编程中，命令行参数解析是一个常见且重要的任务。argparse 模块为我们提供了一种简单而强大的方式来处理命令行参数。本文将详细介绍 argparse 模块的使用方法，从基本概念到复杂的参数解析场景，结合实例和图文说明，帮助你轻松掌握这一实用工具，同时对重点知识点进行扩展，让你在实际项目中能灵活运用。

 

目录

一、argparse 模块基础

1. 什么是 argparse

2. 基本使用步骤

二、不同类型参数的添加与使用

1. 位置参数

2. 可选参数

3. 带类型的参数

4. 带默认值的参数

三、参数组和互斥参数

1. 参数组

2. 互斥参数

四、自定义参数动作和帮助信息

1. 自定义参数动作

2. 自定义帮助信息

五、重点知识点扩展

1. 子命令的使用

2. 与其他模块结合使用

总结

TAG： Python、argparse 模块、命令行参数解析、参数类型、子命令

一、argparse 模块基础

1. 什么是 argparse

argparse 是 Python 标准库中的一个模块，用于编写用户友好的命令行接口。它可以自动生成帮助和使用信息，并且能够处理命令行参数的解析和错误检查。

2. 基本使用步骤

  • 创建解析器：使用 argparse.ArgumentParser() 创建一个解析器对象。这个对象就像是一个指挥官，负责管理和解析命令行参数。
    • import argparse
parser = argparse.ArgumentParser(description='这是一个示例程序，用于演示 argparse 的基本用法')

  • 添加参数：使用 add_argument() 方法向解析器中添加参数。参数可以是位置参数、可选参数等。
    • # 添加位置参数
parser.add_argument('input_file', help='输入文件的路径')
# 添加可选参数
parser.add_argument('-o', '--output', help='输出文件的路径')

  • 解析参数：使用 parse_args() 方法解析命令行参数。
    • args = parser.parse_args()

    完整示例：

     

    二、不同类型参数的添加与使用

    1. 位置参数

    位置参数是根据在命令行中出现的顺序来确定的参数。例如，在上面的例子中，input_file 就是一个位置参数，用户在运行程序时必须提供该参数的值。

    import argparse
parser = argparse.ArgumentParser()
parser.add_argument('input_file', help='输入文件的路径')
args = parser.parse_args()
print(f'输入文件路径为: {args.input_file}')

    在命令行中运行该程序：

    python script.py test.txt

    输出结果：

    输入文件路径为: test.txt

     

    2. 可选参数

    可选参数以 - 或 -- 开头，用户可以选择是否提供这些参数。例如，上面例子中的 -o 或 --output 就是可选参数。

    import argparse
parser = argparse.ArgumentParser()
parser.add_argument('input_file', help='输入文件的路径')
parser.add_argument('-o', '--output', help='输出文件的路径')
args = parser.parse_args()
if args.output:
    print(f'输入文件路径为: {args.input_file}，输出文件路径为: {args.output}')
else:
    print(f'输入文件路径为: {args.input_file}，未指定输出文件路径')

    在命令行中运行该程序：

    python script.py test.txt -o output.txt

    输出结果：plaintext

    输入文件路径为: test.txt，输出文件路径为: output.txt

    3. 带类型的参数

    可以通过 type 参数指定参数的类型，例如整数、浮点数等。

    import argparse
parser = argparse.ArgumentParser()
parser.add_argument('num', type=int, help='输入一个整数')
args = parser.parse_args()
print(f'输入的整数为: {args.num}')

    在命令行中运行该程序：

    python script.py 10

    输出结果：

    输入的整数为: 10

    4. 带默认值的参数

    使用 default 参数可以为可选参数设置默认值。

    import argparse
parser = argparse.ArgumentParser()
parser.add_argument('-n', '--name', default='John', help='输入姓名，默认为 John')
args = parser.parse_args()
print(f'姓名为: {args.name}')

    在命令行中运行该程序：

    python script.py

    输出结果：

    姓名为: John

     

    三、参数组和互斥参数

    1. 参数组

    可以使用 add_argument_group() 方法将相关的参数组织在一起，使帮助信息更加清晰。

    import argparse
parser = argparse.ArgumentParser()
group = parser.add_argument_group('文件操作参数')
group.add_argument('input_file', help='输入文件的路径')
group.add_argument('-o', '--output', help='输出文件的路径')
args = parser.parse_args()

    当运行 python script.py -h 时，帮助信息会将这些参数归为一组显示。

    2. 互斥参数

    使用 add_mutually_exclusive_group() 方法可以创建互斥参数组，用户只能选择其中一个参数。

    import argparse
parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument('-v', '--verbose', action='store_true', help='详细输出')
group.add_argument('-q', '--quiet', action='store_true', help='安静模式')
args = parser.parse_args()
if args.verbose:
    print('详细输出模式')
elif args.quiet:
    print('安静模式')
else:
    print('默认模式')

    在命令行中运行 python script.py -v 会输出 详细输出模式，而运行 python script.py -q 会输出 安静模式，不能同时使用 -v 和 -q。

    四、自定义参数动作和帮助信息

    1. 自定义参数动作

    可以通过继承 argparse.Action 类来创建自定义的参数动作。例如，下面的代码实现了一个自定义动作，用于将输入的字符串转换为大写。

    import argparse

class UpperAction(argparse.Action):
    def __call__(self, parser, namespace, values, option_string=None):
        setattr(namespace, self.dest, values.upper())

parser = argparse.ArgumentParser()
parser.add_argument('--name', action=UpperAction, help='输入姓名并转换为大写')
args = parser.parse_args()
print(f'转换后的姓名为: {args.name}')

    在命令行中运行 python script.py --name john 会输出 转换后的姓名为: JOHN。

    2. 自定义帮助信息

    可以通过重写 ArgumentParser 的 print_help() 方法来自定义帮助信息的格式。

    import argparse

class CustomParser(argparse.ArgumentParser):
    def print_help(self):
        print('这是自定义的帮助信息')
        super().print_help()

parser = CustomParser()
parser.add_argument('input_file', help='输入文件的路径')
parser.print_help()

    运行该程序会先输出自定义的帮助信息，然后再输出默认的帮助信息。

    五、重点知识点扩展

    1. 子命令的使用

    argparse 支持子命令，用于实现更复杂的命令行接口。例如，一个文件管理工具可以有 create、delete、list 等子命令。

    import argparse

parser = argparse.ArgumentParser()
subparsers = parser.add_subparsers(title='子命令', dest='subcommand')

# 创建 create 子命令
create_parser = subparsers.add_parser('create', help='创建文件')
create_parser.add_argument('filename', help='要创建的文件名')

# 创建 delete 子命令
delete_parser = subparsers.add_parser('delete', help='删除文件')
delete_parser.add_argument('filename', help='要删除的文件名')

args = parser.parse_args()
if args.subcommand == 'create':
    print(f'创建文件: {args.filename}')
elif args.subcommand == 'delete':
    print(f'删除文件: {args.filename}')

    在命令行中运行 python script.py create test.txt 会输出 创建文件: test.txt，运行 python script.py delete test.txt 会输出 删除文件: test.txt。

    2. 与其他模块结合使用

    argparse 可以与其他模块结合使用，例如 logging 模块。通过命令行参数来控制日志的级别。

    import argparse
import logging

parser = argparse.ArgumentParser()
parser.add_argument('-l', '--loglevel', choices=['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL'], default='INFO', help='设置日志级别')
args = parser.parse_args()

logging.basicConfig(level=getattr(logging, args.loglevel))
logging.info('这是一条信息日志')
logging.error('这是一条错误日志')

    在命令行中运行 python script.py -l DEBUG 会输出详细的日志信息，而运行 python script.py -l ERROR 只会输出错误级别的日志信息。

    总结

    argparse 模块为 Python 程序提供了强大而灵活的命令行参数解析功能。通过本文的介绍，你学会了如何创建解析器、添加不同类型的参数、处理参数组和互斥参数，以及自定义参数动作和帮助信息。同时，还了解了子命令的使用和与其他模块的结合应用。掌握这些知识，你可以轻松为自己的 Python 程序编写用户友好的命令行接口，提高程序的易用性和可维护性。

    TAG： Python、argparse 模块、命令行参数解析、参数类型、子命令

    作者：tekin

    物联沃分享整理
    物联沃-IOTWORD物联网 » Python argparse 模块：命令行参数解析全攻略

    代码收藏家 普通

    分享到：

    相关推荐

    发表回复