Python命令列解析庫argparse

標籤：des   blog   http   使用   os   io   strong   檔案   

2.7之後python不再對optparse模組進行擴充，python標準庫推薦使用argparse模組對命令列進行解析。

1.example

有一道面試題：編寫一個指令碼main.py，使用方式如下：

main.py -u http://www.sohu.com -d ‘a=1,b=2,c=3‘ -o /tmp/index.html

功能要求：開啟-u指定的頁面，將頁面中所有的連結後面增加參數a=1&b=2&c=3(需要考慮連結中已經存在指定的參數的問題), 然後儲存到-o指定的檔案中。

import argparseimport urllibfrom pyquery import PyQuery as pqdef getArgs():    parse=argparse.ArgumentParser()    parse.add_argument(‘-u‘,type=str)    parse.add_argument(‘-d‘,type=str)    parse.add_argument(‘-o‘,type=str)    args=parse.parse_args()    return vars(args)def urlAddQuery(url,query):    query=query.replace(‘,‘,‘&‘)      if ‘?‘ in url:        return url.replace(‘?‘,‘?‘+query+‘&‘)    else:        return url+‘?‘+querydef getHref():    args=getArgs()    url=args[‘u‘]    query=args[‘d‘].strip("\‘")    fileName=args[‘o‘]    doc=pq(url=url)    with open(fileName,‘w‘) as f:        for a in doc(‘a‘):            a=pq(a)            href=a.attr(‘href‘)            if href:                newurl=urlAddQuery(href,query)                f.write(newurl+‘\n‘)if __name__==‘__main__‘:    getHref()

2.建立解析器

import argparseparser = argparse.ArgumentParser()

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

建立一個ArgumentParser執行個體對象，ArgumentParser對象的參數都為關鍵字參數。

  prog：程式的名字，預設為sys.argv[0]，用來在help資訊中描述程式的名稱。

>>> parser = argparse.ArgumentParser(prog=‘myprogram‘)>>> parser.print_help()usage: myprogram [-h]optional arguments: -h, --help  show this help message and exit

  usage：描述程式用途的字串

>>> parser = argparse.ArgumentParser(prog=‘PROG‘, usage=‘%(prog)s [options]‘)>>> parser.add_argument(‘--foo‘, nargs=‘?‘, help=‘foo help‘)>>> parser.add_argument(‘bar‘, nargs=‘+‘, help=‘bar help‘)>>> parser.print_help()usage: PROG [options]positional arguments: bar          bar helpoptional arguments: -h, --help   show this help message and exit --foo [FOO]  foo help

  description：help資訊前的文字。

  epilog：help資訊之後的資訊

>>> parser = argparse.ArgumentParser(...     description=‘A foo that bars‘,...     epilog="And that‘s how you‘d foo a bar")>>> parser.print_help()usage: argparse.py [-h]A foo that barsoptional arguments: -h, --help  show this help message and exitAnd that‘s how you‘d foo a bar

parents：由ArgumentParser對象組成的列表，它們的arguments選項會被包含到新ArgumentParser對象中。

>>> parent_parser = argparse.ArgumentParser(add_help=False)>>> parent_parser.add_argument(‘--parent‘, type=int)>>> foo_parser = argparse.ArgumentParser(parents=[parent_parser])>>> foo_parser.add_argument(‘foo‘)>>> foo_parser.parse_args([‘--parent‘, ‘2‘, ‘XXX‘])Namespace(foo=‘XXX‘, parent=2)

formatter_class：help資訊輸出的格式,

prefix_chars：參數首碼，預設為‘-‘

>>> parser = argparse.ArgumentParser(prog=‘PROG‘, prefix_chars=‘-+‘)>>> parser.add_argument(‘+f‘)>>> parser.add_argument(‘++bar‘)>>> parser.parse_args(‘+f X ++bar Y‘.split())Namespace(bar=‘Y‘, f=‘X‘)

fromfile_prefix_chars：前置詞字元，放在檔案名稱之前

>>> with open(‘args.txt‘, ‘w‘) as fp:...    fp.write(‘-f\nbar‘)>>> parser = argparse.ArgumentParser(fromfile_prefix_chars=‘@‘)>>> parser.add_argument(‘-f‘)>>> parser.parse_args([‘-f‘, ‘foo‘, ‘@args.txt‘])Namespace(f=‘bar‘)

當參數過多時，可以將參數放到檔案中讀取，例子中parser.parse_args([‘-f‘, ‘foo‘, ‘@args.txt‘])解析時會從檔案args.txt讀取，相當於[‘-f‘, ‘foo‘, ‘-f‘, ‘bar‘]。

argument_default：參數的全域預設值。例如，要禁止parse_args時的參數預設添加，我們可以：

>>> parser = argparse.ArgumentParser(argument_default=argparse.SUPPRESS)>>> parser.add_argument(‘--foo‘)>>> parser.add_argument(‘bar‘, nargs=‘?‘)>>> parser.parse_args([‘--foo‘, ‘1‘, ‘BAR‘])Namespace(bar=‘BAR‘, foo=‘1‘)>>> parser.parse_args()Namespace()

當parser.parse_args()時不會自動解析foo和bar了。

conflict_handler：解決衝突的策略，預設情況下衝突會發生錯誤：

>>> parser = argparse.ArgumentParser(prog=‘PROG‘)>>> parser.add_argument(‘-f‘, ‘--foo‘, help=‘old foo help‘)>>> parser.add_argument(‘--foo‘, help=‘new foo help‘)Traceback (most recent call last): ..ArgumentError: argument --foo: conflicting option string(s): --foo

我們可以設定衝突解決方案策略：

>>> parser = argparse.ArgumentParser(prog=‘PROG‘, conflict_handler=‘resolve‘)>>> parser.add_argument(‘-f‘, ‘--foo‘, help=‘old foo help‘)>>> parser.add_argument(‘--foo‘, help=‘new foo help‘)>>> parser.print_help()usage: PROG [-h] [-f FOO] [--foo FOO]optional arguments: -h, --help  show this help message and exit -f FOO      old foo help --foo FOO   new foo help

　add_help：設為False時，help資訊裡面不再顯示-h --help資訊。

3.添加參數選項

>>> parser.add_argument(‘integers‘, metavar=‘N‘, type=int, nargs=‘+‘,...                     help=‘an integer for the accumulator‘)>>> parser.add_argument(‘--sum‘, dest=‘accumulate‘, action=‘store_const‘,...                     const=sum, default=max,...                     help=‘sum the integers (default: find the max)‘)

add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

  name or flags：參數有兩種，選擇性參數和位置參數。

添加選擇性參數：

>>> parser.add_argument(‘-f‘, ‘--foo‘)

添加位置參數：

>>> parser.add_argument(‘bar‘)

parse_args()運行時，會用‘-‘來認證選擇性參數，剩下的即為位置參數。

>>> parser = argparse.ArgumentParser(prog=‘PROG‘)>>> parser.add_argument(‘-f‘, ‘--foo‘)>>> parser.add_argument(‘bar‘)>>> parser.parse_args([‘BAR‘])Namespace(bar=‘BAR‘, foo=None)>>> parser.parse_args([‘BAR‘, ‘--foo‘, ‘FOO‘])Namespace(bar=‘BAR‘, foo=‘FOO‘)>>> parser.parse_args([‘--foo‘, ‘FOO‘])usage: PROG [-h] [-f FOO] barPROG: error: too few arguments

解析時沒有位置參數就會報錯了。

action:預設為store

  store_const，值存放在const中：

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘, action=‘store_const‘, const=42)>>> parser.parse_args(‘--foo‘.split())Namespace(foo=42)

  store_true和store_false，值存為True或False

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘, action=‘store_true‘)>>> parser.add_argument(‘--bar‘, action=‘store_false‘)>>> parser.add_argument(‘--baz‘, action=‘store_false‘)>>> parser.parse_args(‘--foo --bar‘.split())Namespace(bar=False, baz=True, foo=True)

  append：存為列表

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘, action=‘append‘)>>> parser.parse_args(‘--foo 1 --foo 2‘.split())Namespace(foo=[‘1‘, ‘2‘])

  append_const：存為列表，會根據const關鍵參數進行添加：

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--str‘, dest=‘types‘, action=‘append_const‘, const=str)>>> parser.add_argument(‘--int‘, dest=‘types‘, action=‘append_const‘, const=int)>>> parser.parse_args(‘--str --int‘.split())Namespace(types=[<type ‘str‘>, <type ‘int‘>])

  count：統計參數出現的次數

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--verbose‘, ‘-v‘, action=‘count‘)>>> parser.parse_args(‘-vvv‘.split())Namespace(verbose=3)

  help：help資訊

  version：版本

>>> import argparse>>> parser = argparse.ArgumentParser(prog=‘PROG‘)>>> parser.add_argument(‘--version‘, action=‘version‘, version=‘%(prog)s 2.0‘)>>> parser.parse_args([‘--version‘])PROG 2.0

nrgs：參數的數量

值可以為整數N(N個)，*(任意多個)，+(一個或更多)

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘, nargs=‘*‘)>>> parser.add_argument(‘--bar‘, nargs=‘*‘)>>> parser.add_argument(‘baz‘, nargs=‘*‘)>>> parser.parse_args(‘a b --foo x y --bar 1 2‘.split())Namespace(bar=[‘1‘, ‘2‘], baz=[‘a‘, ‘b‘], foo=[‘x‘, ‘y‘])

值為？時，首先從命令列獲得參數，若沒有則從const獲得，然後從default獲得：

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘, nargs=‘?‘, const=‘c‘, default=‘d‘)>>> parser.add_argument(‘bar‘, nargs=‘?‘, default=‘d‘)>>> parser.parse_args(‘XX --foo YY‘.split())Namespace(bar=‘XX‘, foo=‘YY‘)>>> parser.parse_args(‘XX --foo‘.split())Namespace(bar=‘XX‘, foo=‘c‘)>>> parser.parse_args(‘‘.split())Namespace(bar=‘d‘, foo=‘d‘)

更常用的情況是允許參數為檔案

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘infile‘, nargs=‘?‘, type=argparse.FileType(‘r‘),...                     default=sys.stdin)>>> parser.add_argument(‘outfile‘, nargs=‘?‘, type=argparse.FileType(‘w‘),...                     default=sys.stdout)>>> parser.parse_args([‘input.txt‘, ‘output.txt‘])Namespace(infile=<open file ‘input.txt‘, mode ‘r‘ at 0x...>,          outfile=<open file ‘output.txt‘, mode ‘w‘ at 0x...>)>>> parser.parse_args([])Namespace(infile=<open file ‘<stdin>‘, mode ‘r‘ at 0x...>,          outfile=<open file ‘<stdout>‘, mode ‘w‘ at 0x...>)

const：儲存一個常量

default：預設值

type：參數類型

choices：可供選擇的值

>>> parser = argparse.ArgumentParser(prog=‘doors.py‘)>>> parser.add_argument(‘door‘, type=int, choices=range(1, 4))>>> print(parser.parse_args([‘3‘]))Namespace(door=3)>>> parser.parse_args([‘4‘])usage: doors.py [-h] {1,2,3}doors.py: error: argument door: invalid choice: 4 (choose from 1, 2, 3)

required：是否必選

desk：可作為參數名

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘, dest=‘bar‘)>>> parser.parse_args(‘--foo XXX‘.split())Namespace(bar=‘XXX‘)

4.解析參數

參數有幾種寫法：

最常見的空格分開：

>>> parser = argparse.ArgumentParser(prog=‘PROG‘)>>> parser.add_argument(‘-x‘)>>> parser.add_argument(‘--foo‘)>>> parser.parse_args(‘-x X‘.split())Namespace(foo=None, x=‘X‘)>>> parser.parse_args(‘--foo FOO‘.split())Namespace(foo=‘FOO‘, x=None)

長選項用=分開

>>> parser.parse_args(‘--foo=FOO‘.split())Namespace(foo=‘FOO‘, x=None)

短選項可以寫在一起：

>>> parser.parse_args(‘-xX‘.split())Namespace(foo=None, x=‘X‘)

parse_args()方法的傳回值為namespace，可以用vars()內建函數化為字典：

>>> parser = argparse.ArgumentParser()>>> parser.add_argument(‘--foo‘)>>> args = parser.parse_args([‘--foo‘, ‘BAR‘])>>> vars(args){‘foo‘: ‘BAR‘}