可选参数用法及示例: argparse模块

在Python脚本中，经常需要从命令行获得参数，例如输入文件名、输出文件名、运行模式等。Python内置的argparse模块可以轻松地处理命令行参数。argparse支持必需参数和可选参数，本文将详细探讨argparse模块中可选参数的用法及示例。

一、基础用法

可选参数是一个可选的参数，可以在命令行中出现也可以不出现。在argparse中，使用add_argument()方法添加可选参数。例如：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="increase output verbosity", action="store_true")
args = parser.parse_args()

if args.verbose:
    print("verbosity turned on")

在上面的示例中，使用add_argument()方法添加了一个可选参数-v和--verbose。help参数是这个可选参数的帮助信息。action参数指定了当这个可选参数出现时需要执行的操作。在这个示例中，通过action="store_true"来设定，如果在命令行中出现了-v或--verbose，则args.verbose这个变量会被置为True。

二、多种参数类型

argparse支持多种可选参数类型，例如字符串、整数、浮点数、布尔值等。下面是一个示例，演示了如何添加多种不同类型的可选参数：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-f", "--file", help="input file name")
parser.add_argument("-n", "--number", help="an integer", type=int)
parser.add_argument("-d", "--debug", help="enable debug mode", action="store_true")
parser.add_argument("-r", "--rate", help="a float number", type=float)
args = parser.parse_args()

print(args.file)
print(args.number)
print(args.debug)
print(args.rate)

在这个示例中，添加了四个不同类型的可选参数。其中，-f和--file是字符串类型的参数，-n和--number是整数类型的参数，-d和--debug是布尔类型的参数，-r和--rate是浮点数类型的参数。

三、参数默认值

在命令行中如果没有给出可选参数的值，则argparse将用默认值来设置该参数。可以通过default参数指定参数的默认值，例如：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-f", "--file", help="input file name", default="default.dat")
parser.add_argument("-n", "--number", help="an integer", type=int, default=20)
args = parser.parse_args()

print(args.file)
print(args.number)

在这个示例中，-f和--file的默认值为"default.dat"，-n和--number的默认值为20。

四、参数组

有时候需要将多个可选参数分组显示，在argparse中可以使用add_argument_group()方法创建参数组来达到这个目的。下面是一个示例：

import argparse

parser = argparse.ArgumentParser()
group1 = parser.add_argument_group("group1")
group1.add_argument("-f", "--file", help="input file name")
group1.add_argument("--format", help="output format")

group2 = parser.add_argument_group("group2")
group2.add_argument("-w", "--width", help="image width")
group2.add_argument("-h", "--height", help="image height")

args = parser.parse_args()

print(args.file)
print(args.format)
print(args.width)
print(args.height)

在这个示例中，创建了两个参数组group1和group2，将参数分为两组。程序使用时，可以通过分组来更加清晰地显示参数。

五、参数别名

有时候需要对命令行参数提供多个不同的选项名称，这可以通过aliases参数来实现。例如：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument("-b", "--bar", help="bar help")
parser.add_argument("--baz", help="baz help", aliases=["fizz", "buzz"])

args = parser.parse_args()

print(args.bar)
print(args.baz)

在这个示例中，"--baz"这个参数有3个不同的选项名称，分别是"--baz"、"--fizz"和"--buzz"。可以在命令行输入任何一个选项名称都会被正确解析。

六、参数互斥

有时候多个可选参数之间是互斥的，即同时只能存在一个参数。在argparse中，使用add_mutually_exclusive_group()方法创建互斥的参数组。例如：

import argparse

parser = argparse.ArgumentParser()
group = parser.add_mutually_exclusive_group()
group.add_argument("-v", "--verbose", help="increase verbosity", action="store_true")
group.add_argument("-q", "--quiet", help="decrease verbosity", action="store_true")

args = parser.parse_args()

if args.verbose:
    print("verbosity turned on")
if args.quiet:
    print("verbosity turned off")

在这个示例中，-v和--verbose和-q和--quiet是互斥的，同时只能存在其中之一。因此，使用了add_mutually_exclusive_group()方法创建了一个互斥的参数组group。

七、小结

本文详细介绍了argparse模块中可选参数的用法及示例，包括基础用法、多种参数类型、参数默认值、参数组、参数别名和参数互斥。argparse模块是Python的一个重要工具，在编写命令行程序时经常使用。掌握这些用法将有助于编写更加复杂和实用的命令行程序。