常用python代码大全-python使用argparse模块处理命令行参数

argparse 是 Python 的一个标准库模块，用于从命令行解析参数。这个模块使编写用户友好的命令行接口变得更加简单。下面是一个使用 argparse 模块处理命令行参数的示例代码：

import argparse

# 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description='这是一个示例程序')

# 添加参数
parser.add_argument('--input', type=str, help='输入文件')
parser.add_argument('--output', type=str, help='输出文件')
parser.add_argument('--verbose', action='store_true', help='详细输出')

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

# 使用参数
if args.input:
    print(f"输入文件: {args.input}")
if args.output:
    print(f"输出文件: {args.output}")
if args.verbose:
    print("详细输出模式")

在这个示例中，我们首先导入了 argparse 模块。然后，我们创建了一个 ArgumentParser 对象，它代表我们的命令行界面。接着，我们使用 add_argument 方法添加了三个参数：--input、--output 和 --verbose。这些参数具有不同的类型和用途：

• --input 是一个字符串类型的参数，表示输入文件。
• --output 是一个字符串类型的参数，表示输出文件。
• --verbose 是一个布尔类型的参数，表示是否启用详细输出模式。

在 add_argument 方法中，我们还指定了每个参数的帮助信息，这些信息将在命令行中显示，以帮助用户了解每个参数的作用。

最后，我们使用 parse_args 方法解析命令行参数，并将解析结果存储在 args 变量中。现在，我们可以使用 args.input、args.output 和 args.verbose 来访问解析后的参数值。如果某个参数存在，就可以执行相应的操作；否则，可以执行默认操作或什么都不做。

这个示例演示了如何使用 argparse 模块处理命令行参数的基本用法。通过添加更多的参数和逻辑，你可以构建更复杂的命令行界面。

当然，argparse 模块的功能远不止于此。以下是一些更高级的用法：

1.位置参数：除了命名参数外，还可以添加位置参数。例如：

parser.add_argument('input_file')

2.参数默认值：可以为参数设置默认值。例如：

parser.add_argument('--input', default='default_input.txt')

3.参数类型：除了基本的字符串和布尔类型，还可以使用其他类型，如整数、浮点数、选择列表等。例如：

parser.add_argument('--age', type=int, choices=range(0, 120))

4.参数的限制和约束：可以设置参数的限制条件，例如参数之间的依赖关系或互斥关系。例如：

group = parser.add_mutually_exclusive_group()
group.add_argument('--method1')
group.add_argument('--method2')

5.参数的子命令：对于复杂的命令行工具，可以使用子命令来区分不同的操作。例如：

subparsers = parser.add_subparsers(dest='command')
subparsers.add_parser('count').add_argument('--verbose')
subparsers.add_parser('find').add_argument('--name')

6.参数的帮助信息：可以使用 help 参数为参数提供更详细的描述。例如：

parser.add_argument('--input', help='The input file to process.')

7.参数的隐藏：有时，你可能希望某些参数对用户隐藏，可以使用 help 参数的布尔值来实现。例如：

parser.add_argument('--internal-parameter', help=argparse.SUPPRESS)

8.参数的自动完成和提示：在某些情况下，可以使用 metavar 参数为命令行提供自动完成提示。例如：

parser.add_argument('--input', metavar='FILE', help='The input file to process.')

9.参数的解析顺序：可以使用 add_argument 方法的 action 参数来指定参数的行为，例如 store_const、append 等。这些行为可以在 parse_args 方法的 action 参数中使用。例如：

parser.add_argument('--flag', action='store_true')  # 默认行为，将值设为 True 或 False
parser.add_argument('--values', action='append')  # 将值添加到列表中，而不是替换现有值

10.参数的命名空间：可以使用 parse_args 方法返回的命名空间来访问解析后的参数。这比直接访问属性更为灵活。例如：

args = parser.parse_args()  # 返回一个命名空间对象，其中包含所有解析后的参数值
print(args.input)  # 访问解析后的参数值，与直接访问属性相同

11.参数的回调函数：可以为参数添加回调函数，在参数被解析后执行特定的操作。例如：

def validate_input_file(value):
    if not os.path.exists(value):
        raise argparse.ArgumentTypeError(f"{value} does not exist")
    return value

parser.add_argument('--input', type=validate_input_file, help='The input file to process.')

12.参数的冲突处理：可以使用 conflicts 参数来指定哪些参数是互斥的，不能同时使用。例如：

parser.add_argument('--method1', conflicts='--method2')

13.参数的命令行选项：可以使用 option_strings 参数为参数指定不同的命令行选项。例如：

parser.add_argument('--input', dest='input_file', option_strings=['--input', '-i'])

14.参数的命名规范：可以使用 dest 参数为参数指定一个名称，这个名称将被用作后续访问的属性名。例如：

parser.add_argument('--input-file', dest='input_file')

这些只是一些基本和高级的用法示例，argparse 模块的功能非常强大，可以满足各种复杂的命令行参数解析需求。更深入的了解和使用，可以参考 Python 的官方文档或其他相关教程。