11 python命令行選項使用

OptionParser模塊

-------------- 代碼說明  -----------------------------------------
簡單流程
1，首先，必須 import OptionParser 類，創建一個 OptionParser 對象：

    from optparse import OptionParser  
    parser = OptionParser()  


2，add_option() 方法來， 來定義命令行參數：
    parser.add_option("-f", "--file", ...)   
    說明：
    2.1 -f 或者 –file 分別是長短參數名：
    2.2 Actions 參數：
        它指示 optparse 當解析到一個命令行參數時該如何處理。

        例如：
        parser.add_option("-f", "--file",  action="store", type="string", dest="filename")  
        ## 執行腳本時 -f "1.txt"
            則會將 "1.txt"  字符串保存在變量filename中，  
        ## 執行本時，如果沒有-f
            則filename的值為None 或者默認值


        #action 參數取值：“store” （默認）, “tore_true” 和 “store_false”  
        ##（store_true 和 store_false ，用於處理帶命令行參數后面不 帶值的情況。）
        ## 即后面帶不帶參數是根據此項來配置的，
        
        例如：
        parser.add_option("-v", action="store_true", dest="verbose")  
        parser.add_option("-q", action="store_false", dest="verbose")  
        
        #當解析到 ‘-v’，options.verbose 將被賦予 True 值，反之，解析到 ‘-q’，會被賦予 False 值，
        ##如果沒有使用選項“-v”或者'-q'  則存儲變量的值為none
            如果執行腳本時帶了選項，則verbose變量值為，為“tore_true” 和 “store_false” 中的Ture或False  否則 就為默認值 或者 None


        例如：
        
        parser.add_option(
            "-f", "--file",  # 操作指令
            action="store",  ## 表明選項后面是要有值的
            dest="filename",  # 存儲的變量
            type="string",  # 變量類型(一般默認的也是此類型的)
            default='AAAA',
            help="write report to FILE",  # 顯示的幫助信息
            metavar="FILE"  # 存儲變量的值
        )
        
        
        (options, args) = parser.parse_args()
        
        
        if options.filename is True:
            print 'filename is true'
        if options.filename is False:
            print 'filename is False'

        
        


    2.3 type參數 
        type 參數取值：“string” （默認）， "int"  "float"...


    2.4 dest參數        
        dest 參數取值，即選項 取值將要保存在哪個變量中，（即變量名）  #如果沒有指定 dest 參數，將用命令行的參數名來對 options 對象的值進行存取。


    2.5 default 參數
        即 選項的的默認取值
        功能：用於設置默認值。
        例如：
        parser.add_option("-f","--file", action="store", dest="filename", default="foo.txt")  
        parser.add_option("-v", action="store_true", dest="verbose", default=True)  



3，調用 parse_args() 來解析程序的命令行：
    (options, args) = parser.parse_args()  

    說明;
        parse_args() 返回的兩個值：
        options，它是一個對象（optpars.Values），保存有命令行參數值。只要知道命令行參數名，如 file，就可以訪問其對應的值： options.file 。
        args，它是一個由 positional arguments 組成的列表。


4, add_option() 方法中的-h 選項
    功能：
        自動生成程序的幫助信息   ##  當 optparse 解析到 -h 或者 –help 命令行參數時，會調用 parser.print_help() 打印程序的幫助信息：
    
    例如：
    usage = "usage: %prog [options] arg1 arg2"  
    parser = OptionParser(usage=usage)  
    parser.add_option("-v", "--verbose",  
                      action="store_true", dest="verbose", default=True,  
                      help="make lots of noise [default]")  
    parser.add_option("-q", "--quiet",  
                      action="store_false", dest="verbose",  
                      help="be vewwy quiet (I'm hunting wabbits)")  
    parser.add_option("-f", "--filename",  
                      metavar="FILE", help="write output to FILE"),  
    parser.add_option("-m", "--mode",  
                      default="intermediate",  
                  help="interaction mode: novice, intermediate, "  
                       "or expert [default: %default]")


###############################################################################



###############################################
實戰用例

##導入模塊
from optparse import OptionParser
##創建實例對象
parser = OptionParser()


##添加選項
parser.add_option(
    "-p", "--pdbk",    ## -f 或者 –file 分別是長短參數名
    action="store",  # 指示 optparse 當解析到一個命令行參數時該如何處理
    dest="pdcl",  # 存儲的變量
    default=False,
    help="write pdbk data to oracle db"
)

##添加選項
parser.add_option(
    "-z", "--zdbk",
    action="store_true",
    dest="zdcl",  # 存儲的變量
    default=False,
    help="write zdbk data to oracle db"
)

##添加選項
parser.add_option(
    "-f", "--file",  # 操作指令
    action="store",
    dest="filename",  # 存儲的變量
    type="string",  # 變量類型   默認地，type 為'string'
    help="write report to FILE",  # 顯示的幫助信息
    metavar="FILE"  # 存儲變量的值
)

#添加選項
parser.add_option(
    "-q", "--quiet",
    action="store_false",
    dest="verbose",
    default=True,
    help="don't print status messages to stdout"
)

##解析選項
(options, args) = parser.parse_args()

##使用選項變量
if options.pdcl is True:
    print 'pdcl is true'
        print("pdcl={0}".format(options.pdcl))
if options.zdcl is True:
    print 'zdcl is true'
if options.filename is not None:
    print("filename={0}".format(options.filename))

print(args)

通過對上面三種參數解析策略的說明，可以看到這里使用OptionParser模塊進行解析是最佳方式。

##########  另種方法 #####################################################################
getopt模塊
getopt模塊是專門處理命令行參數的模塊，用於獲取命令行選項和參數，也就是sys.argv。
命令行選項使得程序的參數更加靈活。支持短選項模式（-）和長選項模式（--）。


該模塊提供了兩個方法及一個異常處理來解析命令行參數。
    getopt.getopt 
        方法用於解析命令行參數列表，
    語法格式如下：
        getopt.getopt(args, options[, long_options])

方法參數說明：
    args: 要解析的命令行參數列表。
    options: 以列表的格式定義，options后的冒號(:)表示該選項必須有附加的參數，不帶冒號表示該選項不附加參數。
    long_options: 以字符串的格式定義，long_options 后的等號(=)表示如果設置該選項，必須有附加的參數，否則就不附加參數。
    該方法返回值由兩個元素組成: 第一個是 (option, value) 元組的列表。 第二個是參數列表，包含那些沒有'-'或'--'的參數。