python学习之argparse模块

系统管理员 2022-07-16 14:25 288阅读 0赞

一、简介：

argparse是python用于**解析命令行参数和选项的标准模块**，用于代替已经过时的optparse模块。

argparse模块的作用是用于解析命令行参数，

例如 python parseTest.py input.txt output.txt --user=name --port=8080。

二、使用步骤：

1：import argparse

2：parser = argparse.ArgumentParser()

3：parser.add\_argument()

4：parser.parse\_args()

解释：首先导入该模块；然后创建一个解析对象；然后向该对象中添加你要关注的命令行参数和选项，

每一个add\_argument方法对应一个你要关注的参数或选项；**最后调用parse\_args()方法进行解析**；

解析成功之后即可使用，下面简单说明一下步骤2和3。

三、方法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)

这些参数都有默认值，当调用**parser.print\_help()**或者运行程序时由于参数不正确(此时python解释器其实也是调用了pring\_help()方法)时，会打印这些描述信息，一般只需要传递**description参数**，

如上。

四、方法**add\_argument**(name or flags...\[, action\]\[, nargs\]\[, const\]\[, default\]\[, type\]\[, choices\]\[, required\]\[, help\]\[, metavar\]\[, dest\])

其中：

name or flags：命令行参数名或者选项，如上面的address或者-p,--port.

其中**命令行参数如果没给定，且没有设置defualt，则出错。但是如果是选项的话，则设置为None**

**nargs：命令行参数的个数，**

一般使用通配符表示，其中，**'?'表示只用一个，'\*'表示0到多个，'+'表示至少一个**

default：默认值

type：**参数的类型，默认是字符串string类型**，还有float、int等类型

help：和ArgumentParser方法中的参数作用相似，出现的场合也一致

最常用的地方就是这些，其他的可以参考官方文档。下面给出一个例子，基本包括了常见的情形：

import argparse

def parse\_args():

description = usage: %prog \[options\] poetry-file

This is the Slow Poetry Server, blocking edition.

Run it like this:

python slowpoetry.py <path-to-poetry-file>

If you are in the base directory of the twisted-intro package,

you could run it like this:

python blocking-server/slowpoetry.py poetry/ecstasy.txt

to serve up John Donne's Ecstasy, which I know you want to do.

parser = argparse.ArgumentParser(description = description)

help = The addresses to connect.

parser.add\_argument('addresses',nargs = '\*',help = help)

help = The filename to operate on.Default is poetry/ecstasy.txt

parser.add\_argument('filename',help=help)

help = The port to listen on. Default to a random available port.

parser.add\_argument('-p',--port', type=int, help=help)

help = The interface to listen on. Default is localhost.

parser.add\_argument('--iface', help=help, default='localhost')

help = The number of seconds between sending bytes.

parser.add\_argument('--delay', type=float, help=help, default=.7)

help = The number of bytes to send at a time.

parser.add\_argument('--bytes', type=int, help=help, default=10)

**args = parser.parse\_args()**;

return args

if \_\_name\_\_ == '\_\_main\_\_':

args = parse\_args()

for address in **args.addresses**:

print 'The address is : %s .' % address

print 'The filename is : %s .' % args.filename

print 'The port is : %d.' % args.port

print 'The interface is : %s.' % args.iface

print 'The number of seconds between sending bytes : %f'% args.delay

print 'The number of bytes to send at a time : %d.' % args.bytes</path-to-poetry-file>

运行该脚本：python test.py --port 10000 --delay 1.2 127.0.0.1 172.16.55.67 poetry/ecstasy.txt

输出为：

The address is : 127.0.0.1 .

The address is : 172.16.55.67 .

The filename is : poetry/ecstasy.txt .

The port is : 10000.

The interface is : localhost.

The number of seconds between sending bytes : 1.200000

The number of bytes to send at a time : 10.

使用方法：

1、导入argparse模块   import argparse

2、创建argparse对象   **parser = argparse.ArgumentParser()**

3、添加命令行相关参数、选项  parser.add\_argument("...")

4、解析    **parser.parse\_args()**

例一：(删除指定的zabbix screen)

\#!/usr/bin/env python2.7

\#coding=utf-8

import sys

import argparse

import zabbixAuth

import zabbixScreen

if \_\_name\_\_ == "\_\_main\_\_":

\#if len(sys.argv) < 2 :

\#    print "usage:",sys.argv\[0\],"screenName"

\#    sys.exit(1)

\#if sys.argv\[1\] == "-h" or sys.argv\[1\] == "--help":

\#    print "usage:",sys.argv\[0\],"screenName"

\#    sys.exit()

\#以下三行的功能等效于以上的if 语句

parser = argparse.ArgumentParser()  \#创建argparse对象

parser.add\_argument("screenName",help="Specifies the screen name of the is will be deleted")

parser.parse\_args()

userAuth=zabbixAuth.zabbix\_auth()

token=userAuth.user\_login()

screenObj=zabbixScreen.zabbix\_screen()

screenidList=screenObj.screen\_get(token,sys.argv\[1\])

if screenidList != None:

print "screenID:",screenObj.screen\_delete(token,screenidList\[0\]),"delete success"

else:

print "The screen:",sys.argv\[1\],"does not exists"

例二：(创建自定义的zabbix screen)

\#!/usr/bin/env python2.7

\#coding=utf-8

import sys

import argparse

import zabbixAuth

import zabbixScreen

if \_\_name\_\_ == "\_\_main\_\_":

\#if len(sys.argv) < 4 :

\#    print "usage:",sys.argv\[0\],"screenName rows columns"

\#    sys.exit(1)

\#if sys.argv\[1\] == "-h" or sys.argv\[1\] == "--help":

\#    print "usage:",sys.argv\[0\],"screenName rows columns"

\#    sys.exit()

\#if sys.argv\[2\].isdigit()==False or sys.argv\[3\].isdigit()==False:

\#    print "Note: rows and columns is number"

\#    sys.exit()

\#以上注释的if 语句等效于以下5行

parser = argparse.ArgumentParser()

parser.add\_argument("screenName",help="Given a string to set the screen name")

parser.add\_argument("rows",help="Given a number to set the lines",type=int)

parser.add\_argument("columns",help="Given a number to set the columns",type=int)

parser.parse\_args()

if int(sys.argv\[3\])>3 :

print "Note: columns must be less than 3"

sys.exit()

userAuth=zabbixAuth.zabbix\_auth()

token=userAuth.user\_login()

screenObj=zabbixScreen.zabbix\_screen()

screenidList=screenObj.screen\_get(token,sys.argv\[1\])

if screenidList != None:

print "screen already exists"

else:

print "screnn",sys.argv\[1\],"create success, screenid is",screenObj.screen\_create(token,sys.argv\[2\],sys.argv\[3\],sys.argv\[1\])

import  argparse

\_\_version\_\_ = '1.1.1'

parser = argparse.ArgumentParser(description='hahahaaaa')

parser.add\_argument('-V', '--version', action='version', version='%(prog)s '+\_\_version\_\_)

parser.add\_argument('--name','-n',metavar='namemma',dest='name',type=str,help='your name',nargs=1)

parser.add\_argument('-i',metavar='III',action='store\_const',dest='iiii',const='ii',help="dfafsdf")

parser.add\_argument("-z", choices=\['a', 'b', 'd'\],required=False)

parser.add\_argument('foo')

args = parser.parse\_args()

print(type(args))

print(args.name,args.iiii,args.foo)

ArgumentParser参数的简单说明

epilog - 命令行帮助的结尾文字

prog - (default: sys.argv\[0\])程序的名字，一般不需要修改，另外，如果你需要在help中使用到程序的名字，可以使用%(prog)s

prefix\_chars - 命令的前缀，默认是-，例如-f/--file。有些程序可能希望支持/f这样的选项，可以使用prefix\_chars="/"

fromfile\_prefix\_chars - (default: None)如果你希望命令行参数可以从文件中读取，就可能用到。例如，如果fromfile\_prefix\_chars='@',命令行参数中有一个为"@args.txt"，args.txt的内容会作为命令行参数

add\_help - 是否增加-h/-help选项(default:True)，一般help信息都是必须的，所以不用设置啦。

add\_argument:读入命令行参数，该调用有多个参数

ArgumentParser.add\_argument(name or flags…\[, action\]\[, nargs\]\[, const\]\[, default\]\[, type\]\[, choices\]\[, required\]\[, help\]\[, metavar\]\[, dest\])

name or flags:是必须的参数，该参数接受选项参数或者是位置参数（一串文件名）

不带'--'的参数

调用脚本时必须输入值

参数输入的顺序与程序中定义的顺序一致

'-'的参数

可不输入    add\_argument("-a")

类似有'--'的shortname，但程序中的变量名为定义的参数名

'--'参数

参数别名: 只能是1个字符，区分大小写

add\_argument("-shortname","--name", help="params means")，但代码中不能使用shortname

dest: 参数在程序中对应的变量名称 add\_argument("a",dest='code\_name')

default: 参数默认值

help: 参数作用解释  add\_argument("a", help="params means")

type : 默认string  add\_argument("c", type=int)

metavar: 参数的名字，在显示 帮助信息时才用到.

action:

store：默认action模式，存储值到指定变量。

store\_const：存储值在参数的const部分指定，多用于实现非布尔的命令行flag。

store\_true / store\_false：布尔开关。可以2个参数对应一个变量。

append：存储值到列表，该参数可以重复使用。

append\_const：存储值到列表，存储值在参数的const部分指定。

version 输出版本信息然后退出。

const:配合action="store\_const|append\_const"使用，默认值

choices:输入值的范围 add\_argument("--gb", choices=\['A', 'B', 'C', 0\])

required:通常-f这样的选项是可选的，但是如果required=True那么就是必须的了

nsrgs 用来指定参数的个数，可以是1,2,3....也可以是?或\*或+

? 零个或一个

\* 零个或多个

+ 一个或多个

创建子parse,每个子parse对应自己的输入参数

import argparse

\# sub-command functions

def subcmd\_list(args):

print "list"

def subcmd\_create(args):

print "create"

def subcmd\_delete(args):

print "delete"

parser = argparse.ArgumentParser()

subparsers = parser.add\_subparsers(help='commands')

\# A list command

list\_parser = subparsers.add\_parser('list', help='Listcontents')

list\_parser.add\_argument('dirname', action='store',    help='Directory tolist')

list\_parse.set\_defaults(func=subcmd\_list)

\# A create command

create\_parser = subparsers.add\_parser('create', help='Create a directory')

create\_parser.add\_argument('dirname',action='store',help='New directoryto create')

create\_parser.add\_argument('--read-only',default=False, action='store\_true',help='Setpermissions to prevent writing to the directory')

create\_parser .set\_defaults(func=subcmd\_create)

\# A delete command

delete\_parser = subparsers.add\_parser('delete',help='Remove a directory')

delete\_parser.add\_argument( 'dirname', action='store',help='The directory to remove')

delete\_parser.add\_argument('--recursive', '-r',default=False, action='store\_true',help='Remove thecontents of the directory, too')

delete\_parser .set\_defaults(func=subcmd\_delete)

args = parser.parse\_args()

\# call subcmd

args.fun(args)

使用帮助

\# python args\_subparse.py -h

usage: args\_subparse.py \[-h\] \{create,list,delete\} ...

positional arguments:

\{create,list,delete\}  commands

list                Listcontents

create              Create a directory

delete              Remove a directory

optional arguments:

-h, --help            show this help message and exit

\# python args\_subparse.py create -h

usage: args\_subparse.py create \[-h\] \[--read-only\] dirname

positional arguments:

dirname      New directoryto create

optional arguments:

-h, --help   show this help message and exit

--read-only  Setpermissions to prevent writing to the directory

\# python args\_subparse.py delete -h

usage: args\_subparse.py delete \[-h\] \[--recursive\] dirname

positional arguments:

dirname          The directory to remove

optional arguments:

-h, --help       show this help message and exit

--recursive, -r  Remove thecontents of the directory, too

\# python args\_subparse.py list -h

usage: args\_subparse.py list \[-h\] dirname

positional arguments:

dirname     Directory tolist

optional arguments:

-h, --help  show this help message and exit

多个subparser 使用同样定义的参数

\# add\_help=False,必须指定，否则报-h重复定义

parents\_parser = argparse.ArgumentParser(add\_help=False)

parents\_parser.add\_argument('--foo', dest="foo", action='store\_true')

parents\_parser.add\_argument('--bar', dest="bar", action='store\_false')

parents\_parser.add\_argument('--baz', dest="baz", action='store\_false')

parser = argparse.ArgumentParser()

subparsers = parser.add\_subparsers(help='commands')

m\_parser = subparsers.add\_parser("mysql", parents=\[parents\_parser\], help="mysql method")

m\_parser.set\_defaults(func=sub\_mysql)

o\_parser = subparsers.add\_parser("oracle", parents=\[parents\_parser\], help="oracle method")

o\_parser.set\_defaults(func=sub\_oracle)

args = parser.parse\_args()

import argparse

parse = argparse.ArgumentParser()

parse.add\_argument("a", help="params means")

parse.add\_argument("-C", "--gc", default="count")

parse.add\_argument("--ga", help="params means ga",dest='simple\_value',choices=\['A', 'B', 'C', 0\])

parse.add\_argument("--gb", help="params means gb",action="store\_const",const='value-to-store')

args = parse.parse\_args()

print args.simple\_value,args.gb,args.gc

\#\#\# add\_argument 说明

不带'--'的参数

调用脚本时必须输入值

参数输入的顺序与程序中定义的顺序一致

'-'的参数

可不输入    add\_argument("-a")

类似有'--'的shortname，但程序中的变量名为定义的参数名

'--'参数

参数别名: 只能是1个字符，区分大小写

add\_argument("-shortname","--name", help="params means")，但代码中不能使用shortname

dest: 参数在程序中对应的变量名称 add\_argument("a",dest='code\_name')

default: 参数默认值

help: 参数作用解释  add\_argument("a", help="params means")

type : 默认string  add\_argument("c", type=int)

action:

store：默认action模式，存储值到指定变量。

store\_const：存储值在参数的const部分指定，多用于实现非布尔的命令行flag。

store\_true / store\_false：布尔开关。可以2个参数对应一个变量。

append：存储值到列表，该参数可以重复使用。

append\_const：存储值到列表，存储值在参数的const部分指定。

version 输出版本信息然后退出。

const:配合action="store\_const|append\_const"使用，默认值

choices:输入值的范围 add\_argument("--gb", choices=\['A', 'B', 'C', 0\])

from optparse import OptionParser

\[...\]

parser = OptionParser()

parser.add\_option("-f", "--file", dest="filename",

help="write report to FILE", metavar="FILE")

parser.add\_option("-q", "--quiet",

action="store\_false", dest="verbose", default=True,

help="don't print status messages to stdout")

(options, args) = parser.parse\_args()

现在，妳就可以在命令行下输入：

<yourscript> --file=outfile -q

<yourscript> -f outfile --quiet

<yourscript> --quiet --file outfile

<yourscript> -q -foutfile

<yourscript> -qfoutfile

上面这些命令是相同效果的。除此之外， optparse 还为我们自动生成命令行的帮助信息：

<yourscript> -h

<yourscript> --help

输出：

usage: <yourscript> \[options\]

options:

-h, --help            show this help message and exit

-f FILE, --file=FILE  write report to FILE

-q, --quiet           don't print status messages to stdout

简单流程

首先，必须 import OptionParser 类，创建一个 OptionParser 对象：

from optparse import OptionParser

\[...\]

parser = OptionParser()

然后，使用 add\_option 来定义命令行参数：

parser.add\_option(opt\_str, ...,

attr=value, ...)

每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名：

parser.add\_option("-f", "--file", ...)

最后，一旦你已经定义好了所有的命令行参数，调用 parse\_args() 来解析程序的命令行：

**(options, args) = parser.parse\_args() **

注： 你也可以传递一个命令行参数列表到 parse\_args()；否则，默认使用 sys.argv\[:1\]。

parse\_args() 返回的两个值：

options，它是一个对象（optpars.Values），保存有命令行参数值。只要知道命令行参数名，如 file，就可以访问其对应的值： options.file 。

args，它是一个由 positional arguments 组成的列表。

Actions

action 是 parse\_args() 方法的参数之一，它指示 optparse 当解析到一个命令行参数时该如何处理。actions 有一组固定的值可供选择，默认是’store ‘，表示将命令行参数值保存在 options 对象里。

示例

parser.add\_option("-f", "--file",

action="store", type="string", dest="filename")

args = \["-f", "foo.txt"\]

(options, args) = parser.parse\_args(args)

print options.filename

最后将会打印出 “foo.txt”。

当 optparse 解析到’-f’，会继续解析后面的’foo.txt’，然后将’foo.txt’保存到 options.filename 里。当调用 parser.args() 后，options.filename 的值就为’foo.txt’。

你也可以指定 add\_option() 方法中 type 参数为其它值，如 int 或者 float 等等：

parser.add\_option("-n", type="int", dest="num")

默认地，type 为’string’。也正如上面所示，长参数名也是可选的。其实，dest 参数也是可选的。如果没有指定 dest 参数，将用命令行的参数名来对 options 对象的值进行存取。

store 也有其它的两种形式： store\_true 和 store\_false ，用于处理带命令行参数后面不 带值的情况。如 -v,-q 等命令行参数：

parser.add\_option("-v", action="store\_true", dest="verbose")

parser.add\_option("-q", action="store\_false", dest="verbose")

这样的话，当解析到 ‘-v’，options.verbose 将被赋予 True 值，反之，解析到 ‘-q’，会被赋予 False 值。

其它的 actions 值还有：

store\_const 、append 、count 、callback 。

默认值

parse\_args() 方法提供了一个 default 参数用于设置默认值。如：

parser.add\_option("-f","--file", action="store", dest="filename", default="foo.txt")

parser.add\_option("-v", action="store\_true", dest="verbose", default=True)

又或者使用 set\_defaults()：

parser.set\_defaults(filename="foo.txt",verbose=True)

parser.add\_option(...)

(options, args) = parser.parse\_args()

from optparse import OptionParser

\[...\]

def main():

usage = "usage: %prog \[options\] arg"

parser = OptionParser(usage)

parser.add\_option("-f", "--file", dest="filename",

help="read data from FILENAME")

parser.add\_option("-v", "--verbose",

action="store\_true", dest="verbose")

parser.add\_option("-q", "--quiet",

action="store\_false", dest="verbose")

\[...\]

(options, args) = parser.parse\_args()

if len(args) != 1:

parser.error("incorrect number of arguments")

if options.verbose:

print "reading %s..." % options.filename

\[...\]

if \_\_name\_\_ == "\_\_main\_\_":

main()

一、简介：

argparse是python用于**解析命令行参数和选项的标准模块**，用于代替已经过时的optparse模块。

argparse模块的作用是用于解析命令行参数，

例如 python parseTest.py input.txt output.txt --user=name --port=8080。

二、使用步骤：

1：import argparse

2：parser = argparse.ArgumentParser()

3：parser.add\_argument()

4：parser.parse\_args()

解释：首先导入该模块；然后创建一个解析对象；然后向该对象中添加你要关注的命令行参数和选项，

每一个add\_argument方法对应一个你要关注的参数或选项；**最后调用parse\_args()方法进行解析**；

解析成功之后即可使用，下面简单说明一下步骤2和3。

如上。

四、方法**add\_argument**(name or flags...\[, action\]\[, nargs\]\[, const\]\[, default\]\[, type\]\[, choices\]\[, required\]\[, help\]\[, metavar\]\[, dest\])

其中：

name or flags：命令行参数名或者选项，如上面的address或者-p,--port.

其中**命令行参数如果没给定，且没有设置defualt，则出错。但是如果是选项的话，则设置为None**

**nargs：命令行参数的个数，**

一般使用通配符表示，其中，**'?'表示只用一个，'\*'表示0到多个，'+'表示至少一个**

default：默认值

type：**参数的类型，默认是字符串string类型**，还有float、int等类型

help：和ArgumentParser方法中的参数作用相似，出现的场合也一致

最常用的地方就是这些，其他的可以参考官方文档。下面给出一个例子，基本包括了常见的情形：

import argparse

def parse\_args():

description = usage: %prog \[options\] poetry-file

This is the Slow Poetry Server, blocking edition.

Run it like this:

python slowpoetry.py <path-to-poetry-file>

If you are in the base directory of the twisted-intro package,

you could run it like this:

python blocking-server/slowpoetry.py poetry/ecstasy.txt

to serve up John Donne's Ecstasy, which I know you want to do.

parser = argparse.ArgumentParser(description = description)

help = The addresses to connect.

parser.add\_argument('addresses',nargs = '\*',help = help)

help = The filename to operate on.Default is poetry/ecstasy.txt

parser.add\_argument('filename',help=help)

help = The port to listen on. Default to a random available port.

parser.add\_argument('-p',--port', type=int, help=help)

help = The interface to listen on. Default is localhost.

parser.add\_argument('--iface', help=help, default='localhost')

help = The number of seconds between sending bytes.

parser.add\_argument('--delay', type=float, help=help, default=.7)

help = The number of bytes to send at a time.

parser.add\_argument('--bytes', type=int, help=help, default=10)

**args = parser.parse\_args()**;

return args

if \_\_name\_\_ == '\_\_main\_\_':

args = parse\_args()

for address in **args.addresses**:

print 'The address is : %s .' % address

print 'The filename is : %s .' % args.filename

print 'The port is : %d.' % args.port

print 'The interface is : %s.' % args.iface

print 'The number of seconds between sending bytes : %f'% args.delay

print 'The number of bytes to send at a time : %d.' % args.bytes</path-to-poetry-file>

运行该脚本：python test.py --port 10000 --delay 1.2 127.0.0.1 172.16.55.67 poetry/ecstasy.txt

输出为：

The address is : 127.0.0.1 .

The address is : 172.16.55.67 .

The filename is : poetry/ecstasy.txt .

The port is : 10000.

The interface is : localhost.

The number of seconds between sending bytes : 1.200000

The number of bytes to send at a time : 10.

使用方法：

1、导入argparse模块   import argparse

2、创建argparse对象   **parser = argparse.ArgumentParser()**

3、添加命令行相关参数、选项  parser.add\_argument("...")

4、解析    **parser.parse\_args()**

例一：(删除指定的zabbix screen)

\#!/usr/bin/env python2.7

\#coding=utf-8

import sys

import argparse

import zabbixAuth

import zabbixScreen

if \_\_name\_\_ == "\_\_main\_\_":

\#if len(sys.argv) < 2 :

\#    print "usage:",sys.argv\[0\],"screenName"

\#    sys.exit(1)

\#if sys.argv\[1\] == "-h" or sys.argv\[1\] == "--help":

\#    print "usage:",sys.argv\[0\],"screenName"

\#    sys.exit()

\#以下三行的功能等效于以上的if 语句

parser = argparse.ArgumentParser()  \#创建argparse对象

parser.add\_argument("screenName",help="Specifies the screen name of the is will be deleted")

parser.parse\_args()

userAuth=zabbixAuth.zabbix\_auth()

token=userAuth.user\_login()

screenObj=zabbixScreen.zabbix\_screen()

screenidList=screenObj.screen\_get(token,sys.argv\[1\])

if screenidList != None:

print "screenID:",screenObj.screen\_delete(token,screenidList\[0\]),"delete success"

else:

print "The screen:",sys.argv\[1\],"does not exists"

例二：(创建自定义的zabbix screen)

\#!/usr/bin/env python2.7

\#coding=utf-8

import sys

import argparse

import zabbixAuth

import zabbixScreen

if \_\_name\_\_ == "\_\_main\_\_":

\#if len(sys.argv) < 4 :

\#    print "usage:",sys.argv\[0\],"screenName rows columns"

\#    sys.exit(1)

\#if sys.argv\[1\] == "-h" or sys.argv\[1\] == "--help":

\#    print "usage:",sys.argv\[0\],"screenName rows columns"

\#    sys.exit()

\#if sys.argv\[2\].isdigit()==False or sys.argv\[3\].isdigit()==False:

\#    print "Note: rows and columns is number"

\#    sys.exit()

\#以上注释的if 语句等效于以下5行

parser = argparse.ArgumentParser()

parser.add\_argument("screenName",help="Given a string to set the screen name")

parser.add\_argument("rows",help="Given a number to set the lines",type=int)

parser.add\_argument("columns",help="Given a number to set the columns",type=int)

parser.parse\_args()

if int(sys.argv\[3\])>3 :

print "Note: columns must be less than 3"

sys.exit()

userAuth=zabbixAuth.zabbix\_auth()

token=userAuth.user\_login()

screenObj=zabbixScreen.zabbix\_screen()

screenidList=screenObj.screen\_get(token,sys.argv\[1\])

if screenidList != None:

print "screen already exists"

else:

print "screnn",sys.argv\[1\],"create success, screenid is",screenObj.screen\_create(token,sys.argv\[2\],sys.argv\[3\],sys.argv\[1\])

import  argparse

\_\_version\_\_ = '1.1.1'

parser = argparse.ArgumentParser(description='hahahaaaa')

parser.add\_argument('-V', '--version', action='version', version='%(prog)s '+\_\_version\_\_)

parser.add\_argument('--name','-n',metavar='namemma',dest='name',type=str,help='your name',nargs=1)

parser.add\_argument('-i',metavar='III',action='store\_const',dest='iiii',const='ii',help="dfafsdf")

parser.add\_argument("-z", choices=\['a', 'b', 'd'\],required=False)

parser.add\_argument('foo')

args = parser.parse\_args()

print(type(args))

print(args.name,args.iiii,args.foo)

ArgumentParser参数的简单说明

epilog - 命令行帮助的结尾文字

prog - (default: sys.argv\[0\])程序的名字，一般不需要修改，另外，如果你需要在help中使用到程序的名字，可以使用%(prog)s

prefix\_chars - 命令的前缀，默认是-，例如-f/--file。有些程序可能希望支持/f这样的选项，可以使用prefix\_chars="/"

add\_help - 是否增加-h/-help选项(default:True)，一般help信息都是必须的，所以不用设置啦。

add\_argument:读入命令行参数，该调用有多个参数

ArgumentParser.add\_argument(name or flags…\[, action\]\[, nargs\]\[, const\]\[, default\]\[, type\]\[, choices\]\[, required\]\[, help\]\[, metavar\]\[, dest\])

name or flags:是必须的参数，该参数接受选项参数或者是位置参数（一串文件名）

不带'--'的参数

调用脚本时必须输入值

参数输入的顺序与程序中定义的顺序一致

'-'的参数

可不输入    add\_argument("-a")

类似有'--'的shortname，但程序中的变量名为定义的参数名

'--'参数

参数别名: 只能是1个字符，区分大小写

add\_argument("-shortname","--name", help="params means")，但代码中不能使用shortname

dest: 参数在程序中对应的变量名称 add\_argument("a",dest='code\_name')

default: 参数默认值

help: 参数作用解释  add\_argument("a", help="params means")

type : 默认string  add\_argument("c", type=int)

metavar: 参数的名字，在显示 帮助信息时才用到.

action:

store：默认action模式，存储值到指定变量。

store\_const：存储值在参数的const部分指定，多用于实现非布尔的命令行flag。

store\_true / store\_false：布尔开关。可以2个参数对应一个变量。

append：存储值到列表，该参数可以重复使用。

append\_const：存储值到列表，存储值在参数的const部分指定。

version 输出版本信息然后退出。

const:配合action="store\_const|append\_const"使用，默认值

choices:输入值的范围 add\_argument("--gb", choices=\['A', 'B', 'C', 0\])

required:通常-f这样的选项是可选的，但是如果required=True那么就是必须的了

nsrgs 用来指定参数的个数，可以是1,2,3....也可以是?或\*或+

? 零个或一个

\* 零个或多个

+ 一个或多个

创建子parse,每个子parse对应自己的输入参数

import argparse

\# sub-command functions

def subcmd\_list(args):

print "list"

def subcmd\_create(args):

print "create"

def subcmd\_delete(args):

print "delete"

parser = argparse.ArgumentParser()

subparsers = parser.add\_subparsers(help='commands')

\# A list command

list\_parser = subparsers.add\_parser('list', help='Listcontents')

list\_parser.add\_argument('dirname', action='store',    help='Directory tolist')

list\_parse.set\_defaults(func=subcmd\_list)

\# A create command

create\_parser = subparsers.add\_parser('create', help='Create a directory')

create\_parser.add\_argument('dirname',action='store',help='New directoryto create')

create\_parser.add\_argument('--read-only',default=False, action='store\_true',help='Setpermissions to prevent writing to the directory')

create\_parser .set\_defaults(func=subcmd\_create)

\# A delete command

delete\_parser = subparsers.add\_parser('delete',help='Remove a directory')

delete\_parser.add\_argument( 'dirname', action='store',help='The directory to remove')

delete\_parser.add\_argument('--recursive', '-r',default=False, action='store\_true',help='Remove thecontents of the directory, too')

delete\_parser .set\_defaults(func=subcmd\_delete)

args = parser.parse\_args()

\# call subcmd

args.fun(args)

使用帮助

\# python args\_subparse.py -h

usage: args\_subparse.py \[-h\] \{create,list,delete\} ...

positional arguments:

\{create,list,delete\}  commands

list                Listcontents

create              Create a directory

delete              Remove a directory

optional arguments:

-h, --help            show this help message and exit

\# python args\_subparse.py create -h

usage: args\_subparse.py create \[-h\] \[--read-only\] dirname

positional arguments:

dirname      New directoryto create

optional arguments:

-h, --help   show this help message and exit

--read-only  Setpermissions to prevent writing to the directory

\# python args\_subparse.py delete -h

usage: args\_subparse.py delete \[-h\] \[--recursive\] dirname

positional arguments:

dirname          The directory to remove

optional arguments:

-h, --help       show this help message and exit

--recursive, -r  Remove thecontents of the directory, too

\# python args\_subparse.py list -h

usage: args\_subparse.py list \[-h\] dirname

positional arguments:

dirname     Directory tolist

optional arguments:

-h, --help  show this help message and exit

多个subparser 使用同样定义的参数

\# add\_help=False,必须指定，否则报-h重复定义

parents\_parser = argparse.ArgumentParser(add\_help=False)

parents\_parser.add\_argument('--foo', dest="foo", action='store\_true')

parents\_parser.add\_argument('--bar', dest="bar", action='store\_false')

parents\_parser.add\_argument('--baz', dest="baz", action='store\_false')

parser = argparse.ArgumentParser()

subparsers = parser.add\_subparsers(help='commands')

m\_parser = subparsers.add\_parser("mysql", parents=\[parents\_parser\], help="mysql method")

m\_parser.set\_defaults(func=sub\_mysql)

o\_parser = subparsers.add\_parser("oracle", parents=\[parents\_parser\], help="oracle method")

o\_parser.set\_defaults(func=sub\_oracle)

args = parser.parse\_args()

import argparse

parse = argparse.ArgumentParser()

parse.add\_argument("a", help="params means")

parse.add\_argument("-C", "--gc", default="count")

parse.add\_argument("--ga", help="params means ga",dest='simple\_value',choices=\['A', 'B', 'C', 0\])

parse.add\_argument("--gb", help="params means gb",action="store\_const",const='value-to-store')

args = parse.parse\_args()

print args.simple\_value,args.gb,args.gc

\#\#\# add\_argument 说明

不带'--'的参数

调用脚本时必须输入值

参数输入的顺序与程序中定义的顺序一致

'-'的参数

可不输入    add\_argument("-a")

类似有'--'的shortname，但程序中的变量名为定义的参数名

'--'参数

参数别名: 只能是1个字符，区分大小写

add\_argument("-shortname","--name", help="params means")，但代码中不能使用shortname

dest: 参数在程序中对应的变量名称 add\_argument("a",dest='code\_name')

default: 参数默认值

help: 参数作用解释  add\_argument("a", help="params means")

type : 默认string  add\_argument("c", type=int)

action:

store：默认action模式，存储值到指定变量。

store\_const：存储值在参数的const部分指定，多用于实现非布尔的命令行flag。

store\_true / store\_false：布尔开关。可以2个参数对应一个变量。

append：存储值到列表，该参数可以重复使用。

append\_const：存储值到列表，存储值在参数的const部分指定。

version 输出版本信息然后退出。

const:配合action="store\_const|append\_const"使用，默认值

choices:输入值的范围 add\_argument("--gb", choices=\['A', 'B', 'C', 0\])

from optparse import OptionParser

\[...\]

parser = OptionParser()

parser.add\_option("-f", "--file", dest="filename",

help="write report to FILE", metavar="FILE")

parser.add\_option("-q", "--quiet",

action="store\_false", dest="verbose", default=True,

help="don't print status messages to stdout")

(options, args) = parser.parse\_args()

现在，妳就可以在命令行下输入：

<yourscript> --file=outfile -q

<yourscript> -f outfile --quiet

<yourscript> --quiet --file outfile

<yourscript> -q -foutfile

<yourscript> -qfoutfile

上面这些命令是相同效果的。除此之外， optparse 还为我们自动生成命令行的帮助信息：

<yourscript> -h

<yourscript> --help

输出：

usage: <yourscript> \[options\]

options:

-h, --help            show this help message and exit

-f FILE, --file=FILE  write report to FILE

-q, --quiet           don't print status messages to stdout

简单流程

首先，必须 import OptionParser 类，创建一个 OptionParser 对象：

from optparse import OptionParser

\[...\]

parser = OptionParser()

然后，使用 add\_option 来定义命令行参数：

parser.add\_option(opt\_str, ...,

attr=value, ...)

每个命令行参数就是由参数名字符串和参数属性组成的。如 -f 或者 –file 分别是长短参数名：

parser.add\_option("-f", "--file", ...)

最后，一旦你已经定义好了所有的命令行参数，调用 parse\_args() 来解析程序的命令行：

**(options, args) = parser.parse\_args() **

注： 你也可以传递一个命令行参数列表到 parse\_args()；否则，默认使用 sys.argv\[:1\]。

parse\_args() 返回的两个值：

options，它是一个对象（optpars.Values），保存有命令行参数值。只要知道命令行参数名，如 file，就可以访问其对应的值： options.file 。

args，它是一个由 positional arguments 组成的列表。

Actions

示例

parser.add\_option("-f", "--file",

action="store", type="string", dest="filename")

args = \["-f", "foo.txt"\]

(options, args) = parser.parse\_args(args)

print options.filename

最后将会打印出 “foo.txt”。

你也可以指定 add\_option() 方法中 type 参数为其它值，如 int 或者 float 等等：

parser.add\_option("-n", type="int", dest="num")

store 也有其它的两种形式： store\_true 和 store\_false ，用于处理带命令行参数后面不 带值的情况。如 -v,-q 等命令行参数：

parser.add\_option("-v", action="store\_true", dest="verbose")

parser.add\_option("-q", action="store\_false", dest="verbose")

这样的话，当解析到 ‘-v’，options.verbose 将被赋予 True 值，反之，解析到 ‘-q’，会被赋予 False 值。

其它的 actions 值还有：

store\_const 、append 、count 、callback 。

默认值

parse\_args() 方法提供了一个 default 参数用于设置默认值。如：

parser.add\_option("-f","--file", action="store", dest="filename", default="foo.txt")

parser.add\_option("-v", action="store\_true", dest="verbose", default=True)

又或者使用 set\_defaults()：

parser.set\_defaults(filename="foo.txt",verbose=True)

parser.add\_option(...)

(options, args) = parser.parse\_args()

from optparse import OptionParser

\[...\]

def main():

usage = "usage: %prog \[options\] arg"

parser = OptionParser(usage)

parser.add\_option("-f", "--file", dest="filename",

help="read data from FILENAME")

parser.add\_option("-v", "--verbose",

action="store\_true", dest="verbose")

parser.add\_option("-q", "--quiet",

action="store\_false", dest="verbose")

\[...\]

(options, args) = parser.parse\_args()

if len(args) != 1:

parser.error("incorrect number of arguments")

if options.verbose:

print "reading %s..." % options.filename

\[...\]

if \_\_name\_\_ == "\_\_main\_\_":

main()

python学习之argparse模块

发表评论取消回复

还没有评论，来说两句吧...

相关阅读

相关 Python - 常用模块 - argparse

相关 Python argparse模块

相关 Python argparse模块详解

相关 python学习之argparse模块

相关 python学习之argparse模块

相关 python之argparse模块学习

相关 python之argparse模块

相关 python学习之argparse模块的使用

相关简单学习argparse模块

相关 Python中的Argparse模块