python中使用getopt

 

在運行程式時，可能需要根據不同的條件，輸入不同的命令列選項來實現不同的功能。目前有短選項和長選項兩種格式。短選項格式為"-"加上單個字母選
項；長選項為"—"加上一個單詞。長格式是在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

(註：根據我測試，這兒不用=好像也是可以的，我直接使用—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為附加參數。接著對取出的選項參數進行處理。