一、預備知識

argparse是python用于解析命令行參數(shù)和選項的標準模塊，用于代替已經(jīng)過時的optparse模塊。argparse模塊的作用是用于解析命令行參數(shù)。

1、安裝

argsparse是python的命令行解析的標準模塊，內(nèi)置于python，不需要安裝。使用的時候直接：

import argparse

2、使用的一般步驟

這個模塊使用起來十分簡單，就類似于 造(買)個冰箱→在冰箱里面放點食材→需要的時候把食材拿出來做出美味的食物。

它的使用分為三步：

# 1.創(chuàng)建一個解析對象；
parser = argparse.ArgumentParser()
# 2.然后向該對象中添加你要關注的命令行參數(shù)和選項，
#   每一個 add_argument 方法對應一個你要關注的參數(shù)或選項；
parser.add_argument()
# 3. 最后調(diào)用 parse_args()方法進行解析；
parser.parse_args()

另外，關于參數(shù)的書寫習慣，有如下幾種：

• 空格分開，最常用，比如parser.parse_args('-x X'.split())
• 長選項用=分開 ( “長”選項名字，即選項的名字多于一個字符)，比如parser.parse_args('--foo=FOO'.split())
• ???????短選項可以寫在一起，比如parser.parse_args('-xX')

二、實操筆記

上面簡要介紹了使用的基本步驟，下面首先詳細介紹涉及到的幾個函數(shù)，然后再給一個實例。

1、函數(shù)詳解

1.1ArgumentParser

這個函數(shù)的作用就是創(chuàng)建一個解析對象（冰箱），下面是它的參數(shù)列表：

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)

參數(shù)含義如下所示：

• prog：程序的名字，默認為sys.argv[0]，用來在help信息中描述程序的名稱。
• usage：描述程序用途的字符串
• description：help信息前的文字。
• epilog：help信息之后的信息
• add_help：設為False時，help信息里面不再顯示-h --help信息。
• prefix_chars：參數(shù)前綴，默認為-
• ???????fromfile_prefix_chars：前綴字符，放在文件名之前
• argument_default：參數(shù)的全局默認值。
• conflict_handler：對沖突的處理方式，默認為返回錯誤“error”。還有“resolve”，智能解決沖突。當用戶給程序添加了兩個一樣的命令參數(shù)時，“error”就直接報錯，提醒用戶。而“resolve”則會去掉第一次出現(xiàn)的命令參數(shù)重復的部分或者全部（可能是短命令沖突或者全都沖突）。

1.2add_argument

此函數(shù)用來指定程序需要接受的命令參數(shù)，它的參數(shù)列表如下所示：

add_argument(name or flags...
[, action]
[, nargs]
[, const]
[, default]
[, type]
[, choices]
[, required]
[, help]
[, metavar]
[, dest])
# 注：[] 表示可選

參數(shù)含義如下：

• name or flags：參數(shù)有兩種，可選參數(shù)和位置參數(shù)。parse_args()運行時，會用-來認證可選參數(shù)，剩下的即為位置參數(shù)。位置參數(shù)必選，可選參數(shù)可選。
• action：參數(shù)動作；argparse內(nèi)置6種動作可以在解析到一個參數(shù)時進行觸發(fā)：store 保存參數(shù)值，可能會先將參數(shù)值轉(zhuǎn)換成另一個數(shù)據(jù)類型。若沒有顯式指定動作，則默認為該動作。store_const 保存一個被定義為參數(shù)規(guī)格一部分的值，而不是一個來自參數(shù)解析而來的值。這通常用于實現(xiàn)非布爾值的命令行標記。store_ture/store_false 保存相應的布爾值。這兩個動作被用于實現(xiàn)布爾開關。append 將值保存到一個列表中。若參數(shù)重復出現(xiàn)，則保存多個值。append_const 將一個定義在參數(shù)規(guī)格中的值保存到一個列表中。version 打印關于程序的版本信息，然后退出。 count統(tǒng)計參數(shù)出現(xiàn)的次數(shù)。
• nargs：參數(shù)的數(shù)量。值可以為整數(shù)N(N個)，*(任意多個)，+(一個或更多)，值為?時，首先從命令行獲得參數(shù)，若沒有則從const獲得，然后從default獲得：
• dest：參數(shù)值就保存為parse_args()返回的命名空間對象中名為該 dest 參數(shù)值的一個屬性。如果提供dest，例如dest="a"，那么可以通過args.a訪問該參數(shù)
• default：設置參數(shù)的默認值
• type：把從命令行輸入的結(jié)果轉(zhuǎn)成設置的類型
• choice：允許的參數(shù)值
• required：是否必選
• desk：可作為參數(shù)名
• help：參數(shù)命令的介紹

2、調(diào)用實例

下面給個簡單的示例，只是說明如何調(diào)用而已，后續(xù)可根據(jù)上面對函數(shù)的詳細解釋來使其更實用智能。

import argparse
parser = argparse.ArgumentParser(description ="This is a Test!")
parser.add_argument("type",choices=['scheduler','tool'],
                    help="make application type")
parser.add_argument('-c',dest='configurefile',help="configure file")
parser.print_help()
args = parser.parse_args(["tool","-c","a.ini"])
print(args.type)
print(args.configurefile)
# --------------output------------------
usage: draft.py [-h] [-c CONFIGUREFILE] {scheduler,tool}

This is a Test!

positional arguments:
  {scheduler,tool}  make application type

optional arguments:
  -h, --help        show this help message and exit
  -c CONFIGUREFILE  configure file
tool
a.ini

這個簡單的例子就，就創(chuàng)建了一個argparse對象，然后加了兩個參數(shù)（不算-h），一個是必選參數(shù)tool，另一個是可選參數(shù)-c，然后使用dest將其轉(zhuǎn)換為參數(shù)的一個屬性。
ps：其實一開始筆者遇到了一個問題，一開始筆者在必選參數(shù)前加了type，其實是不用的，對于必選參數(shù)直接給值即可。
另外，當有多個必選參數(shù)時，需要注意必選參數(shù)的順序一定要和加參數(shù)的順序保持一致。
可選參數(shù)和必選參數(shù)可以交換順序，只需保持可選參數(shù)與值不要分開，必選參數(shù)的相對順序與加參數(shù)的順序保持一致即可！

到此這篇關于Python argparse 解析命令行參數(shù)模塊詳情的文章就介紹到這了,更多相關Python argparse內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

最新評論