argparse
是 Python 中的一个标准库,它提供了一种方便的方式来处理命令行参数。ArgumentParser
是 argparse
中的一个类,它用于解析命令行参数并生成帮助文档。
以下是 ArgumentParser
的基本使用方法:
- 创建
ArgumentParser
对象:import argparse parser = argparse.ArgumentParser(description='description of the program')
- 添加参数:
parser.add_argument('arg1', help='help for arg1') parser.add_argument('--arg2', help='help for arg2') parser.add_argument('-a', '--arg3', help='help for arg3')
add_argument
方法接受多个参数,其中第一个参数是参数名称,可以是位置参数或可选参数,后面可以添加一些配置选项,如:help
参数用于指定参数的帮助信息。 - 解析参数:
args = parser.parse_args()
parse_args
方法会解析命令行参数并返回一个Namespace
对象,该对象包含了所有解析出来的参数。 - 使用参数:
print(args.arg1) print(args.arg2) print(args.arg3)
可以通过
args
对象来获取解析出来的参数。完整代码示例:
import argparse parser = argparse.ArgumentParser(description='description of the program') parser.add_argument('arg1', help='help for arg1') parser.add_argument('--arg2', help='help for arg2') parser.add_argument('-a', '--arg3', help='help for arg3') args = parser.parse_args() print(args.arg1) print(args.arg2) print(args.arg3)
执行代码时可以在命令行中传入参数来测试,例如:
$ python myprogram.py value1 --arg2 value2 -a value3 value1 value2 value3
更多的使用方法和配置选项可以查看
argparse
的文档。