介绍argparse的使用【Python标准库】

简介

argparse 模块是Python标准库中的一个模块，用于处理命令行参数解析。它的主要作用是帮助开发者创建命令行界面，允许用户指定运行脚本时的参数，从而定制脚本的行为。本篇博客是博主自己的学习心得，简要介绍了argparse 模块的基本使用，并提供了相关的Python代码示例以供参考。

argparse标准库的核心功能介绍

argparse 模块的使用规范一般包含以下三个步骤：

1. 实例化一个argparse.ArgumentParser对象；
2. 调用ArgumentParser的类方法add_argument()添加位置参数【pisition argment】或者可选参数【option argment】；
3. 调用ArgumentParser的类方法parse_args() 解析参数。
   以下总结了Python标准库中argparse模块中argparse.ArgumentParser()、ArgumentParser.add_argument()以及ArgumentParser.parse_args()的作用和用法：

以下是 argparse.ArgumentParser() 中常用参数的作用和说明：

以下是 add_argument() 方法中常用参数的作用和说明：

注意：

• parse_args() 解析后将返回一个存储有add_argument()添加的所有参数的argparse.Namespace类示例，通过读取这个类示例的属性，我们就可以得到相关的参数和值。
• add_argument()方法会自动添加一组默认参数（--help和-h），用户不能再次通过add_argument()方法添加这组参数，否则会报错。错误信息如下：argparse.ArgumentError: argument -h/--help: conflicting option strings: -h, --help。

Python代码示例

下方程序将从终端接受一个或者一系列整数并生成总和或最大值

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

1
2
3
4
5
6
7
8
9
10
11
12

参考

1. Python文档：Argparse Tutorial
2. Python文档：argparse — Parser for command-line options, arguments and sub-commands

---

收集整理和创作不易, 若有帮助🉑, 请帮忙点赞👍➕收藏❤️, 谢谢!✨✨🚀🚀