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

如何用getopt進行分析
  使用getopt模塊分析命令行參數大體上分爲三個步驟:

1.導入getopt, sys模塊
2.分析命令行參數
3.處理結果

例如模塊test1.py:
import getopt, sys

opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])#"ho:"也可以寫成'-h-o:'
print(opts)

print(args)

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爲不屬於格式信息的剩餘的命令行參數,即不是按照getopt()裏面定義的長或短選項字符和附加參數以外的信息opts是一個兩元組的列表。每個元素爲:(選項串,附加參數)。如果沒有附加參數則爲空串''
6. 整個過程使用異常來包含,這樣當分析出錯時,就可以打印出使用信息來通知用戶如何使用這個程序。

用上面解釋的一個命令行例子運行:

python test1.py '-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爲附加參數。接着對取出的選項參數進行處理。

轉自:http://blog.csdn.net/q_l_s/article/details/52921675

這裏再附一個解釋的較好的文章鏈接:http://www.jianshu.com/p/a877e5b46b2d

可以用如下的代碼運行一下,輸入不同命令行參數測試一下,文件test2.py:

import getopt
import sys

opts,args = getopt.getopt(sys.argv[1:],'-h-f:-v',['help','filename=','version'])
print(opts)
for opt_name,opt_value in opts:
    if opt_name in ('-h','--help'):
        print("[*] Help info")
        sys.exit()
    if opt_name in ('-v','--version'):
        print("[*] Version is 0.01 ")
        sys.exit()
    if opt_name in ('-f','--filename'):
        fileName = opt_value
        print("[*] Filename is ",fileName)
        # do something
        sys.exit()

我在Spyder裏面的ipython控制檯輸入:

%run sys_test2.py -f test
輸出:[('-f', 'test')]
[*] Filename is test

自己試試其他輸入,看看功能。

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章