【Python】一文向您詳細介紹 argparse中 action=‘store_true’ 的作用

---

?
下滑即可查看博客內容

🌈 歡迎蒞臨我的個人主頁 👈這里是我靜心耕耘深度學習領域、真誠分享知識與智慧的小天地！🎇

🎓 博主簡介：985高校的普通本碩，曾有幸發表過人工智能領域的 中科院頂刊一作論文，熟練掌握PyTorch框架。

🔧 技術專長： 在CV、NLP及多模態等領域有豐富的項目實戰經驗。已累計提供近千次定制化產品服務，助力用戶少走彎路、提高效率，近一年好評率100% 。

📝 博客風采： 積極分享關于深度學習、PyTorch、Python相關的實用內容。已發表原創文章600余篇，代碼分享次數逾九萬次。

💡 服務項目：包括但不限于科研輔導、知識付費咨詢以及為用戶需求提供定制化解決方案。

?
?
?
?
?
?
?
?
?
?
?
?
?
?
?

下滑即可查看博客內容

?
?
?
?
?
?
?
?
?
?
?
?
?
?
?
?

??

📚 一、認識argparse與action='store_true'

在Python中，argparse模塊是處理命令行參數的標準庫之一，它讓編寫用戶友好的命令行接口變得簡單。通過argparse，程序可以輕松地讀取命令行參數，并根據這些參數執行不同的操作。而action='store_true'是argparse中一個非常實用的參數，它允許我們定義一個標志（flag），當這個標志在命令行中被指定時，自動將對應的變量設置為True。

示例場景

假設我們正在編寫一個腳本，該腳本默認執行某個操作，但用戶可以通過命令行參數來啟用額外的功能。這時，action='store_true'就顯得非常有用。

---

🚀 二、action='store_true'的基本用法

下面是一個簡單的例子，演示了如何在argparse中使用action='store_true'。

import argparse# 創建 ArgumentParser 對象
parser = argparse.ArgumentParser(description='示例腳本，展示 action=store_true 的用法。')# 添加一個標志 --verbose，當它被指定時，verbose 變量將被設置為 True
parser.add_argument('--verbose', help='啟用詳細模式', action='store_true')# 解析命令行參數
args = parser.parse_args()# 根據 verbose 的值執行不同的操作
if args.verbose:print('詳細模式已啟用！')
else:print('執行默認操作。')

在這個例子中，如果用戶運行腳本時沒有指定--verbose標志，那么args.verbose將會是False（因為action='store_true'的默認值是False），腳本將執行默認操作。如果用戶指定了--verbose（如python script.py --verbose），則args.verbose會被設置為True，腳本將輸出“詳細模式已啟用！”。

---

💡 三、完整命令行指令示例

假設上述腳本保存為script.py，那么完整的命令行指令如下：

• 執行默認操作（不啟用詳細模式）：

  python script.py
  

  輸出將會是：“執行默認操作。”

• 啟用詳細模式：

  python script.py --verbose
  

  輸出將會是：“詳細模式已啟用！”

---

🔍 四、舉一反三：action='store_false'

action='store_false'是argparse模塊中另一個實用的參數動作，它與action='store_true'相對應，但行為相反。當在命令行中指定了與action='store_false'相關聯的標志時，相應的變量會被設置為False。這在需要明確禁用某些默認開啟的功能時特別有用。

示例

假設我們有一個腳本，它默認會打印一些調試信息，但我們想要通過命令行參數來禁用這些調試信息。

import argparseparser = argparse.ArgumentParser(description='示例腳本，展示 action=store_false 的用法。')# 添加一個標志 --no-debug，當它被指定時，debug 變量將被設置為 False
parser.add_argument('--no-debug', help='禁用調試信息', action='store_false')# 注意：我們沒有為 debug 變量設置默認值，但根據 argparse 的規則，action=store_false 的默認值實際上是 True
# 如果想要明確設置默認值，可以使用 default=True 參數
# parser.add_argument('--no-debug', help='禁用調試信息', action='store_false', default=True)# 解析命令行參數
args = parser.parse_args()# 如果 args.no_debug 為 False（即 --no-debug 沒有被指定），則打印調試信息
if not args.no_debug:print('調試信息：這是調試信息的示例。')
else:print('調試信息已禁用。')

在這個例子中，如果用戶沒有指定--no-debug標志，則args.no_debug的值為True（因為action='store_false'的“未指定”狀態被視為True，但這通常不是我們想要的行為，所以更推薦使用default=True來明確設置默認值），腳本將打印調試信息。如果用戶指定了--no-debug，則args.no_debug會被設置為False，腳本將輸出“調試信息已禁用。”。然而，為了清晰和避免混淆，推薦總是為使用action='store_false'的參數明確設置default=True。

---

📚 五、argparse的更多應用場景

argparse模塊不僅僅局限于簡單的標志（flag）處理，它還可以處理位置參數（positional arguments）、互斥參數組（mutually exclusive groups）、子命令（subcommands）等復雜場景。

位置參數

位置參數是命令行中按照特定順序出現的參數，它們不需要前綴（如--）。

parser.add_argument('filename', help='要處理的文件名')

互斥參數組

互斥參數組允許你定義一組參數，這些參數中一次只能指定一個。

group = parser.add_mutually_exclusive_group()
group.add_argument('--verbose', action='store_true')
group.add_argument('--quiet', action='store_true')

---

🚀 六、總結與展望

通過本文，我們深入了解了argparse模塊中action='store_true'和action='store_false'的作用，以及如何在命令行中具體使用它們。我們還通過示例展示了argparse的基本用法和進階用法，包括位置參數、互斥參數組等。這些功能使得argparse成為Python中處理命令行參數的首選庫。

展望未來，隨著Python在數據科學、機器學習、Web開發等領域的廣泛應用，命令行工具的重要性日益凸顯。掌握argparse模塊，將幫助我們編寫出更加用戶友好、功能強大的命令行工具。同時，隨著Python生態的不斷發展，我們也可以期待argparse模塊本身能夠繼續進化，為我們提供更多便利和強大的功能。

最后，希望本文能夠幫助讀者更好地理解和使用argparse模塊，從而編寫出更加優秀的Python腳本和命令行工具。🎉