Python技法:用argparse模塊解析命令行選項

来源:https://www.cnblogs.com/orion-orion/archive/2022/05/20/16293177.html
-Advertisement-
Play Games

我們在上一篇博客中介紹了Linux系統Shell命令行下可執行程式應該遵守的傳參規範(包括了各種選項及其參數)。Python命令行程式做為其中一種,其傳參中也包括了位置參數(positional和可選參數(optional)。Python程式中我們解析在命令行中提供的各種選項(選項保存在sys.ar... ...


1. 用argparse模塊解析命令行選項

我們在上一篇博客《Linux:可執行程式的Shell傳參格式規範》中介紹了Linux系統Shell命令行下可執行程式應該遵守的傳參規範(包括了各種選項及其參數)。Python命令行程式做為其中一種,其傳參中也包括了位置參數(positional arguments)可選參數(optional arguments)

(註意,可選參數的選項名稱以---打頭,位置參數和可選參數的先後順序可以任意排布)

那麼在Python程式中我們如何解析在命令行中提供的各種選項呢?(選項保存在sys.argv中)我們可以使用argparse模塊。我們用下麵這個search.py程式做例子:

1.1 創建parser對象

首先我們需要創建parser對象:

import argparse
parser = argparse.ArgumentParser(description="search some files")

1.2 添加選項聲明

然後使用parser.add_argument()方法添加想要支持的選項聲明。add_argument()的調用參數承擔了不同的功能:

  • dest指定了用來保存解析結果的屬性名稱。
  • metavar用於顯示幫助信息,如果不指定則預設為大寫的屬性名。
  • action指定了與參數處理相關的行為(store表示存儲單個值,append表示將多個值存到一個列表中)。

我們嘗試依次添加如下選項聲明進行測試:

解析位置參數

parser.add_argument(dest="filenames", metavar="filename", nargs="*")

該參數為位置參數,不需要像可選參數的選項一樣用---打頭。位置參數一般是必須要提供的(雖然這裡你不提供也能保存為[])。nargs="*"表示將所有額外命令行參數保存在一個列表中。

解析可選參數


parser.add_argument("-p", "--pat", metavar="pattern", required=True, dest="patterns", action="append", help="text pattern to search for")

-p--pat兩種選項名稱都可接收(前者是簡寫,後者是全稱)。我們在上一篇博客說過,在調用Shell命令時規定對於簡寫的選項名用-p ××形式傳參,對於全稱的選項名我們有--pat ××--pat=××兩種形式。不過Python腳本時你用-p=××也能解析,不過一般不建議這樣搞。action="append"意為允許命令行參數重覆多次,將所有參數值保存在列表中,require=True意味著參數必須要提供一次。

parser.add_argument("-v", dest="verbose", action="store_true", help="verbose mode") 

store_true意思為設定為一個布爾標記,標記的值取決於參數是否有提供。

parser.add_argument("-o", dest="outfile", action="store", help="output file") 

類似上面,這裡store意思為接收一個單獨的值並保存為字元串

parser.add_argument("--speed", dest="speed", action="store", choices={"slow", "fast"}, default="slow", help="search speed") 

同上,該參數也是接受一個值,但只能在特定範圍中{"slow", "fast"}中選擇,且預設"slow""

1.2 解析選項

然後我們就可以解析選項並使用傳入的參數了:


args = parser.parse_args()

# 註意在使用參數時,是用的參數的dest名字
print(args.filenames)
print(args.patterns)
print(args.verbose)
print(args.outfile)
print(args.speed)

2. 測試

以上的程式定義了一個命令解析器,我們可以設置-h選項查看其用法:

(base) [email protected] Python-Lang % python search.py -h        
usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {slow,fast}] [filename ...]

search some files

positional arguments:
  filename

optional arguments:
  -h, --help            show this help message and exit
  -p pattern, --pat pattern
                        text pattern to search for
  -v                    verbose mode
  -o OUTFILE            output file
  --speed {slow,fast}   search speed

接下來我們展示數據在程式中的顯示方式。比如我們嘗試不傳入必需的-p/--pat選項參數:

(base) [email protected] Python-Lang % python search.py foo.txt bar.txt
usage: search.py [-h] -p pattern [-v] [-o OUTFILE] [--speed {slow,fast}] [filename ...]
search.py: error: the following arguments are required: -p/--pat

如上所示,解釋器會提醒我們參數沒傳入。我們註意到usage-p pattern並沒有加方括弧[],說明該參數不是可選的,必須要提供。

接下來我們提供完整參數,大家可以仔細觀察print()語句的輸出:

(base) [email protected] Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt 
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
None
slow

可以看到如上所示,因為提供了參數-v,故args.verboseTrue。因為沒提供-o ×××參數,故args.outfileNone

(base) [email protected] Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt -o results
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
results
slow

可以看到如上所示,設置了提供了-o results,故args.outfile列印結果為results

(base) [email protected] Python-Lang % python search.py -v -p spam --pat=eggs foo.txt bar.txt -o results --speed=fast
['foo.txt', 'bar.txt']
['spam', 'eggs']
True
results
fast

如上所示為提供了可選參數--speed的情況。

3. 討論

一旦選項給出後,我們只需要簡單地執行parser.parse()方法。這麼做會處理sys.argv的值,並返回結果實例。如果我們手動處理sys.argv或者使用getopt模塊(仿照類似的C庫打造),就會重覆編寫許多argparse已經提供的代碼,因此在新項目中應該優先選擇argparse

參考

數學是符號的藝術,音樂是上界的語言。
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 操作系統:Windows10 Python版本:3.9.2 vosk是一個離線開源語音識別工具,它可以識別16種語言,包括中文。 這裡記錄下使用vosk進行中文識別的過程,以便後續查閱。 vosk地址:https://alphacephei.com/vosk/ 使用vosk-server進行語音識別 ...
  • 衡量運行時間 很多時候你需要計算某段代碼執行所需的時間,可以使用 time 模塊來實現這個功能。 import time startTime = time.time() # write your code or functions calls endTime = time.time() totalT ...
  • 知識回顧 上一篇介紹了Spring中三級緩存的singletonObjects、earlySingletonObjects、singletonFactories,Spring在處理迴圈依賴時在實例化後屬性填充前將一個lambda表達式放在了三級緩存中,後續在獲取時進行了判斷,如果不需要進行對象代理, ...
  • 1. Netty源碼研究筆記(2)——Bootstrap系列 顧名思義,Bootstrap是netty提供給使用者的腳手架,類似於Spring的ApplicationContext,通過Bootstrap我們使用一些自定義選項,將相關的組件打包起來,從而快速的啟動伺服器、客戶端。 Bootstrap ...
  • ZooKeeper知識點總結 一、ZooKeeper 的工作機制 二、ZooKeeper 中的 ZAB 協議 三、數據模型與監聽器 四、ZooKeeper 的選舉機制和流程 本文將以如下內容為主線講解ZooKeeper中的學習重點,包括 ZooKeeper 中的角色、ZAB協議、數據模型、選舉機制、 ...
  • 現在驗證碼登錄已經成為很多應用的主流登錄方式,但是對於OAuth2授權來說,手機號驗證碼處理用戶認證就非常繁瑣,很多同學卻不知道怎麼接入。 認真研究胖哥Spring Security OAuth2專欄的都會知道一個事,OAuth2其實不管資源擁有者是如何認證的,只要資源擁有者在授權的環節中認證了就可 ...
  • 來源:csdn.net/xiaojin21cen/article/details/78587425 ZeroC ICE的Java版,Netty2作者的後續之作Apache MINA,Crmky的Cindy之外,還有個超簡單的QuickServer,讓你專心編寫自己的業務代碼,不用編寫一行TCP代碼。 ...
  • 1.創建線程池相關參數 線程池的創建要用ThreadPoolExecutor類的構造方法自定義創建,禁止用Executors的靜態方法創建線程池,防止記憶體溢出和創建過多線程消耗資源。 corePoolSize: 線程池核心線程數量,不會自動銷毀,除非設置了參數allowCoreThreadTimeO ...
一周排行
    -Advertisement-
    Play Games
  • 前言 本文將以 C# 語言來實現一個簡單的布隆過濾器,為簡化說明,設計得很簡單,僅供學習使用。 感謝@時總百忙之中的指導。 布隆過濾器簡介 布隆過濾器(Bloom filter)是一種特殊的 Hash Table,能夠以較小的存儲空間較快地判斷出數據是否存在。常用於允許一定誤判率的數據過濾及防止緩存 ...
  • 目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • 「簡單有價值的事情長期堅持做」 這是成功最簡單,但也最難學的秘訣。不經過訓練,人很難意識到時間複利的威力。 仙劍奇俠傳的「十里坡劍神」和金庸群俠傳的「十級野球拳」,就是簡單的事情持之以恆反覆做,最後就有巨大的威力 唐家三少成為網文收入第一,最重要的一步是十四年從未斷日更 這樣的案例很多,一開始可能成 ...
  • 迎面走來了你的面試官,身穿格子衫,挺著啤酒肚,髮際線嚴重後移的中年男子。 手拿泡著枸杞的保溫杯,胳膊夾著MacBook,MacBook上還貼著公司標語:“我愛加班”。 面試開始,直入正題。 面試官: 看你簡歷上面寫著精通MySQL,我先問你事務的特性是什麼? 老生常談,這個還有誰不會背的嗎? 我: ...
  • 基礎知識 python是一門腳本語言,它是解釋執行的。 python使用縮進做為語法,而且python2環境下同一個py文件中不能同時存在tab和空格縮進,否則會出錯,建議在IDE中顯示縮進符。 python在聲明變數時不寫數據類型,可以type(xx)來獲取欄位的類型,然後可以int(),list ...
  • 為什麼要多線程下載 俗話說要以終為始,那麼我們首先要明確多線程下載的目標是什麼,不外乎是為了更快的下載文件。那麼問題來了,多線程下載文件相比於單線程是不是更快? 對於這個問題可以看下圖。 橫坐標是線程數,縱坐標是使用對應線程數下載對應文件時花費的時間,藍橙綠代表下載文件的大小,每個線程下載對應文件2 ...
  • 詳細講解python爬蟲代碼,爬微博搜索結果的博文數據。 爬取欄位: 頁碼、微博id、微博bid、微博作者、發佈時間、微博內容、轉發數、評論數、點贊數。 爬蟲技術: 1、requests 發送請求 2、datetime 時間格式轉換 3、jsonpath 快速解析json數據 4、re 正則表達式提... ...
  • 背景: 一般我們可以用HashMap做本地緩存,但是HashMap功能比較弱,不支持Key過期,不支持數據範圍查找等。故在此實現了一個簡易的本地緩存,取名叫fastmap。 功能: 1.支持數據過期 2.支持等值查找 3.支持範圍查找 4.支持key排序 實現思路: 1.等值查找採用HashMap2 ...
  • 目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • 本章是系列文章的第八章,用著色演算法進行寄存器的分配過程。 本文中的所有內容來自學習DCC888的學習筆記或者自己理解的整理,如需轉載請註明出處。周榮華@燧原科技 寄存器分配 寄存器分配是為程式處理的值找到存儲位置的問題 這些值可以存放到寄存器,也可以存放在記憶體中 寄存器更快,但數量有限 記憶體很多,但 ...