Python argparse中的action=store_true用法

前言

Python的命令行參數解析模塊學習。

示例

參數解析模塊支持action參數，這個參數可以設置為’store_true’、‘store_false’、'store_const’等。
例如下面這行代碼，表示如果命令行參數中出現了"–PARAM_NAME"，就把PARAM_NAME設置為True，否則為False。

parser.add_argument("--PARAM_NAME", action="store_true", help="HELP_INFO")

官方文檔

‘store_true’ and ‘store_false’ - These are special cases of ‘store_const’ used for storing the values True and False respectively. In addition, they create default values of False and True respectively. For example:

‘store_true’ 和 ‘store_false’ -這兩個是’store_const’的特例，分別用來設置True和False。另外，他們還會創建默認值。

>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action='store_true')
>>> parser.add_argument('--bar', action='store_false')
>>> parser.add_argument('--baz', action='store_false')
>>> parser.parse_args('--foo --bar'.split())
Namespace(foo=True, bar=False, baz=True)

多了解一點兒

自定義

你可以通過給定一個Action的子類或其他實現了相同接口的對象，來指定一個任意的action。
BooleanOptionalAction就是一個可以使用的action，它增加了布爾action特性，支持--foo和--no-foo的形式。

>>> import argparse
>>> parser = argparse.ArgumentParser()
>>> parser.add_argument('--foo', action=argparse.BooleanOptionalAction)
>>> parser.parse_args(['--no-foo'])
Namespace(foo=False)

小結

'--foo', action='store_true'，可以很方便地實現布爾類型的參數。

思考

Python3 開始，很多內置模塊都轉向了面向對象范式。
對于早期開始使用Python的用戶來說，見到的代碼更多是面向過程或者是函數風格的，例如，從Google開源的一些項目可以看到很多Python 2.x的代碼風格。

補充：python庫Argparse中的可選參數設置 action=‘store_true‘ 的用法

store_true 是指帶觸發action時為真，不觸發則為假。

通俗講是指運行程序是否帶參數,看例子就明白了。

一、沒有default

import argparse
 
parser = argparse.ArgumentParser(description='test.py')
parser.add_argument('--cuda', type=bool, default=True,  help='use cuda')
parser.add_argument('--cpu',action='store_true',help='use cpu')
args = parser.parse_args()
 
print("cuda: ",args.cuda)
print("cpu: ",args.cpu)

如果運行命令為：python test.py

則輸出為：

cuda: ?True
cpu: ?False

如果運行命令為：python test.py --cpu

則輸出為：

cuda: ?True
cpu: ?True

二、有default

當然 ‘store_true’ 也可以設置 default ，雖然這樣看起來很奇怪，也不好用。如：

parser.add_argument('--cpu',default=True,action='store_true',help='use cpu')
print("cpu: ",args.cpu)

default=True時運行程序時加不加 “ --cpu ” 輸出都是 cpu: True

但default=False就不一樣了：

parser.add_argument('--cpu',default=False,action='store_true',help='use cpu')
print("cpu: ",args.cpu)

若運行命令是 python test.py，則輸出 cpu: False

若運行命令是 python test.py --cpu，則輸出 cpu: True