Python argparse详解|极客教程

Python argparse详解

在编写Python脚本时，经常需要接收命令行参数，以控制程序的行为。Python的标准库中提供了argparse模块，可以轻松地实现命令行参数的解析。本文将详细介绍argparse模块的用法，包括如何定义命令行选项、位置参数、子命令等。

argparse模块概述

argparse模块是Python标准库中用于解析命令行参数的模块，它可以帮助我们定义命令行选项和参数，并在程序执行时解析这些参数。通过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')
args = parser.parse_args()

print(sum(args.integers))

在这个示例中，我们使用argparse创建了一个ArgumentParser对象，并使用add_argument()方法定义了一个位置参数’integers’，它表示需要传入的整数。当用户在命令行中输入整数时，程序将计算这些整数的总和并输出。

现在让我们详细介绍argparse模块的用法。

定义位置参数

位置参数是在命令行中按照顺序出现的参数，它们不需要被赋予参数名。使用add_argument()方法可以定义位置参数，参数如下：

name or flags: 参数的名称或者选项，可以是一个字符串或者字符串列表。
action: 参数的动作，可以是store、store_const、store_true、store_false等。
type: 参数的类型，可以是int、float、str等。
nargs: 参数的个数，可以是?、*、+、int。
const: 存储的值。
default: 默认值。
help: 参数的帮助信息。

下面是一个定义位置参数的示例：

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
parser.add_argument('integers', metavar='N', type=int, nargs='+',
                    help='an integer for the accumulator')
args = parser.parse_args()

print(sum(args.integers))

运行示例代码，输入python example.py 1 2 3，程序输出6。

定义可选参数

可选参数是在命令行中不是必须出现的参数，可以通过选项的形式传入。使用add_argument()方法可以定义可选参数，参数如下：

name or flags: 参数的名称或者选项，可以是一个字符串或者字符串列表。
action: 参数的动作，可以是store、store_const、store_true、store_false等。
type: 参数的类型，可以是int、float、str等。
nargs: 参数的个数，可以是?、*、+、int。
const: 存储的值。
default: 默认值。
help: 参数的帮助信息。

下面是一个定义可选参数的示例：

import argparse

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

print(args.accumulate(args.integers))

运行示例代码，输入python example.py --sum 1 2 3，程序输出6。

定义子命令

除了定义位置参数和可选参数外，我们还可以使用add_subparsers()方法定义子命令，实现更复杂的命令行接口。子命令可以让我们将不同功能的代码组织在不同的子命令中，使程序更加清晰。

下面是一个定义子命令的示例：

import argparse

parser = argparse.ArgumentParser(description='Process some integers.')
subparsers = parser.add_subparsers(dest='command')

hello_parser = subparsers.add_parser('hello', help='say hello')
hello_parser.add_argument('name', help='your name')

bye_parser = subparsers.add_parser('bye', help='say bye')
bye_parser.add_argument('name', help='your name')

args = parser.parse_args()

if args.command == 'hello':
    print(f'Hello, {args.name}!')
elif args.command == 'bye':
    print(f'Bye, {args.name}!')