Python 处理命令行参数

Python 处理命令行参数

1 概述

在 Python 脚本中处理命令行参数，最常用的方法是使用 argparse 模块，它提供了强大且灵活的命令行参数解析功能。以下是一个基本的示例，展示了如何使用 argparse 来处理命令行参数。

2 示例

import argparse

def main():
    # 创建一个 ArgumentParser 对象
    parser = argparse.ArgumentParser(description="This is an example for handling command-line arguments")
    
    # 添加参数
    # 位置参数（positional arguments），不需要前缀，如 - 或 --
    parser.add_argument('filename', type=str, help='to be handled file')
    
    # 可选参数（optional arguments），通常使用 - 或 -- 前缀
    parser.add_argument('--verbose', '-v', action='store_true', help='enable verbose mode')
    parser.add_argument('--count', '-c', type=int, default=1, help='to be handled count, default: 1')
    
    # 解析命令行参数
    args = parser.parse_args()
    
    # 使用解析后的参数
    print(f"file name: {args.filename}")
    print(f"vebose mode: {'yes' if args.verbose else 'no'}")
    print(f"count: {args.count}")

if __name__ == "__main__":
    main()

在这个示例中：

1. 我们创建了一个 ArgumentParser 对象，并为其提供了描述信息。
2. 使用 add_argument 方法添加了三个参数：
   • filename 是一个位置参数，用户必须提供。
   • --verbose 或 -v 是一个可选参数，如果提供，则 args.verbose 将为 True。
   • --count 或 -c 是一个可选参数，它接受一个整数，并有一个默认值 1。
3. 调用 parse_args 方法解析命令行参数，并将结果存储在 args 对象中。
4. 使用解析后的参数执行一些操作，例如打印它们。

要运行这个脚本并提供命令行参数，你可以使用类似以下的命令：

python script.py example.txt --verbose --count 3

这将输出：

file name: example.txt
vebose mode: yes
count: 3

如果你不提供 filename 参数，或者提供的参数格式不正确，argparse 将自动打印一条错误消息和如何使用脚本的帮助信息。这是 argparse 的一个强大功能，它帮助用户了解如何正确使用你的脚本。

usage: script.py [-h] [--verbose] [--count COUNT] filename
script.py: error: the following arguments are required: filename

脚本中的 --verbose 使用的是 action='store_true' 参数（行为参数），行为参数是一种特殊的可选参数，它只有 True 和 False 两个值，用于标记使用。代码中只需要在 add_argument() 方法中添加 action 参数，并将值设置为 store_true 即可。

3 总结

在 Python 脚本开发过程中，argparse 模块允许你轻松地定义、解析和处理命令行参数。argparse 模块还提供了命令行出错以及帮助信息的自动生成功能，能够帮助用户更好地理解和正确使用你的 Python 脚本，提升程序的交互性与易用性，为用户提供良好的使用体验。