Python 用argparse打印命令行参数

在本文中，我们将介绍如何使用argparse模块来处理和打印命令行参数。argparse是Python标准库中的一个模块，它提供了一种简单而灵活的方式来解析命令行参数，并生成帮助和使用信息。

什么是argparse？

argparse是Python标准库中用于解析命令行参数和选项的模块。使用argparse，我们可以轻松地创建命令行接口，定义参数、选项和子命令，并自动生成帮助和使用信息。它最常见的用途是创建脚本工具或命令行应用程序。

使用argparse打印命令行参数

首先，我们需要导入argparse模块:

import argparse

然后，我们可以创建一个ArgumentParser对象，并定义我们的程序所需的参数和选项。例如，我们创建一个脚本，接受一个字符串作为参数，并输出这个字符串的大小写转换结果。

# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='Convert a string to uppercase or lowercase.')

# 添加参数
parser.add_argument('string', type=str, help='The input string')
parser.add_argument('-u', '--uppercase', action='store_true', help='Convert to uppercase')
parser.add_argument('-l', '--lowercase', action='store_true', help='Convert to lowercase')

# 解析命令行参数
args = parser.parse_args()

# 处理参数
if args.uppercase:
    result = args.string.upper()
elif args.lowercase:
    result = args.string.lower()
else:
    result = args.string

# 打印结果
print(result)

在上面的例子中，我们使用ArgumentParser对象创建了一个脚本，该脚本接受一个字符串作为参数，并提供两个选项：”-u”或”–uppercase”用于将字符串转换为大写；”-l”或”–lowercase”用于将字符串转换为小写。

然后，我们使用”parser.parse_args()”方法解析命令行参数，并将结果存储在args变量中。根据args的值，我们执行相应的逻辑，将结果赋给result变量。

最后，我们使用print函数打印结果到控制台。

现在，我们可以使用以下命令行执行脚本，并查看输出结果：

python my_script.py "Hello, World!" -u

输出结果为：

HELLO, WORLD!

可选参数和位置参数

在argparse中，参数分为两种类型：可选参数和位置参数。可选参数通常使用选项（”-u”或”–uppercase”）表示，位置参数没有前缀。

对于可选参数，我们可以使用”add_argument”方法的参数来定义它们的关键字和行为，例如，”action”参数可以指定选项的行为，”help”参数可以为选项提供帮助信息。

对于位置参数，我们只需要在”add_argument”方法中指定参数的类型和帮助信息即可。

默认值

使用argparse，我们还可以为参数和选项设置默认值。例如，我们可以为上面的例子中的字符串参数设置一个默认值为”Hello, World!”，这样当我们不提供字符串参数时，会使用默认值。

# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='Convert a string to uppercase or lowercase.')

# 添加参数
parser.add_argument('string', type=str, default='Hello, World!', nargs='?', help='The input string')
parser.add_argument('-u', '--uppercase', action='store_true', help='Convert to uppercase')
parser.add_argument('-l', '--lowercase', action='store_true', help='Convert to lowercase')

# 解析命令行参数
args = parser.parse_args()

# 处理参数
if args.uppercase:
    result = args.string.upper()
elif args.lowercase:
    result = args.string.lower()
else:
    result = args.string

# 打印结果
print(result)

现在，当我们不提供字符串参数时，会使用默认值”Hello, World!”。例如，执行以下命令行：

python my_script.py -u

输出结果为：

HELLO, WORLD!

提供帮助和使用信息

argparse不仅可以解析命令行参数，还可以自动生成帮助信息和使用信息。我们只需要在”ArgumentParser”对象的”add_argument”方法中提供帮助信息和使用信息即可。

例如，我们可以为上面的例子提供一个更详细的帮助信息和使用信息：

# 创建ArgumentParser对象
parser = argparse.ArgumentParser(description='Convert a string to uppercase or lowercase.')

# 添加参数
parser.add_argument('string', type=str, default='Hello, World!', nargs='?', help='The input string')
parser.add_argument('-u', '--uppercase', action='store_true', help='Convert the string to uppercase')
parser.add_argument('-l', '--lowercase', action='store_true', help='Convert the string to lowercase')

# 解析命令行参数
args = parser.parse_args()

# 处理参数
if args.uppercase:
    result = args.string.upper()
elif args.lowercase:
    result = args.string.lower()
else:
    result = args.string

# 打印结果
print(result)

现在，我们可以使用”-h”或”–help”选项来获取帮助信息和使用信息：

python my_script.py -h

输出结果为：

usage: my_script.py [-h] [-u] [-l] [string]

Convert a string to uppercase or lowercase.

positional arguments:
  string         The input string (default: Hello, World!)

optional arguments:
  -h, --help     show this help message and exit
  -u, --uppercase
                 Convert the string to uppercase
  -l, --lowercase
                 Convert the string to lowercase