下面是关于python add_argument()
用法解析的详细攻略。
1. 什么是argparse
库
argparse
是Python标准库中非常实用的命令行解析工具,可以将程序用命令行调用时输入的参数进行解析并传递给程序,同时在程序文档上自动生成对应位置参数和可选参数的使用说明,应用广泛。
2. add_argument()
方法用法
add_argument()
是argparse.ArgumentParser()
类中最为重要的方法之一,它用于向解析器中添加参数。它共有4个参数,分别为:
-
name or flags:
参数名称或选项,既可以是短选项(如'-f'
),也可以是长选项(如'--file'
)。 -
action:
参数的行为,默认是store
,即保存值。 -
dest:
读取参数之后所保存到变量的名称 or “官方名称”。 -
help:
参数的帮助信息。
一个典型的使用方法如下所示:
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-f", "--file", dest="filename", help="write report to FILE", metavar="FILE")
args = parser.parse_args()
在上述代码中,-f
和--file
是参数的命令行选项(短选项和长选项);filename
是读取参数之后所保存的变量名称(官方名称);help
则是该参数的帮助信息,当用户输入-h
选项时会显示这条帮助信息。
3. add_argument()
示例
示例1:设置可选参数
下面的示例代码演示了如何使用add_argument()
方法设置一个可选参数--verbose
。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("-v", "--verbose", help="display verbose logging messages", action="store_true")
args = parser.parse_args()
if args.verbose:
print("Verbose mode is on.")
else:
print("Verbose mode is off.")
在这个示例中,-v
和--verbose
是参数的命令行选项(短选项和长选项);help
则是该参数的帮助信息;action
的值为store_true
,表示如果用户在命令行中出现了-v
或--verbose
选项,则将变量args.verbose
的值设置为True
。
示例2:设置位置参数
下面的示例代码演示了如何使用add_argument()
方法设置一个位置参数FILENAME
。
import argparse
parser = argparse.ArgumentParser()
parser.add_argument("filename", help="the name of the file to be processed", type=str)
args = parser.parse_args()
print("The file to be processed is: ", args.filename)
在这个示例中,filename
是参数的名称;help
则是该参数的帮助信息;type
的值为str
,表示读取该参数的值时,将其作为字符串处理,并将其保存到变量args.filename
中。
当需要处理的文件名为test.txt
时,用户在命令行输入:
$ python test.py test.txt
则会将test.txt
作为参数传递给程序,并打印出The file to be processed is: test.txt
。
4. 总结
通过本篇攻略的学习,您应该已经掌握了add_argument()
方法的基本用法,以及如何设置可选参数和位置参数。不同的参数类型、行为等等属性可以通过这个强大的方法轻松地在argparse中实现。
本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:python add_argument()用法解析 - Python技术站