Python中argparse基本用法小结

这篇文章将为大家详细讲解有关Python中argparse基本用法小结，小编觉得挺实用的，因此分享给大家做个参考，希望大家阅读完这篇文章后可以有所收获。

argparse 基本用法小结

简介

Argparse 是 Python 标准库中一个用于解析命令行参数的模块。它提供了丰富的功能，可轻松处理各种命令行参数，包括必需的、可选的、标志和参数。

安装

argparse 模块已包含在 Python 标准库中，无需单独安装。

使用方法

1. 创建 ArgumentParser 对象

要使用 argparse，首先需要创建一个 ArgumentParser 对象。以下代码创建一个名为 parser 的 ArgumentParser 对象：

import argparse

parser = argparse.ArgumentParser()

2. 添加参数

接下来，您可以使用 ArgumentParser.add_argument() 方法添加参数。该方法接受多个参数，包括参数名称、类型、帮助文本等。

必需参数

要定义必需参数，请使用 positional=True 作为 add_argument() 方法的关键字参数。必需参数必须在命令行中指定。

parser.add_argument("filename", type=str, help="Input filename", positional=True)

可选参数

要定义可选参数，请省略 positional 参数。可选参数可以指定默认值。

parser.add_argument("-o", "--output", type=str, help="Output filename", default="output.txt")

标志

标志是布尔参数，可以通过指定或不指定来激活或禁用它们。

parser.add_argument("-v", "--verbose", help="Enable verbose output", action="store_true")

参数

参数是要与标志关联的值。

parser.add_argument("-b", "--buffer-size", type=int, help="Buffer size", metavar="N")

3. 解析参数

调用 ArgumentParser.parse_args() 方法来解析命令行参数。它将返回一个 Namespace 对象，其中包含所有已解析参数。

args = parser.parse_args()

4. 访问参数

您可以通过 Namespace 对象中的属性访问已解析的参数。

filename = args.filename
output_filename = args.output
verbose = args.verbose

高级用法

限制参数出现次数

可以使用 nargs 参数限制参数出现次数。

parser.add_argument("-f", "--files", help="Input files", nargs="+")

排除互斥的参数组

可以使用 ArgumentGroup.add_mutually_exclusive_group() 方法创建互斥的参数组。

group = parser.add_mutually_exclusive_group(required=True)
group.add_argument("-a", "--option-a", help="Option A")
group.add_argument("-b", "--option-b", help="Option B")

自定义类型

如果您需要处理自定义数据类型，可以使用 argparse.FileType() 或 argparse.Namespace() 创建自定义类型。

parser.add_argument("-f", "--file", type=argparse.FileType("rb"), help="Input file")

故障处理

argparse 会自动处理常见的错误，例如缺少必需参数或无效值。

try:
    args = parser.parse_args()
except argparse.ArgumentError as error:
    print(error)

以上就是Python中argparse基本用法小结的详细内容，更多请关注编程学习网其它相关文章！