Python命令行参数处理器，快速解析命令行参数

一、什么是命令行参数

命令行参数是指在运行程序时给程序传递的参数，通常包括程序本身路径和用户输入的参数。例如，在命令行中运行python程序时，可以在程序名后面添加参数，例如：

python myprogram.py arg1 arg2

这里`myprogram.py`是程序名，`arg1`和`arg2`是用户传递的参数。在程序中，可以使用各种方法来解析这些参数，例如分割字符串或使用正则表达式，但这些方法都需要开发人员编写大量的代码，而且不够灵活。Python提供了一个标准模块——argparse，可以帮助快速解析命令行参数。

二、使用argparse解析命令行参数

argparse模块是Python标准库中用于解析命令行参数的模块，已经自带于Python3中，不需要安装。以下是一个使用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')
parser.add_argument('--sum', dest='accumulate', action='store_const',
                    const=sum, default=max,
                    help='sum the integers (default: find the max)')

args = parser.parse_args()
print(args.accumulate(args.integers))

以上代码中，`argparse.ArgumentParser`用于创建一个解析器，`description`用于指定程序的帮助信息，`add_argument`用于添加参数。`add_argument`有以下常用参数：

`name or flags` – 参数的名称或者选项，例如`foo`或`–foo`。
`action` – 参数遇到时的响应动作，默认值是“store”。
`type` – 命令行参数应当被转换成的类型。支持的类型包括`int`、`float`、`str`等。
`choices` – 可选参数的可选值。
`required` – 是否必选。
`default` – 默认值。
`help` – 参数的帮助信息。

例如，`parser.add_argument(‘integers’, metavar=’N’, type=int, nargs=’+’, help=’an integer for the accumulator’)`指定了一个位置型参数`integers`，用于传递整数，而且必须至少传递一个。`nargs`参数指定接受的选项数，`+`表示一个或多个，`*`表示零个或多个。

使用以上程序来运行命令行可以如下所示：

$ python prog.py -h
usage: prog.py [-h] [--sum] N [N ...]

Process some integers.

positional arguments:
  N           an integer for the accumulator

optional arguments:
  -h, --help  show this help message and exit
  --sum       sum the integers (default: find the max)

以上程序中的`-h`选项用于打印帮助信息。如果使用如下命令，则传递参数`4`、`2`、`3`：

$ python prog.py 4 2 3
4

执行结果为`4`。

三、使用argparse的应用场景

argparse可以用于解析各种命令行参数，包括位置型参数、可选参数、布尔型参数等。以下是一些使用argparse的实例。

1. 位置型参数和可选参数

以下是一个使用位置型参数和可选参数的示例：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('name', type=str, help='Username')
parser.add_argument('--age', type=int, help='Age')
parser.add_argument('--gender', type=str, help='Gender')

args = parser.parse_args()

print(f"Username: {args.name}")
if args.age:
    print(f"Age: {args.age}")
if args.gender:
    print(f"Gender: {args.gender}")

以上程序中，`parser.add_argument(‘name’, type=str, help=’Username’)`指定了一个位置型参数`name`，用于传递字符串类型的参数，`parser.add_argument(‘–age’, type=int, help=’Age’)`和`parser.add_argument(‘–gender’, type=str, help=’Gender’)`分别指定了两个可选参数`age`和`gender`。

如果使用如下命令来运行以上程序：

$ python user.py john --age 30 --gender male
Username: john
Age: 30
Gender: male

执行结果为：

Username: john
Age: 30
Gender: male

2. 布尔型参数

以下是一个使用布尔型参数的示例：

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('--verbose', action='store_true', help='increase output verbosity')

args = parser.parse_args()

if args.verbose:
    print('Verbose output enabled')

以上程序中，`parser.add_argument(‘–verbose’, action=’store_true’, help=’increase output verbosity’)`指定了一个可选参数`verbose`，如果这个参数被设置为`True`，则程序会打印出`Verbose output enabled`。

如果使用如下命令来运行以上程序：

$ python verbose.py --verbose
Verbose output enabled

执行结果为：

Verbose output enabled

四、总结

在Python中，可以使用argparse模块来快速解析命令行参数，它支持各种类型的命令行参数，包括位置型参数、可选参数、布尔型参数等。argparse模块灵活易用，可以帮助开发者快速开发命令行工具。

原创文章，作者：TLNV，如若转载，请注明出处：https://www.506064.com/n/147679.html