Python模塊之getopt詳解

時千辛萬苦寫完的Python模塊，方便其他工程調用。但此模塊實現的功能也經常用于直接運行來得到相應的輸出。收錄進自己的 toolkit 中。

在寫好模塊代碼的底部插入以下代碼，來實現直接運行python腳本時執行指定的代碼塊（一般為接收命令行參數，將參數傳給模塊中定義的函數，并將函數的返回結果進行格式化輸出）。

if __name__=="__main__":

direct execution code

既然是直接執行，難免會遇到向腳本傳參的情況。Python 的 getopt 就是用于解析命令行選項的模塊。getopt 可直接調用。

功能：getopt(args, options[, long_options]) > opts, args

其中 opts 是選項，args 是指定選項的參數。opts 支持短格式，如 Linux 中獲取命令幫助常用的 -h ，也支持長格式，如 --help。再如 mysql 命令中的 -p, --password 選項。getopt 就是幫助解析類似的命令行參數。

為了更好的理解 getopt ，以下演示代碼未包含模塊部分，而是直接寫成了可以獲取命令行參數并做相應輸出的直接運行的python腳本。

演示代碼：

--代碼部分開始---

#!/bin/env python

# -*- coding: utf-8 -*-

# website : www.z-dig.com

import sys

import getopt

args=sys.argv[1:]

def usage():

print("Usage:{0} [-h name | --host=name] [-P # | --port=#] [-u name | --user=name] [-p password | --password=password] [-? | --help]".format(sys.argv[0]))

if (sys.argv.__len__())==1:

usage()

try:

opts, args=getopt.getopt(args, "h:P:u:p:?", ["host=", "port=", "user=", "password=", "help"])

except getopt.GetoptError:

usage()

sys.exit(1)

for opt, arg in opts:

if opt in ('-?','--help'):

usage()

elif opt in ('-h', '--host'):

host=arg

elif opt in ('-P', '--port'):

port=arg

elif opt in ('-u', '--user'):

user=arg

elif opt in ('-p', '--password'):

passwd=arg

for k in ('host', 'port', 'user', 'passwd'):

if k in locals().keys():

print("{0} : {1}".format(k,eval(k)))

---代碼部分結束---

將腳本命名為 getopt-demo.py 并賦予可執行權限。

演示結果：

1、

[root@z-dig python-scripts]# ./getopt_demo.py

[root@z-dig python-scripts]#

2、

[root@z-dig python-scripts]# ./getopt_demo.py -?

3、

[root@z-dig python-scripts]# ./getopt_demo.py --help

[root@z-dig python-scripts]#

4、

[root@z-dig python-scripts]# ./getopt_demo.py -h 127.0.0.1

host : 127.0.0.1

[root@z-dig python-scripts]#

5、

[root@z-dig python-scripts]# ./getopt_demo.py -h 127.0.0.1 -P 3306

host : 127.0.0.1

port : 3306

[root@z-dig python-scripts]#

6、

[root@z-dig python-scripts]# ./getopt_demo.py -h 127.0.0.1 -P 3306 --user root --password=123456

host : 127.0.0.1

port : 3306

user : root

passwd : 123456

[root@z-dig python-scripts]#

代碼解析：

1、

args=sys.argv[1:] - 獲取命令行中的所有參數，因為 sys.argv[0]是腳本的名稱，所有真正的參數從1開始。

2、

usage() - 默認的幫助輸出，在代碼出現異常或傳入參數為幫助時打印到終端。

3、

opts, args=getopt.getopt(args, "h:P:u:p:?", ["host=", "port=", "user=", "password=", "help"]) - 將命令行中的所有參數使用getopt模塊的getopt函數進行解析。

其中 "h:P:u:p:?" 為短格式，字母h后面的：說明該選項后指定參數，? 后面沒有：,說明該選項后不可指定參數。["host=", "port=", "user=", "password=", "help"]為長格式，同樣后面有=的表明該選項后可指定參數。

opts 為匹配所定義格式的參數列表，每組參數為一個元組，選項在前，參數在后。

args 為定義格式外的其他參數輸入的列表。

例：在執行 getopt_demo.py -h 127.0.0.1 -p 123456 www.z-dig.com mr.zhou 時

opts 為 [('-h', '127.0.0.1'), ('-p', '123456')]

args 為 ['www.z-dig.com', 'mr.zhou']

4、for opt, arg in opts: - 遍歷 opts 列表中的元組。此時 opt 為選項,arg 為參數。

原文：http://www.z-dig.com/error/70-1-1.html

用

getopt()用來分析命令行參數。參數argc和argv分別代表參數個數和內容，跟main（）函數的命令行參數是一樣的。

//頭文件
#include <unistd.h>
//函數原型
int getopt(int argc, char * const argv[], const char *optstring);

參數說明

argc：就是main函數中的形參argc，表示參數的數量
argv：就是main函數中的形參argv，表示參數的字符串變量數組
optstring：選項字符串，一個字母表示不帶值的參數，如果字母后帶有一個:，表示必須帶值的參數。如果帶有兩個:，表示是可選的參數。

例如"ab:c::",程序運行時可接受的參數為"-a -b 1 -c"或者"-a -b 1 -c2"
多個不帶值的參數可以進行連寫
可選值的參數，中間不可以帶有空格

返回值說明:

optarg：用于獲取傳入的參數的值。
optind：argv 的當前索引值。當getopt()在while循環中使用時，循環結束后，剩下的字符串視為操作數，在argv[optind]至argv[argc-1]中可以找到
opterr：正常運行狀態下為 0。非零時表示存在無效選項或者缺少選項參數，并輸出其錯誤信息
optopt：當發現無效選項字符之時，getopt()函數或返回'?'字符，或返回':'字符，并且optopt包含了所發現的無效選項字符

使用方法

#include <stdio.h>
#include <unistd.h>
 
int main(int argc, char *argv[]) {
    int para;
    while ((para=getopt(argc, argv, "ab:c::")) !=-1) {
        switch (para) {
            case 'a':
                printf("參數是a,無值\n");
                break;
            case 'b':
                printf("參數是b, 值是: %s\n", optarg);
                break;
            case 'c':
                if(optarg)
                    printf("參數是c, 值是: %s\n", optarg);
                else 
                    printf("參數是c,無值\n");
                break;
            default:
                printf("error opterr: %d\n", opterr);
                break;
        }
    }
    return 0;
}

測試結果

述

我們經常使用腳本后面跟參數這種用法，這個時候使用getopt/getopts再合適不過了；今天主要詳細說明 getopt （系統外部用法，后來增加的）與 getopts（內部，不支持長選項只能是單個字符的短選項）的區別和用法。

一、幫助

二、區別

getopt 與 getopts 都是 Bash 中用來獲取與分析命令行參數的工具，常用在 Shell 腳本中被用來分析腳本參數。

兩者的比較

（1）getopts 是 Shell 內建命令，getopt 是一個獨立外部工具

（2）getopts 使用語法簡單，getopt 使用語法較復雜

（3）getopts 不支持長參數（如：--option ），getopt 支持

（4）getopts 不會重排所有參數的順序，getopt 會重排參數順序（這里的區別下面會說明）

（5）getopts 出現的目的是為了代替 getopt 較快捷的執行參數分析工作

三、getopts實例

getopts后面的字符串就是可以使用的選項列表，每個字母代表一個選項，后面帶:的意味著選項除了定義本身之外，還會帶上一個參數作為選項的值，比如d:在實際的使用中就會對應-d 30，選項的值就是30；getopts字符串中沒有跟隨:的是開關型選項，不需要再指定值，相當于true/false，只要帶了這個參數就是true。如果命令行中包含了沒有在getopts列表中的選項，會有警告信息，如果在整個getopts字符串前面也加上個:，就能消除警告信息了。

使用getopts識別出各個選項之后，就可以配合case來進行相應的操作了。操作中有兩個相對固定的“常量”，一個是OPTARG，用來取當前選項的值，另外一個是OPTIND，代表當前選項在參數列表中的位移。注意case中的最后一個選擇──?，代表這如果出現了不認識的選項，所進行的操作。
選項參數識別完成之后，如果要取剩余的其它命令行參數，可以使用shift把選項參數抹去，就像例子里面的那樣，對整個參數列表進行左移操作，最左邊的參數就丟失了（已經用case判斷并進行了處理，不再需要了），位移的長度正好是剛才case循環完畢之后的OPTIND - 1，因為參數從1開始編號，選項處理完畢之后，正好指向剩余其它參數的第一個。在這里還要知道，getopts在處理參數的時候，處理一個開關型選項，OPTIND加1，處理一個帶值的選項參數，OPTIND則會加2。
最后，真正需要處理的參數就是1 1 #了，可以用for循環依次處理。

使用getopts處理參數雖然是方便，但仍然有兩個小小的局限：
1）選項參數的格式必須是-d val，而不能是中間沒有空格的-dval。
2）所有選項參數必須寫在其它參數的前面，因為getopts是從命令行前面開始處理，遇到非-開頭的參數，或者選項參數結束標記--就中止了，如果中間遇到非選項的命令行參數，后面的選項參數就都取不到了。
3）不支持長選項，也就是--debug之類的選項

測試結果：

四、getopt實例

#!/bin/bash 
# Example input and output (from the bash prompt):
# ./parse.bash -a par1 'another arg' --c-long 'wow!*\?' -cmore -b " very long "
# Option a
# Option c, no argument
# Option c, argument `more'
# Option b, argument ` very long '
# Remaining arguments:
# --> `par1'
# --> `another arg'
# --> `wow!*\?'
 
# Note that we use `"$@"' to let each command-line parameter expand to a
# separate word. The quotes around `$@' are essential!
# We need TEMP as the `eval set --' would nuke the return value of getopt.
 
#-o表示短選項，兩個冒號表示該選項有一個可選參數，可選參數必須緊貼選項
#如-carg 而不能是-c arg
#--long表示長選項
#"$@"在上面解釋過
# -n:出錯時的信息
# -- ：舉一個例子比較好理解：
#我們要創建一個名字為 "-f"的目錄你會怎么辦？
# mkdir -f #不成功，因為-f會被mkdir當作選項來解析，這時就可以使用
# mkdir -- -f 這樣-f就不會被作為選項。
 
TEMP=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
 -n 'example.bash' -- "$@"`
 
if [ $? !=0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi
 
# Note the quotes around `$TEMP': they are essential!
#set 會重新排列參數的順序，也就是改變$1,$2...$n的值，這些值在getopt中重新排列過了
eval set -- "$TEMP"
 
#經過getopt的處理，下面處理具體選項。
 
while true ; do
 case "$1" in
 -a|--a-long) echo "Option a" ; shift ;;
 -b|--b-long) echo "Option b, argument \`$2'" ; shift 2 ;;
 -c|--c-long)
 # c has an optional argument. As we are in quoted mode,
 # an empty parameter will be generated if its optional
 # argument is not found.
 case "$2" in
 "") echo "Option c, no argument"; shift 2 ;;
 *) echo "Option c, argument \`$2'" ; shift 2 ;;
 esac ;;
 --) shift ; break ;;
 *) echo "Internal error!" ; exit 1 ;;
 esac
done
echo "Remaining arguments:"
for arg do
 echo '--> '"\`$arg'" ;
done

測試：

五、綜合實例

這個腳本整體思路是：

先判斷是否有getopt命令，如果有就用這個命令沒有的話采用getopts命令；

getopt 判斷體中首先判斷第一個參數如果是 -a|–appid，則shift 后移一位也是就是-a 參數后面的值（如果有的話）保存起來； shift 執行一次，然后1( 1(1({1}寫法也可以)就變成第三個參數了，如果 -f|–fusion是第一個參數，操作效果和上面一樣；如果第一個參數是 -h|–help 的話調用Usage方法并執行exit 0 退出；

如果第一個參數是 – 則shift 一下，break 跳出整個循環，（continue一般是跳出當前循環，然后開始新的循環）；如果第一個參數是為其他(?通配其他內容)調用Usage方法并執行exit 1退出

ps:

basename $0值顯示當前腳本或命令的名字
shift 命令每執行一次，變量的個數($#)減一，而變量值提前一位
比如shift 3表示原來的$4現在變成$1，原來的$5現在變成$2等等，原來的$1、$2、$3丟棄，$0不移動。不帶參數的shift命令相當于shift 1
$#: 參數的個數
$*: 參數列表 所有的參數 作為一個整體 如 ./xx.sh 1 2 3, $*值為“1 2 3”
$@: 參數列表 所有參數 逐個輸出 如 ./xx.sh 1 2 3 $@ 值為"1" “2” “3”
set -- "${ARGS}" 相當于重置了 執行腳本 后跟參數，把執行腳本后跟參數‘$@’ 變成了 ${ARGS}

這個還是有點難度的，大家有空可以自己測試研究一下，大概半個小時就可以掌握了。

覺得有用的朋友多幫忙轉發哦！后面會分享更多devops和DBA方面的內容，感興趣的朋友可以關注下~

在線咨詢

上一篇：如何一鍵復制某某文庫不能復制的內容
下一篇：Axure中繼器姊妹篇：列表頁添加排序和篩選功能

您的項目需求

*請認真填寫需求信息，我們會在24小時內與您取得聯系。

整合營銷服務商

Python模塊之getopt詳解

用

使用方法

測試結果

述

一、幫助

二、區別

三、getopts實例

四、getopt實例

五、綜合實例

您的項目需求