Python脚本传参(argparse模块)2022-08-23
Python传参
- 简便版
import sys
input=sys.argv[1]
print(input)
- 进阶版
import argparse
parser = argparse.ArgumentParser(description='Test scripts.')
parser.add_argument('-i', '--input', type=str, required=True,metavar='input_value',help='input test',default=None)
args = parser.parse_args()
print(args.input)
Python使用argparse模块传参
Python系统自带的传参用到sys模块,第一个参数是sys.argv[1],第二个参数是sys.argv[2]。如果只有一两个参数可以使用这种方法,但是如果参数较多还是用有名的参数比较妥。
第一步,构建参数对象
import argparse
parser = argparse.ArgumentParser(description='Process some integers.')
常用的参数有:脚本描述description,脚本名称prog,与描述description类似的epilog(再help界面description内容显示在前面,epilog内容显示在后面),使用方法usage默认自动从参数中获取使用方法,也可以自定义,add_help是否添加帮助参数-h和--help(默认为True),其它基本用不上。一般只需要传入description参数进行描述,其它用默认即可。
感兴趣可以到官网查看参数的详细完整介绍,所有参数如下:
class argparse.ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparse.HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)
-
prog - The name of the program (default:
sys.argv[0]
) -
usage - The string describing the program usage (default: generated from arguments added to parser)
-
description - Text to display before the argument help (default: none)
-
epilog - Text to display after the argument help (default: none)
-
parents - A list of
ArgumentParser
objects whose arguments should also be included -
formatter_class - A class for customizing the help output
-
prefix_chars - The set of characters that prefix optional arguments (default: ‘-‘)
-
fromfile_prefix_chars - The set of characters that prefix files from which additional arguments should be read (default:
None
) -
argument_default - The global default value for arguments (default:
None
) -
conflict_handler - The strategy for resolving conflicting optionals (usually unnecessary)
-
add_help - Add a
-h/--help
option to the parser (default:True
)
第二步,使用add_argument添加需要传入的参数信息
parser.add_argument('--sum', dest='accumulate', action='store_const',
const=sum, default=max,
help='sum the integers (default: find the max)')
常用参数有:
- 参数名,一般设置两个,短名用一个横杠加一个字母例如-f(可选项),长名用两个横杠加一个单词例如--foo(必选项),也可以不加横杠直接用单词,英文名叫positional arguments,位置参数,例如bar,表示除了指定参数外的参数,例如python test.py 1 -f 2,1会传给bar,而2会传给-f。
- 参数操作action,默认为store,即存储参数的实际内容,有时候我们不需要传入具体参数的值,只需要逻辑值,则可以使用action,设置为store_const,则要结合const,使得参数有对应的一个数值,例如action='store_const', const=42,store_true则表示如果有这个参数则这个参数为真值True,如果没有则是False,store_false则表示如果有这个参数则这个参数为假值False,反之为True。例如python test.py --foo(注意,这里的--foo没有传入参数),如果设置--foo事,action=“store_true”,则foo=True。除此之外,action还可以进行计数等其它操作。
- 默认值default,一般default=None。
- 限定类型type,一般数字为float或int,字符串为str。
- 限定选择choices,指定可选项,一般为列表
- 必选参数required,默认为非必选False,可设置为True
- 帮助信息help,生成帮助文档时,显示的内容,介绍参数内容,
help信息调用参数里的参数方法:以%(prog)s为例,调用prog参数内容 - 参数别名metavar,如果传入了这个参数,会显示在帮助文档,默认为参数名大写,例如--foo,期metavar默认为FOO。
- 传入参数变量名dest,位置参数名默认为bar,其它参数为短名或长名去掉横杠后的字母,例如--foo的dest就是foo
完整参数列表如下:
ArgumentParser.add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])
-
name or flags - Either a name or a list of option strings, e.g.
foo
or-f, --foo
. -
action - The basic type of action to be taken when this argument is encountered at the command line.
-
nargs - The number of command-line arguments that should be consumed.
-
const - A constant value required by some action and nargs selections.
-
default - The value produced if the argument is absent from the command line.
-
type - The type to which the command-line argument should be converted.
-
choices - A container of the allowable values for the argument.
-
required - Whether or not the command-line option may be omitted (optionals only).
-
help - A brief description of what the argument does.
-
metavar - A name for the argument in usage messages.
-
dest - The name of the attribute to be added to the object returned by
parse_args()
.
第三步,使用parse_args获取参数列表
args = parser.parse_args()
那怎么获取参数呢?
input=args.input
如果定义参数的时候既有短名又有长名,则用长名,如果只有短名,则用短名,例如添加参数的时候有-i和--input,则用args.input,如果只有-i,则可以用args.i。
在Python控制台传参的方法:
parser.parse_args('a b --foo x y --bar 1 2'.split())
脚本使用示例
把以下代码写进脚本test.py中:
import argparse
parser = argparse.ArgumentParser(description='Test scripts.')
parser.add_argument('-i', '--input', type=str, required=True,metavar='', help='input test',default=None)
#添加位置参数,实际应用中可以不加这个
parser.add_argument('bar',default=None)
args = parser.parse_args()
print(args.input)
print(args.bar)
接着运行以下脚本:
#查看帮助文档
~ $ python test.py -h
usage: test.py [-h] -i bar
Test scripts.
positional arguments:
bar
optional arguments:
-h, --help show this help message and exit
-i , --input input test
#运行脚本
~ $ python test.py -i test oo
test
oo
~ $ python test.py oo --input test
test
oo