在運行程序時,可能需要根據不同的條件,輸 入不同的命令行選項來實現不同的功能。目前有短選項 和長選項 兩種格式。短選項格式爲"-" 加 上單個字母選項;長選項爲"--" 加上一個單詞。長格式是在Linux 下 引入的。許多Linux 程序都支持這兩種格式。在Python 中 提供了getopt 模塊很好的實現了對這兩種用法的支持,而且使用簡單。
取得命令行參數
在使用之前,首先要取得命令行參數。使用sys
模塊可以得到命令行參數。
import sys
print sys.argv
然後在命令行下敲入任意的參數,如:
python get.py -o t --help cmd file1 file2
結果爲:
['get.py',
'-o', 't', '--help', 'cmd', 'file1', 'file2']
可見,所有命令行參數以空格爲分隔符,都保存在了sys.argv
列
表
中。其中第1
個爲腳本的文件名。
選項的寫法要求
對於短格式,"-"
號後面要緊跟一個選項字母。如果還有此選項的附加參數,可以用空格分開,也可
以不分開。長度任意,可以用引號。如以下是正確的:
-o
-oa
-obbbb
-o
bbbb
-o "a b"
對於長格式,"--"
號後面要跟一個單詞。如果還有些選項的附加參數,後面要緊跟"="
,
再加上參數。"="
號前後不能有空格。如以下是正確的:
--help=file1
而這些是不正確的:
--
help=file1
--help =file1
--help = file1
--help= file1
如何用getopt
進行分析
使用getopt
模
塊分析命令行參數大體上分爲三個步驟:
1.
導入getopt, sys
模塊
2.
分析命令行參數
3.
處理結果
第一步很簡單,只需要:
import getopt, sys
第二步處理方法如下(以Python
手冊上的例子爲例):
try:
opts, args =
getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])
except
getopt.GetoptError:
# print help information and exit:
1.
處理所使用的函數叫getopt()
,因爲是直接使用import
導入的getopt
模塊,所以要加上限定getopt
纔可以。
2.
使用sys.argv[1:]
過
濾掉第一個參數(它是執行腳本的名字,不應算作參數的一部分)。
3.
使用短格式分析串"ho:"
。
當一個選項只是表示開關狀態時,即後面不帶附加參數時,在分析串中寫入選項字符。當選項後面是帶一個附加參數時,在分析串中寫入選項字符同時後面加
一個":"
號
。所以"ho:"
就表
示"h"
是一個開關選項;"o:"
則表示後
面應該帶一個參數。
4.
使用長格式分析串列表:["help", "output="]
。長格式串也
可以有開關狀態,即後面不跟"="
號。如果跟一個等號則表示後面還應有一個參數
。這
個長格式表示"help"
是一個開關選項;"output="
則
表示後面應該帶一個參數。
5.
調用getopt
函數。函數返回兩個列表:opts
和args
。opts
爲分析出的格式信息。args
爲不屬於格式信息
的剩餘的命令行參數。opts
是一個兩元組的列表。每個元素爲:(
選項串,
附加參數)
。如果沒有附加參數則爲空串''
。
6.
整個過程使用異
常來包含,這樣當分析出錯時,就可以打印出使用信息來通知用戶如何使用這個程序。
如上面解釋的一個命令行例子爲:
'-h
-o file --help --output=out file1 file2'
在分析完成後,opts
應該是:
[('-h', ''), ('-o', 'file'), ('--help',
''), ('--output', 'out')]
而args
則爲:
['file1',
'file2']
第三步主要是對分析出的參數進行判斷是否存在,然後
再進一步處理。主要的處理模式爲:
for o, a in
opts:
if o in ("-h", "--help"):
usage()
sys.exit()
if
o in ("-o", "--output"):
output = a
使用一個循環,每次從opts
中取出一個兩元組,賦給兩個變量。o
保存選項參數,a
爲附加參數。接着對取出的選項參數
進行處理。(例子也採用手冊的例子)