1.建立解析器：

  import argparse

parser = argparse.ArgumentParser(
description=’This is a PyMOTW sample program’,
)  

  argparse是一個完整的引數處理庫。引數可以根據add_argument()的action選項觸發不同action。支援的action有儲存引數（單個，或作為列表的一部分）;儲存常量的值（對布林開關true/false有特殊處理）。預設動作是儲存引數值。支援type(指定儲存型別)和dest(指定儲存變數)等引數。

  然後使用函式parse_args()進行引數解析，這個函式的輸入預設是sys.argv[1:]，也可以使用其他字串列表。選項使用GNU/POSIX語法處理，可以混合選項和引數值。parse_args的返回值是一個包含命令引數的Namespace。所有引數以屬性的形式存在，比如args.myoption。

  下面是一個簡單的示例：

import argparse
 parser = argparse.ArgumentParser(description='Short sampleapp')

parser.add_argument('-a', action="store_true",default=False)

parser.add_argument('-b', action="store",dest="b")

parser.add_argument('-c', action="store",dest="c", type=int)

 print parser.parse_args(['-a', '-bval', '-c', '3'])
 

    執行結果：

# pythonargparse_short.py

Namespace(a=True, b='val', c=3)

長引數也可以進行同樣處理：

import argparse

parser = argparse.ArgumentParser(

    description='Examplewith long option names',

    )

parser.add_argument('--noarg', action="store_true",

                   default=False)

parser.add_argument('--witharg', action="store",

                   dest="witharg")

parser.add_argument('--witharg2', action="store",

                   dest="witharg2", type=int)

print parser.parse_args(

    [ '--noarg','--witharg', 'val', '--witharg2=3' ]

    )

    執行結果：

# python argparse_long.py

Namespace(noarg=True, witharg='val', witharg2=3)

不同於optparse，argparse可以很好地處理非可選引數（沒有’-‘等開頭的引數）：

import argparse

parser = argparse.ArgumentParser(

    description='Examplewith nonoptional arguments',

    )

parser.add_argument('count', action="store",type=int)

parser.add_argument('units', action="store")

print parser.parse_args()

    沒有指定型別的，預設是字串。執行結果：

# python argparse_arguments.py 3inches

Namespace(count=3, units='inches')

# python argparse_arguments.py some inches

usage: argparse_arguments.py [-h] count units

argparse_arguments.py: error: argument count: invalid intvalue: 'some'

# python argparse_arguments.py

usage: argparse_arguments.py [-h] count units

argparse_arguments.py: error: too few arguments

引數action有：

store：預設action模式，儲存值到指定變數。

store_const：儲存值在引數的const部分指定，多用於實現非布林的命令列flag。

store_true / store_false：布林開關。可以2個引數對應一個變數。

append：儲存值到列表，該引數可以重複使用。

append_const：儲存值到列表，儲存值在引數的const部分指定。

version 輸出版本資訊然後退出。

下面是各種action的示例：

import argparse

parser = argparse.ArgumentParser()

parser.add_argument('-s', action='store',

                   dest='simple_value',

                    help='Storea simple value')

parser.add_argument('-c', action='store_const',

                   dest='constant_value',

                   const='value-to-store',

                   help='Store a constant value')

parser.add_argument('-t', action='store_true',

                   default=False,

                   dest='boolean_switch',

                   help='Set a switch to true')

parser.add_argument('-f', action='store_false',

                   default=False,

                   dest='boolean_switch',

                   help='Set a switch to false')

parser.add_argument('-a', action='append',

                   dest='collection',

                   default=[],

                   help='Add repeated values to a list')

parser.add_argument('-A', action='append_const',

                   dest='const_collection',

                   const='value-1-to-append',

                   default=[],

                   help='Add different values to list')

parser.add_argument('-B', action='append_const',

                    dest='const_collection',

                   const='value-2-to-append',

                   help='Add different values to list')

parser.add_argument('--version', action='version',

                   version='%(prog)s 1.0')

results = parser.parse_args()

print 'simple_value    = %r' % results.simple_value

print 'constant_value  = %r' % results.constant_value

print 'boolean_switch  = %r' % results.boolean_switch

print 'collection      = %r' % results.collection

print 'const_collection = %r' % results.const_collection

    執行結果：

# python argparse_action.py -h

usage: argparse_action.py [-h] [-s SIMPLE_VALUE] [-c] [-t][-f]

                         [-a COLLECTION] [-A] [-B] [--version]

optional arguments:

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

  -s SIMPLE_VALUE  Store a simple value

  -c               Store a constant value

  -t               Set a switch to true

  -f               Set a switch to false

  -a COLLECTION    Add repeated values to a list

  -A               Add different values to list

  -B               Add different values to list

  --version        show program's version number and exit

# python argparse_action.py --version

argparse_action.py 1.0

# python argparse_action.py -s value

simple_value     ='value'

constant_value   = None

boolean_switch   = False

collection       = []

const_collection = []

# python argparse_action.py -c

simple_value     = None

constant_value   ='value-to-store'

boolean_switch   = False

collection       = []

const_collection = []

# python argparse_action.py -t

simple_value     = None

constant_value   = None

boolean_switch   = True

collection       = []

const_collection = []

# python argparse_action.py -f

simple_value     = None

constant_value   = None

boolean_switch   = False

collection       = []

const_collection = []

# python argparse_action.py -a one -a two -a three

simple_value     = None

constant_value   = None

boolean_switch   = False

collection       =['one', 'two', 'three']

const_collection = []

# python argparse_action.py -B -A

simple_value     = None

constant_value   = None

boolean_switch   = False

collection       = []

const_collection = ['value-2-to-append', 'value-1-to-append']

ArgumentParser函式中的選項prefix_chars可以指定字首。預設使用UNIX風格，命令列使用‘-’作為字首。可以使用windows的’/’或者其他符號。

import argparse

parser = argparse.ArgumentParser(

    description='Changethe option prefix characters',

    prefix_chars='-+/',

    )

parser.add_argument('-a', action="store_false",

                   default=None,

                   help='Turn A off',

                    )

parser.add_argument('+a', action="store_true",

                   default=None,

                   help='Turn A on',

                    )

parser.add_argument('//noarg', '++noarg',

                   action="store_true",

                    default=False)

print parser.parse_args()

    執行結果：

[email protected] argparse]# pythonargparse_prefix_chars.py -h

usage: argparse_prefix_chars.py [-h] [-a] [+a] [//noarg]

Change the option prefix characters

optional arguments:

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

  -a                Turn A off

  +a                Turn A on

  //noarg, ++noarg

# python argparse_prefix_chars.py +a

Namespace(a=True, noarg=False)

# python argparse_prefix_chars.py -a

Namespace(a=False, noarg=False)

# python argparse_prefix_chars.py //noarg

Namespace(a=None, noarg=True)

# python argparse_prefix_chars.py ++noarg

Namespace(a=None, noarg=True)

# python argparse_prefix_chars.py --noarg

usage: argparse_prefix_chars.py [-h] [-a] [+a] [//noarg]

argparse_prefix_chars.py: error: unrecognized arguments:--noarg

# python argparse_prefix_chars.py --noarg

usage: argparse_prefix_chars.py [-h] [-a] [+a] [//noarg]

argparse_prefix_chars.py: error: unrecognized arguments:--noarg

處理配置檔案中的引數：

mport argparse

from ConfigParser import ConfigParser

import shlex

parser = argparse.ArgumentParser(description='Short sampleapp')

parser.add_argument('-a', action="store_true",default=False)

parser.add_argument('-b', action="store",dest="b")

parser.add_argument('-c', action="store",dest="c", type=int)

config = ConfigParser()

config.read('argparse_with_shlex.ini')

config_value = config.get('cli', 'options')

print 'Config  :',config_value

argument_list = shlex.split(config_value)

print 'Arg List:', argument_list

print 'Results :', parser.parse_args(argument_list)

    執行結果：

# python argparse_with_shlex.py

Config  : -a -b 2

Arg List: ['-a', '-b', '2']

Results : Namespace(a=True, b='2', c=None)

    其中ini檔案的內容如下：

# vi argparse_with_shlex.ini

[cli]

options = -a -b 2

    上面例子使用了ConfigParser來讀取配置，再用shlex來切割引數。可以通過fromfile_prefix_chars 告知argparse輸入引數為檔案。

import argparse

#from ConfigParser import ConfigParser

#import shlex

parser = argparse.ArgumentParser(description='Short sampleapp',

                                 fromfile_prefix_chars='@',

                                 )

parser.add_argument('-a', action="store_true",default=False)

parser.add_argument('-b', action="store",dest="b")

parser.add_argument('-c', action="store",dest="c", type=int)

print parser.parse_args(['@argparse_fromfile_prefix_chars.txt'])

    執行結果：

# python argparse_fromfile_prefix_chars.py

Namespace(a=True, b='2', c=None)

    其中argparse_fromfile_prefix_chars.txt檔案的內容如下：

# vi argparse_fromfile_prefix_chars.txt

-a

-b

2

14.3.2自動生成選項
Argparse會自動生成的幫助和版本資訊。ArgumentParser的add_help引數控制幫助的生成，預設是開啟。

import argparse

parser = argparse.ArgumentParser(add_help=True)

parser.add_argument(’-a’, action="store_true",default=False)

parser.add_argument(’-b’, action="store",dest="b")

parser.add_argument(’-c’, action="store",dest="c", type=int)

print parser.parse_args()

下例就關閉幫助：

import argparse

相關推薦