argparse
是 Python 标准库中的一个模块,用于编写用户友好的命令行接口。它使得编写用户友好的命令行程序变得简单、直接和快速。argparse
会自动从 sys.argv
解析出命令行参数,并根据你定义的程序来生成帮助和使用手册,并在用户给程序传入无效参数时报错。
基本使用
首先,你需要导入 argparse
模块,并创建一个 ArgumentParser
对象。然后,使用 add_argument()
方法向该对象添加你要接受的命令行参数。最后,使用 parse_args()
方法解析添加到 ArgumentParser
对象的参数。
示例
下面是一个简单的示例,展示了如何使用 argparse
来解析命令行参数:
python">import argparse # 创建 ArgumentParser 对象
parser = argparse.ArgumentParser(description='示例脚本') # 添加参数
parser.add_argument('--input', type=str, help='输入文件')
parser.add_argument('--verbose', action='store_true', help='增加输出信息的详细程度') # 解析参数
args = parser.parse_args() # 使用参数
if args.verbose: print("Verbose mode is on.")
if args.input: print(f"Input file is {args.input}")
else: print("No input file specified.")
在这个例子中,我们定义了两个命令行参数:--input
和 --verbose
。--input
参数接受一个字符串类型的值,而 --verbose
是一个标志(flag),不需要值,当它被指定时,args.verbose
会被设置为 True
。
参数类型
add_argument()
方法中的 type
参数允许你指定命令行参数应该被转换成的类型。默认情况下,参数被当作字符串处理。但是,你可以指定 int
、float
、file
等其他类型。
默认值
你可以通过 default
参数为命令行参数指定一个默认值。如果命令行中没有提供该参数,则使用默认值。
位置参数
除了可选参数(即前面带有 --
的参数)之外,argparse
还支持位置参数。位置参数是命令行中按照特定顺序出现的参数,它们不需要 --
前缀。
子命令
argparse
还支持子命令,这允许你的程序根据用户指定的子命令来执行不同的操作。
完整性和错误处理
argparse
会自动处理许多常见的错误情况,比如缺少必需的参数、参数类型不匹配等,并会生成清晰的错误消息。此外,你还可以使用 ArgumentParser
对象的 error
方法来自定义错误处理逻辑。
帮助和文档
argparse
会自动生成帮助和文档。用户可以通过在命令行中指定 --help
或 -h
参数来查看帮助信息。
总的来说,argparse
是一个功能强大且易于使用的模块,它可以帮助你编写出用户友好的命令行程序。