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
  • Github / Gitee QQ群(1群) : 813100564 / QQ群(2群) : 579033769 視頻教學 介紹 MiniWord .NET Word模板引擎,藉由Word模板和數據簡單、快速生成文件。 Getting Started 安裝 nuget link : https:// ...
  • Array.Sort Array類中相當實用的我認為是Sort方法,相比起冗長的冒泡排序,它的出現讓排序更加的簡化 結果如下: 還可以聲明一個靜態方法用來專門調用指定數組排序,從名為 array 的一維數組中 a 索引處開始,到 b 元素 從小到大排序。 註意: a + b 不能大於 array 的 ...
  • 前言 在上一篇文章CLR類型系統概述里提到,當運行時掛起時, 垃圾回收會執行堆棧遍歷器(stack walker)去拿到堆棧上值類型的大小和堆棧根。這裡我們來翻譯BotR里一篇專門介紹Stackwalking的文章,希望能加深理解。 順便說一句,StackWalker在中文里似乎還沒有統一的翻譯,J ...
  • 使用過 nginx 的小伙伴應該都知道,這個中間件是可以設置跨域的,作為今天的主角,同樣的 反向代理中間件的 YARP 毫無意外也支持了跨域請求設置。 有些小伙伴可能會問了,怎樣才算是跨域呢? 在 HTML 中,一些標簽,例如 img、a 等,還有我們非常熟悉的 Ajax,都是可以指向非本站的資源的 ...
  • 什麼是Git Git 是一個開源的分散式版本控制系統,用於敏捷高效地處理任何或小或大的項目。 Git 是 Linus Torvalds 為了幫助管理 Linux 內核開發而開發的一個開放源碼的版本控制軟體。 Git 與常用的版本控制工具 CVS, Subversion 等不同,它採用了分散式版本庫的 ...
  • 首先CR3是什麼,CR3是一個寄存器,該寄存器內保存有頁目錄表物理地址(PDBR地址),其實CR3內部存放的就是頁目錄表的記憶體基地址,運用CR3切換可實現對特定進程記憶體地址的強制讀寫操作,此類讀寫屬於有痕讀寫,多數驅動保護都會將這個地址改為無效,此時CR3讀寫就失效了,當然如果能找到CR3的正確地址... ...
  • 說明 onlyoffice為一款開源的office線上編輯組件,提供word/excel/ppt編輯保存操作 以下操作均基於centos8系統,officeonly鏡像版本7.1.2.23 鏡像下載地址:https://yunpan.360.cn/surl_y87CKKcPdY4 (提取碼:1f92 ...
  • 二叉樹查找指定的節點 前序查找的思路 1.先判斷當前節點的no是否等於要查找的 2.如果是相等,則返回當前節點 3.如果不等,則判斷當前節點的左子節點是否為空,如果不為空,則遞歸前序查找 4.如果左遞歸前序查找,找到節點,則返回,否繼續判斷,當前的節點的右子節點是否為空,如果不為空,則繼續向右遞歸前 ...
  • ##Invalid bound statement (not found)出現原因和解決方法 ###前言: 想必各位小伙伴在碼路上經常會碰到奇奇怪怪的事情,比如出現Invalid bound statement (not found),那今天我就來分析以下出現此問題的原因。 其實出現這個問題實質就是 ...
  • ###一、背景知識 爬蟲的本質就是一個socket客戶端與服務端的通信過程,如果我們有多個url待爬取,只用一個線程且採用串列的方式執行,那隻能等待爬取一個結束後才能繼續下一個,效率會非常低。 需要強調的是:對於單線程下串列N個任務,並不完全等同於低效,如果這N個任務都是純計算的任務,那麼該線程對c ...