argparse - Python

argparse 是一个 Python 的命令行解释器，其允许程序员轻松地编写用户友好的命令行界面（CLI）。

安装

argparse 可以通过 Python 包管理器 pip 安装：

pip install argparse

使用

argparse 的主要功能是解析命令行参数。下面是一个简单的例子：

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))

这段代码实现了一个命令行程序，其接受一个或多个整数作为输入，并将它们相加或找到其中的最大值。可以使用以下命令运行它：

python program.py 1 2 3 4

输出应该是：

4

argparse.ArgumentParser 方法可以接受许多参数，以自定义您的 CLI 界面。例如，您可以使用 description 参数来添加程序的描述，以便在用户运行 --help 命令时显示帮助信息。

parser = argparse.ArgumentParser(description='A simple CLI tool.')

parser.add_argument 方法用于添加参数。参数可以是位置参数或可选参数。位置参数在命令行上出现的顺序很重要，而可选参数则可以在命令行上任意排列。

对于位置参数，您需要指定参数名称。对于可选参数，您可以指定一个缩写和一个完整的名称。您还可以指定参数的默认值和帮助文本。以下是一些例子：

parser.add_argument('filename', help='file to process')
parser.add_argument('-q', '--quiet', action='store_true', help='suppress output')
parser.add_argument('--debug', type=int, default=0, help='debug level')

您还可以指定参数类型、选项和值的数量。例如，如果您希望参数接受整数值，则可以指定 type=int。如果您希望参数接受多个值，则可以指定 nargs='+'。以下是一些例子：

parser.add_argument('filename', help='file to process')
parser.add_argument('-n', '--num', type=int, help='number of files to process')
parser.add_argument('--files', nargs='+', help='files to process')

结论

argparse 是 Python 中创建命令行界面的一种简单而强大的方法。它允许程序员定义各种参数类型、选项和值的数量，并自动处理所有解析和验证逻辑。如果您正在编写一个需要与用户交互的命令行程序，则应该考虑使用 argparse。