python argparse子產品詳解_python中argparse子產品用法執行個體詳解

本文執行個體講述了python中argparse子產品用法。分享給大家供大家參考。具體分析如下：

平常在寫指令行工具的時候，經常會帶參數，是以用python中的argparse來實作。

# -*- coding: utf-8 -*-

import argparse

args = "-f hello.txt -n 1 2 3 -x 100 -y b -z a -q hello @args.txt i_am_bar -h".split()

# 使用@args.txt要求fromfile_prefix_chars="@"

# args.txt檔案中應該一行一個參數，想改變行為參考convert_arg_line_to_args()

# ArgumentParser參數的簡單說明

## description - 指令行幫助的開始文字，大部分情況下，我們隻會用到這個參數

# 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資訊都是必須的，是以不用設定啦。

## parents - 類型是list，如果這個parser的一些選項跟其他某些parser的選項一樣，可以用parents來實作繼承，例如parents=[parent_parser]

## formatter_class - 自定義幫助資訊的格式(description和epilog)。預設情況下會将長的幫助資訊進行。

#三個允許的值：

# class argparse.RawDescriptionHelpFormatter 直接輸出description和epilog的原始形式(不進行自動換行和消除空白的操作)

# class argparse.RawTextHelpFormatter 直接輸出description和epilog以及add_argument中的help字元串的原始形式(不進行自動換行和消除空白的操作)

## class argparse.ArgumentDefaultsHelpFormatter 在每個選項的幫助資訊後面輸出他們對應的預設值，如果有設定的話。這個最常用吧！

# argument_default - (default: None)設定一個全局的選項的預設值，一般每個選項單獨設定，是以這個參數用得少，不細說

# usage - (default: generated)如果你需要修改usage的資訊(usage: PROG [-h] [--foo [FOO]] bar [bar ...])，那麼可以修改這個，一般不要修改。

# conflict_handler - 不建議使用。這個在極端情況下才會用到，主要是定義兩個add_argument中添加的選項的名字發生沖突時怎麼處理，預設處理是抛出異常。

#注釋一行有##表示這幾個參數比較常用

parser = argparse.ArgumentParser(description="This is a description of %(prog)s", epilog="This is a epilog of %(prog)s", prefix_chars="-+", fromfile_prefix_chars="@", formatter_class=argparse.ArgumentDefaultsHelpFormatter)

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

# add_argument的參數是比較複雜的。。。

# name or flags - 指定參數的形式，想寫幾個寫幾個，不過我們一般就寫兩個，一個短參數，一個長參數，看下面的例子"-f", "--file"

# 可選的選項，位置不固定，想怎麼寫就怎麼寫，預設是可選的

parser.add_argument("-f", "--file", help="test test test")

# 位置固定的選項，例如"prog i_am_bar"，這樣子的話，i_am_bar就是bar選項的值啦，預設是必須有的

parser.add_argument("bar", help="test test test")

# nargs - 指定這個參數後面的value有多少個，例如，我們希望使用-n 1 2 3 4，來設定n的值為[1, 2, 3, 4]

parser.add_argument("-n", "--num", nargs="+", type=int)

# 這裡nargs="+"表示，如果你指定了-n選項，那麼-n後面至少要跟一個參數，+表示至少一個,?表示一個或0個,*0個或多個，

# default - 如果指令行沒有出現這個選項，那麼使用default指定的預設值

parser.add_argument("+g", "++gold", help="test test test", default="test_gold")#需要prefix_chars包含"+"

# type - 如果希望傳進來的參數是指定的類型(例如 float, int or file等可以從字元串轉化過來的類型)，可以使用

parser.add_argument("-x", type=int)

# choices - 設定參數值的範圍，如果choices中的類型不是字元串，記得指定type哦

parser.add_argument("-y", choices=['a', 'b', 'd'])

# required - 通常-f這樣的選項是可選的，但是如果required=True那麼就是必須的了

parser.add_argument("-z", choices=['a', 'b', 'd'], required=True)

# metavar - 參數的名字，在顯示 幫助資訊時才用到.

parser.add_argument("-o", metavar="OOOOOO")

# help - 設定這個選項的幫助資訊

# dest - 設定這個選項的值就是解析出來後放到哪個屬性中

parser.add_argument("-q", dest="world")

args = parser.parse_args(args) # 如果你沒有args參數，那麼就使用sys.argv，也就是指令行參數啦。有這個參數，就友善我們調試啊

# args.world就是-q的值啦

# action - The basic type of action to be taken when this argument is encountered at the command line.

# const - A constant value required by some action and nargs selections.

# 這兩個自己看幫助文檔啦，比較複雜

# http://docs.python.org/library/argparse.html

print args

希望本文所述對大家的Python程式設計有所幫助。