1. 程式人生 > >Python模組學習系列(8)----argparse模組

Python模組學習系列(8)----argparse模組

boost庫很好的支援C++的命令列解析,能使我們的程式用起來更酷。最近一直想Python裡也用上命令列,這樣就不用再IDE裡修改輸入引數了。記得前面介紹過使用os模組也能解析命令列,但是那個比較簡單,今天我們介紹的argparse模組是python中專門用來解析命令列的。

首先給大家貼出一段程式碼及執行結果,讓大家有一個直觀的感受。

<span style="font-size:18px;">#!/usr/bin/env python
"""
Draw a graph of the net architecture.
"""
from argparse import ArgumentParser, ArgumentDefaultsHelpFormatter
from google.protobuf import text_format

import caffe
import caffe.draw
from caffe.proto import caffe_pb2


def parse_args():
    """Parse input arguments
    """

    parser = ArgumentParser(description=__doc__,
                            formatter_class=ArgumentDefaultsHelpFormatter)

    parser.add_argument('input_net_proto_file',
                        help='Input network prototxt file')
    parser.add_argument('output_image_file',
                        help='Output image file')
    parser.add_argument('--rankdir',
                        help=('One of TB (top-bottom, i.e., vertical), '
                              'RL (right-left, i.e., horizontal), or another '
                              'valid dot option; see '
                              'http://www.graphviz.org/doc/info/'
                              'attrs.html#k:rankdir'),
                        default='LR')

    args = parser.parse_args()
    return args


def main():
    args = parse_args()
    net = caffe_pb2.NetParameter()
    text_format.Merge(open(args.input_net_proto_file).read(), net)
    print('Drawing net to %s' % args.output_image_file)
    caffe.draw.draw_net_to_file(net, args.output_image_file, args.rankdir)


if __name__ == '__main__':
    main()</span>
執行結果


上圖是我沒有輸入任何引數時執行的結果。

從上面的程式碼中我們可以總結出以下兩點:

1、命令列解析一般是以函式的形式執行,也就是我們定義個子函式專門用來處理命令列。

2、使用的步驟:

(1)import argparse

(2)parser = argparse.ArgumentParser()

(3)parser.add_argument()

(4)args=parser.parse_args()

(5)return args

(6)args = parse_args()

如下所示:

<span style="font-size:18px;">import argparse
def parse_args():
{
    parser = argparse.ArgumentParser()#初始化一個物件
    parser.add_argument()
    args = parser.parse_args()
    return args
}
args = parse_args()</span>
下面我們一步步介紹:

1、方法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引數。這個方法相當於一個建構函式,初始化一個物件,裡面使用最多的引數就是description。

我們可以按照上面程式碼的使用方式,用預設可是就可以了:

<span style="font-size:18px;">parser = ArgumentParser(description=__doc__,
                            formatter_class=ArgumentDefaultsHelpFormatter)</span>
我們自己也可以顯示自己的資訊:
<span style="font-size:18px;">def parse_args():
    description = usage: %prog [options] poetry-file</span>
或者:
<span style="font-size:18px;">parser = argparse.ArgumentParser(description="This is a description of %(prog)s", \</span>
<span style="font-size:18px;">					epilog="This is a epilog of %(prog)s", \</span>
<span style="font-size:18px;">				<span style="white-space:pre">	</span>prefix_chars="-+", fromfile_prefix_chars="@", \</span>
<span style="font-size:18px;">			<span style="white-space:pre">		</span>formatter_class=argparse.ArgumentDefaultsHelpFormatter)</span>
2、方法add_argument(name or flags...[, action][, nargs][, const][, default][, type][, choices][, required][, help][, metavar][, dest])

其中:

name or flags:命令列引數名或者選項,其中命令列引數如果沒給定,且沒有設定defualt,則出錯。但是如果是選項的話,則設定為None

nargs:命令列引數的個數,一般使用萬用字元表示,其中,'?'表示只用一個,'*'表示0到多個,'+'表示至少一個

default:預設值

type:引數的型別,預設是字串string型別,還有float、int等型別

help:和ArgumentParser方法中的引數作用相似,出現的場合也一致
下面舉一些具體使用的例子:

例1:

<span style="font-size:18px;">parser = argparse.ArgumentParser(description = description)
    
help = The addresses to connect.#是對引數的說明資訊
parser.add_argument('addresses',nargs = '*',help = help)#nargs='*' 說明這個引數是0到多個,也就是可選的</span>
例2:
<span style="font-size:18px;">help = The filename to operate on.Default is poetry/ecstasy.txt
parser.add_argument('filename',help=help)
</span>

例3:

<span style="font-size:18px;">help = The port to listen on. Default to a random available port.
parser.add_argument('-p',--port', type=int, help=help)#-p是--port的縮寫形式,使用時用哪個都行,type=int說明這個引數</span>
<span style="font-size:18px;">						#是整數型別</span>
注意:例2和例3在使用時輸入引數的格式有些不同,就像我們使用boost解析命令列時的格式也稍有不同,例2中直接輸入引數,只要順序對應就可以。例3中使用格式為  --port=引數

例4:

<span style="font-size:18px;">help = The interface to listen on. Default is localhost.
parser.add_argument('--iface', help=help, default='localhost')#帶有字串型別預設值</span>
例5:
<span style="font-size:18px;">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)</span>

我們怎樣在程式中使用這些引數呢?我應該知道C++中使用argv[ ]按照順序取出命令。而這裡我們可以直接使用引數名字如args.filename
<span style="font-size:18px;">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</span>

OK!祝大家好運了!