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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,236评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,867评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,715评论 0 340
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,899评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,895评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,733评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,085评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,722评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,025评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,696评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,816评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,447评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,057评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,254评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,204评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,561评论 2 343

推荐阅读更多精彩内容