Python解析命令行读取参数--argparse模块使用方法

在Python中，解析命令行并读取参数可以使用argparse模块。本篇攻略将详细介绍argparse模块的使用方法，包括示例说明。

一、argparse模块概述

argparse模块是Python标准库中的一部分，用于解析命令行并读取参数。它是optparse模块的一个替代品，提供了更好的易用性和功能。

argparse模块包含两个主要部分：ArgumentParser和ArgumentGroup。ArgumentParser是用于创建解析器对象的类，而ArgumentGroup是用于将参数分组的类。

二、使用ArgumentParser类解析命令行参数

1. 创建ArgumentParser对象

在使用argparse模块解析命令行参数之前，我们需要使用ArgumentParser类创建一个解析器对象。例如：

import argparse

parser = argparse.ArgumentParser(description='example')

创建了一个名为parser的ArgumentParser对象，并设置了它的描述为example。

2. 添加参数

接下来，我们需要使用add_argument()方法来向解析器对象中添加参数。add_argument()方法接受多个参数，包括参数名、参数选项等。例如：

parser.add_argument('--name', help='name of the user')
parser.add_argument('--age', type=int, help='age of the user')

上述代码向解析器对象中分别添加了--name和--age两个参数。

3. 解析参数

在向解析器对象添加完参数后，我们需要使用parse_args()方法来解析命令行参数。例如：

args = parser.parse_args()

上述代码将解析器对象中的参数转换为一个args对象，我们可以通过这个对象来读取命令行参数。

4. 读取参数

通过args对象来读取命令行参数非常简单。例如：

print(args.name)
print(args.age)

上述代码分别打印出命令行参数--name和--age的值。

5. 示例1

假设我们要编写一个脚本，向其传递一个名字和一个数字，程序将打印出名字和数字的平方。我们可以通过如下代码来实现：

import argparse

parser = argparse.ArgumentParser(description='square the given number')
parser.add_argument('--name', help='name of the user')
parser.add_argument('--num', type=int, help='number to be squared')

args = parser.parse_args()

print("Hello, " + args.name + "! " + str(args.num) + " squared is " + str(args.num ** 2))

我们可以使用如下命令行来运行这个程序，并传递参数：

python script.py --name Alice --num 3

程序将打印出：

Hello, Alice! 3 squared is 9

6. 示例2

假设我们要编写一个下载器脚本，它可以接受三个参数：下载方法、文件名和URL。下载方法可以是ftp或http，文件名是下载后的文件名，URL是文件的下载链接。我们可以通过如下代码来实现：

import argparse

parser = argparse.ArgumentParser(description='downloader')
parser.add_argument('method', choices=['ftp', 'http'], help='download method')
parser.add_argument('filename', help='downloaded file name')
parser.add_argument('url', help='download url')

args = parser.parse_args()

print("method: " + args.method)
print("filename: " + args.filename)
print("url: " + args.url)

我们可以使用如下命令行来运行这个程序，并传递参数：

python downloader.py http test.txt http://example.com/test.txt

程序将打印出：

method: http
filename: test.txt
url: http://example.com/test.txt

三、使用ArgumentGroup类分组参数

如果我们要将参数按照一定规则进行分组，那么我们可以使用ArgumentGroup类来实现。

1. 创建ArgumentGroup对象

在使用ArgumentGroup类进行参数分组之前，我们需要使用ArgumentParser类创建一个解析器对象。例如：

import argparse

parser = argparse.ArgumentParser(description='example')

group1 = parser.add_argument_group('group1', 'group1 description')
group2 = parser.add_argument_group('group2', 'group2 description')

上述代码创建了名为parser的ArgumentParser对象，并分别创建了名为group1和group2的ArgumentGroup对象。

2. 向ArgumentGroup对象中添加参数

接下来，我们将参数添加到相应的ArgumentGroup对象中。例如：

group1.add_argument('--name', help='name of the user')
group2.add_argument('--age', type=int, help='age of the user')

上述代码将命令行参数--name添加到group1中，将命令行参数--age添加到group2中。

3. 示例

假设我们要编写一个程序，接受三个参数：模式、输入文件和输出文件。其中模式可以是a或b，输入文件是需要处理的文件名，输出文件是结果保存的文件名。我们将模式参数和输入文件参数放到一个分组中，将输出文件参数放到一个新的分组中。我们可以使用如下代码来实现：

import argparse

parser = argparse.ArgumentParser(description='process file')

input_group = parser.add_argument_group('input', 'input file group')
input_group.add_argument('-m', '--mode', choices=['a', 'b'], help='processing mode')
input_group.add_argument('-i', '--input', help='input file name')

output_group = parser.add_argument_group('output', 'output file group')
output_group.add_argument('-o', '--output', help='output file name')

args = parser.parse_args()

print("mode: " + args.mode)
print("input file name: " + args.input)
print("output file name: " + args.output)

我们可以使用如下命令行来运行这个程序，并传递参数：

python process.py -m a -i input.txt -o output.txt

程序将打印出：

mode: a
input file name: input.txt
output file name: output.txt

四、总结

本篇攻略详细介绍了argparse模块的使用方法，包括创建ArgumentParser对象、添加参数、解析参数、读取参数等操作，同时还给出了两个示例代码来帮助理解argparse模块的使用。

在实际编码中，我们需要根据需求选择适当的参数类型、默认值、帮助信息等，并使用ArgumentGroup类来实现参数分组，可以使代码更加规范、易读。