python學習之argparse模塊

一、簡介：

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部分指定。

        count: 統計參數簡寫輸入的個數  add_argument("-c", "--gc", action="count")

        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部分指定。

    count: 統計參數簡寫輸入的個數  add_argument("-c", "--gc", action="count")

    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。

 

 

 

三、方法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部分指定。

        count: 統計參數簡寫輸入的個數  add_argument("-c", "--gc", action="count")

        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部分指定。

    count: 統計參數簡寫輸入的個數  add_argument("-c", "--gc", action="count")

    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()