Python简单命令行参数处理方法

一、命令行参数简介

命令行参数是指在命令行中输入程序名称后，在程序名称后面紧接着一些参数，这些参数可以被程序接收并处理。在Python中，可以通过sys模块的argv变量获取命令行参数，argv是一个列表，其中第一个元素是程序名称，从第二个元素开始是接收到的命令行参数。

import sys

print(sys.argv)

运行以上代码，如果在命令行中输入python test.py -i input.txt -o output.txt，则输出:

['test.py', '-i', 'input.txt', '-o', 'output.txt']

二、使用argparse模块处理命令行参数

argparse是Python标准库中的一个命令行参数解析模块，通过使用argparse模块，可以轻松地实现命令行选项和参数的解析。

下面是一个使用argparse模块的例子，假设我们编写了一个program.py命令行程序，需要接收两个参数，分别是输入文件和输出文件，可以通过以下方式实现:

import argparse

parser = argparse.ArgumentParser(description='Description of your program')
parser.add_argument('-i','--input', help='Input file', required=True)
parser.add_argument('-o','--output', help='Output file', required=True)
args = vars(parser.parse_args())

input_file = args['input']
output_file = args['output']

print('Input file: %s' % input_file)
print('Output file: %s' % output_file)

运行以上代码，在命令行中输入以下命令：

python program.py -i input.txt -o output.txt

则输出结果为：

Input file: input.txt
Output file: output.txt

三、argparse模块参数详解

argparse的常用参数如下：

• add_argument()：定义命令行参数。
• description：程序的描述信息，会显示在帮助信息的最前面。
• help：参数的帮助信息。
• default：参数的默认值。
• required：参数是否是必需的。
• action：参数的动作类型（如store，store_true，store_false，append等）。
• nargs：一个参数应该被解析成的数量（如N、?、*、+）。
• type：参数应该被解析成的类型。
• choices：参数可选的值。
• metavar：参数在帮助信息中的显示名称。

四、使用argparse模块处理子命令参数

argparse还支持处理子命令参数，即在主命令下再定义一些子命令。例如，我们想要编写一个文件处理程序，支持两种操作，分别是读取文件和写入文件，可以通过以下方式实现:

import argparse

parser = argparse.ArgumentParser(description='File processing program')
subparsers = parser.add_subparsers()

read_parser = subparsers.add_parser('read', help='Read file')
read_parser.add_argument('file', help='File path')

write_parser = subparsers.add_parser('write', help='Write file')
write_parser.add_argument('file', help='File path')
write_parser.add_argument('-c', '--content', help='File content')

args = parser.parse_args()

if hasattr(args, 'file'):
    print('File path:', args.file)

if hasattr(args, 'content'):
    print('File content:', args.content)

在命令行中输入以下命令：

python program.py read input.txt
python program.py write output.txt --content "Hello world"

则分别输出:

File path: input.txt
File path: output.txt
File content: Hello world

五、使用click模块处理命令行参数

click是Python中一个流行的命令行应用框架，通过使用click模块，可以轻松地编写复杂的命令行应用程序。

下面是一个使用click模块的例子，假设我们编写了一个program.py命令行程序，需要接受两个参数，分别是输入文件和输出文件，可以通过以下方式实现：

import click

@click.command()
@click.option('-i', '--input', help='Input file', required=True, type=click.Path(exists=True))
@click.option('-o', '--output', help='Output file', required=True, type=click.Path())
def main(input, output):
    click.echo('Input file: %s' % input)
    click.echo('Output file: %s' % output)

if __name__ == '__main__':
    main()

运行以上代码，在命令行中输入以下命令：

python program.py -i input.txt -o output.txt

则输出结果为：

Input file: input.txt
Output file: output.txt

六、click模块参数详解

click模块支持的参数与argparse类似，常用参数如下：

• @click.command()：定义命令行程序。
• @click.option()：定义命令行参数。
• help：参数的帮助信息。
• default：参数的默认值。
• required：参数是否是必需的。
• type：参数应该被解析成的类型。
• nargs：一个参数应该被解析成的数量（如N、?、*、+）。
• multiple：参数是否可以多次出现。
• count：参数出现的次数。
• callback：参数处理函数。
• is_flag：参数是否是布尔类型。
• expose_value：参数是否可以在函数内部访问。
• envvar：参数在环境变量中的名称。
• show_default：在帮助信息中是否显示参数的默认值。
• prompt：当参数未提供时，是否提示用户输入。

七、小结

本文介绍了Python中处理命令行参数的两个模块argparse和click，并详细阐述了它们的用法和常用参数。选择合适的模块对于开发命令行程序十分重要，合理地使用命令行参数可以提高程序的灵活性和可扩展性。