命令行運行Python腳本時傳入參數的三種方式

原文鏈接：命令行運行Python腳本時傳入參數的三種方式（原文的幾處錯誤在此已糾正）

 

如果在運行python腳本時需要傳入一些參數，例如gpus與batch_size，可以使用如下三種方式。

python script.py 0,1,2 10
python script.py -gpus=0,1,2 --batch-size=10
python script.py -gpus=0,1,2 --batch_size=10

 

這三種格式對應不同的參數解析方式，分別為sys.argv, argparse, tf.app.run, 前兩者是python自帶的功能，最后一個是tensorflow提供的便捷方式(只是在命令行執行時看上去跟第二個相同，源碼部分的區別見下)。

 

sys.argv

sys模塊是很常用的模塊， 它封裝了與python解釋器相關的數據，例如sys.modules里面有已經加載了的所有模塊信息，sys.path里面是PYTHONPATH的內容，而sys.argv則封裝了傳入的參數數據。
使用sys.argv接收上面第一個命令中包含的參數方式如下：

import sys
gpus = sys.argv[1]
#gpus = [int(gpus.split(','))]
batch_size = sys.argv[2]
print(gpus, type(gpus))
print(batch_size, type(batch_size))

執行結果：

D:\projects\Pycharm Projects\some-toys\something_else>python argv_test.py 1,0,2 10
1,0,2 <class 'str'>
10 <class 'str'>

 

argparse

import argparse
parser = argparse.ArgumentParser(description='manual to this script')
parser.add_argument('--gpus', type=str, default = None)
parser.add_argument('--batch-size', type=int, default=32)
args = parser.parse_args()
print(args.gpus, type(args.gpus))
print(args.batch_size, type(args.batch_size))

 

執行結果：

D:\projects\Pycharm Projects\some-toys\something_else>python argv_test.py --gpus=0,1,2 --batch-size=20
0,1,2 <class 'str'>
20 <class 'int'>

需要注意的是，腳本運行命令python script.py --gpus=0,1,2 --batch-size=10中的batch-size會被自動解析成batch_size.
parser.add_argument 方法的type參數理論上可以是任何合法的類型， 但有些參數傳入格式比較麻煩，例如list，所以一般使用bool, int, str, float這些基本類型就行了，更復雜的需求可以通過str傳入，然后手動解析。bool類型的解析比較特殊，傳入任何值都會被解析成True，傳入空值時才為False

python script.py --bool-val=0 # args.bool_val=True
python script.py --bool-val=False # args.bool_val=True
python script.py --bool-val=     # args.bool_val=什么都不寫False

通過這個方法還能指定命令的幫助信息。具體請看API文檔：https://docs.python.org/2/library/argparse.html

 

tf.app.run

這個我暫時沒用到，可以參考原文實現一下。