轻松掌握add_argument()函数的常见参数设置
发布时间:2024-01-11 05:47:25
在Python中,命令行参数解析是一个常见的需求。argparse是Python的内置模块之一,它提供了一个方便的解析命令行参数的方法。
argparse.ArgumentParser类是进行命令行参数解析的主要工具。它的add_argument()函数是类中的一个方法,用于定义命令行参数的参数选项。
下面是add_argument()函数的常见参数设置及使用示例:
1. name或flags:定义命令行参数的名字或者是选项字符串的列表。name是一个位置参数,flags是一个可选的命名关键字参数。
示例:
parser.add_argument('input_file')
# 定义了一个位置参数,input_file
parser.add_argument('-o', '--output', help='output file')
# 定义了一个短选项'-o'和一个长选项'--output'
2. action:指定处理命令行参数时采取的动作。可以选取的值有:'store'、'store_const'、'store_true'、'store_false'、'append'、'append_const'、'count'、'help'、'version'等。
示例:
parser.add_argument('-l', '--list', action='store_true', help='list files')
# 定义了一个短选项'-l'和一个长选项'--list',当使用'-l'或者'--list'选项时,会将list的值设为True
parser.add_argument('--version', action='version', version='1.0')
# 定义了一个长选项'--version',当使用'--version'选项时,会打印出版本号
3. nargs:命令行参数的个数。可以是固定的值,也可以是'+'、'*'等。
示例:
parser.add_argument('files', nargs='+')
# 定义了一个位置参数files,可以接受一个或多个值
parser.add_argument('--files', nargs=2)
# 定义了一个长选项'--files',可以接受两个值
4. const:当action为'store_const'或'append_const'时,指定存储或追加的常量值。
示例:
parser.add_argument('-v', '--verbose', action='store_const', const=True, default=False)
# 定义了一个短选项'-v'和一个长选项'--verbose',当使用'-v'或'--verbose'选项时,会将verbose的值设为True
parser.add_argument('-l', '--level', action='append_const', const='info')
# 定义了一个短选项'-l'和一个长选项'--level',当使用'-l'或'--level'选项时,会将level的值追加为'info'
5. default:命令行参数的默认值。
示例:
parser.add_argument('-o', '--output', default='output.txt')
# 定义了一个短选项'-o'和一个长选项'--output',如果不提供该选项,则output的值为'output.txt'
6. type:指定命令行参数的类型。
示例:
parser.add_argument('-n', '--num', type=int)
# 定义了一个短选项'-n'和一个长选项'--num',将输入的值转换为整数类型
7. choices:命令行参数的取值范围。
示例:
parser.add_argument('--color', choices=['red', 'green', 'blue'])
# 定义了一个长选项'--color',取值可以是'red'、'green'或'blue'
以上是add_argument()函数的常见参数设置及使用示例。通过灵活运用这些参数,我们可以方便地定义和解析出我们所需的命令行参数。
