python學習之argparse子產品

本文參考

http://www.2cto.com/kf/201412/363654.html

http://blog.itpub.net/26250550/viewspace-1281968/

并綜合整理

一、簡介：

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方法中的參數作用相似，出現的場合也一緻

最常用的地方就是這些，其他的可以參考官方文檔。下面給出一個例子，基本包括了常見的情形：

?

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52

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.

==============================================================================

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：布爾開關。 store_true.預設為False，輸入則為true。 store_flase 相反

    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 : 預設False, 若為 True, 表示必須輸入該參數

轉載于:https://www.cnblogs.com/hadis-yuki/p/5444333.html