Python中如何使用optparse和argparse模块解析命令行参数

Python是一种高级语言，可以用于构建各种类型的应用程序，包括命令行应用程序。当构建一个命令行应用程序时，很有必要使用参数解析器来解析命令行参数。Python标准库中提供了两种命令行参数解析器：optparse和argparse。这篇文章将介绍这两种解析器的用法。

一、optparse模块

optparse是Python标准库中的一个命令行参数解析器。该模块使得命令行参数解析变得非常容易。在开始之前，我们先要注意到，optparse模块于Python 2.7版本弃用，推荐使用argparse模块。

在Python2.7中，optparse模块通常像这样被导入：

from optparse import OptionParser

OptionParser类提供了一种方便的方法来指定和解析命令行参数。如下所示，我们可以通过创建一个OptionParser对象并使用add_option()方法添加选项（包括选项名称，调用选项时要使用的选项字母，以及选项的帮助文本）：

parser = OptionParser()
parser.add_option("-f", "--filename", dest="filename",
                  help="write report to FILE", metavar="FILE")
parser.add_option("-q", "--quiet",
                  action="store_false", dest="verbose", default=True,
                  help="don't print status messages to stdout")

在上面的代码中， 行创建了一个OptionParser对象。第二行添加了一个选项，其短选项为"-f"，长选项为"--filename"，其dest属性为"filename"，表示将选项的值存储到该属性中。帮助文本通过help属性给出。最后一个metavar参数用来提供匹配选项参数列表的字符串。

当选项被调用时，OptionParser对象会自动为指定的选项名称创建一个属性名（即上面例子中的"filename"属性）并将选项的值存储在该属性中。我们可以像访问普通对象的属性一样来访问这个属性。

在添加完所有选项后，我们可以调用parse_args()方法来解析命令行参数。如下所示：

(options, args) = parser.parse_args()

当我们在命令行中指定了所有选项时，parse_args()方法将返回一个包含所有选项和它们的值的字典（其中选项是作为键，选项的值是作为值）。例如，在我们的例子中，我们可以通过options.filename来访问"-f"或"--filename"选项的值。

如果在命令行中没有指定某个选项，那么该选项的值将是None，我们可以使用default属性来设置选项默认值。例如，在我们的例子中，如果我们在命令行参数没有指定"-q"或"--quiet"选项，则verbose属性的值将是True。

下面是一个完整的例子，它展示了如何使用optparse模块来解析命令行参数：

from optparse import OptionParser

parser = OptionParser()
parser.add_option("-f", "--file", dest="filename",
                  help="write report to FILE", metavar="FILE")
parser.add_option("-v", "--verbose",
                  action="store_true", dest="verbose", default=False,
                  help="verbose output")

(options, args) = parser.parse_args()

if options.verbose:
    print("reading %s..." % options.filename)

在上面的代码中，我们添加了两个选项，-f和-v。如果命令行参数指定-v选项，则程序的输出将会详细。如果命令行参数中含有-f选项，则该选项的值可以通过options.filename获得。最后一个条件判断语句检查是否指定了-v选项。

二、argparse模块

argparse是Python标准库中的另一个命令行参数解析器。与optparse相比，argparse提供了更为丰富和灵活的接口。argparse支持子命令，互斥选项，以及更为先进的选项类型（例如，int，float和列表类型）。

argparse通常像这样在Python程序中导入：

import argparse

要使用argparse，我们需要首先创建一个ArgumentParser对象。与OptionParser类似，ArgumentParser类提供了一种方便的方法用于指定和解析命令行参数。下面是一个使用ArgumentParser对象来添加和解析选项的例子：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-f", "--file", dest="filename",
                    help="write report to FILE", metavar="FILE")
parser.add_argument("-v", "--verbose",
                    help="verbose output", action="store_true")

args = parser.parse_args()

if args.verbose:
    print("reading %s..." % args.filename)

请注意，argparse包含两个主要组件，ArgumentParser和ArgumentGroup。也就是说，我们可以将选项分组。

在上面的代码中，我们使用add_argument()方法向ArgumentParser对象添加选项。与optparse类似，我们可以指定选项的短选项和长选项，以及一个dest属性，在选项的值中存储并访问该属性。

在我们的例子中，如果命令行参数指定了"-f"或"--file"选项，那么options.filename属性将包含该选项的值。如果我们指定了"-v"选项，则args.verbose属性的值将为True。

当选项被调用时，parse_args()方法将解析命令行参数。与optparse类似，parse_args()方法将返回一个包含所有选项和它们的值的对象。在使用argparse时，该对象名为args。

下面是一个使用argparse模块的完整例子：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-f", "--file", dest="filename",
                    help="write report to FILE", metavar="FILE")
parser.add_argument("-v", "--verbose",
                    help="verbose output", action="store_true")

args = parser.parse_args()

if args.verbose:
    print("reading %s..." % args.filename)

在上面的代码中，我们定义了-f选项和-v选项。命令行参数"python myprog.py -f report.txt -v"将打印输出"reading report.txt..."。

三、结论

本文介绍了两种Python标准库中常用的命令行参数解析器optparse和argparse的用法及优缺点。如果您打算使用命令行参数解析器构建Python命令行应用程序，那么argparse是更好的选择，因为它比optparse更为丰富和灵活。无论您选择使用哪个选项解析器，它们都是Python标准库中极为有用的工具，可以帮助您构建功能丰富且易于使用的命令行应用程序。