python取得命令列參數的方法總結

介紹python取得命令列參數的方法：getopt模和argparse模組。

python版本：2.7

一、getopt模組

 主要用到了模組中的函數：

options, args = getopt.getopt(args, shortopts, longopts=[])

參數args：一般是sys.argv[1:]。過濾掉sys.argv[0]，它是執行腳本的名字，不算做命令列參數。

參數shortopts：短格式分析字串。例如："hp:i:"，h後面沒有冒號，表示後面不帶參數；p和i後面有冒號，表示後面帶參數。

參數longopts：長格式分析串列清單。例如：["help", "ip=", "port="]，help後面沒有等號，表示後面不帶參數；ip和port後面帶冒號，表示後面帶參數。

傳回值options是以元組為元素的列表，每個元組的形式為：(選項串, 附加參數)，如：('-i', '192.168.0.1')

傳回值args是個列表，其中的元素是那些不含'-'或'--'的參數。

 

在命令列執行下述指令：

python test_getopt.py -i 192.168.0.1 -p 80 123 a

或

python test_getopt.py -ip=192.168.0.1 --port=80 123 a

test_getopt.py程式碼如下：

#encoding=utf-8

import getopt
import sys

def main(argv):
    try:
        options, args = getopt.getopt(argv, "hp:i:", ["help", "ip=", "port="])
    except getopt.GetoptError:
        sys.exit()

    for option, value in options:
        if option in ("-h", "--help"):
            print("help")
        if option in ("-i", "--ip"):
            print("ip is: {0}".format(value))
        if option in ("-p", "--port"):
            print("port is: {0}".format(value))

    print("error args: {0}".format(args))

if __name__ == '__main__':
    main(sys.argv[1:])

運行結果如下：

 

二、argparse模組

用於解析命令列選項和參數的標準模組。

使用步驟：

1: import argparse　　#導入模組

2: parser = argparse.ArgumentParser()　　#建立解析物件

3: parser .add_argument()　　#在該物件中新增使用到的命令列選項與參數

4: parser.parser_args()　　#解析命令列

 

接下來詳細介紹下方法ArgumentParser和add_argument：

ArgumentParser(prog=None, usage=None, description=None, epilog=None, parents=[], formatter_class=argparser.HelpFormatter, prefix_charents=[], formatter_class=argparser.HelpFormatter, prefix_charents='-',prefile_ None, argument_default=None, conflict_handler='error', add_help=True)

其中的參數都有預設值，當執行程式時由於參數不正確或當呼叫parser.print_help()方法時，會列印這些描述資訊。一般只需要傳遞參數description。

add_argument(name or flags... [, action] [, nargs] [, const] [, default] [, type] [, choices] [, required] [, help] [, metavar] [, dest])

其中的常用參數解釋如下：

name or flags: 命令列參數名稱或選項，如-p, --port

action:

　　　　store: 預設的action模式，儲存值到指定變數

　　　　store_const: 儲存值在參數的const部分指定，常用來實作非布林的命令列flag

store_true/store_false: 布林開關。 store_true的預設值為False，若命令列有輸入該布林開關則值為True。 store_false相反

　　　　　　append_const: 儲存值到列表，儲存值在參數的const部分指定

##　參數簡寫的輸入個數

　　　　version: 輸出版本信息，然後退出腳本

nargs: 命令列參數的個數，一般用通配符表示： ？表示只用一個，*表示0到多個，+表示1到多個

default: 預設值

type: 參數的類型，預設是string類型，還可以是float、 int和布林等型別

choices: 輸入值的範圍

required: 預設為False，若為True則表示參數必須輸入

help: 使用的協助提示訊息

dest: 參數在程式中的對應的變數名稱，如：add_argument("-a", dest="code_name")，在腳本中用parser.code_name來存取該命令列選項的值

 

範例腳本test_argparse.py程式碼如下：

#

 1 #encoding=utf-8 2 import argparse 3  4 def main(args): 5     print("--address {0}".format(args.code_address))    #args.address会报错，因为指定了dest的值 6     print("--flag {0}".format(args.flag))   #如果命令行中该参数输入的值不在choices列表中，则报错 7     print("--port {0}".format(args.port))   #prot的类型为int类型，如果命令行中没有输入该选项则报错 8     print("-l {0}".format(args.log))  #如果命令行中输入该参数，则该值为True。因为为短格式"-l"指定了别名"--log"，所以程序中用args.log来访问 9 10 if __name__ == '__main__':11     parser = argparse.ArgumentParser(usage="it's usage tip.", description="help info.")12     parser.add_argument("--address", default=80, help="the port number.", dest="code_address")13     parser.add_argument("--flag", choices=['.txt', '.jpg', '.xml', '.png'], default=".txt", help="the file type")14     parser.add_argument("--port", type=int, required=True, help="the port number.")15     parser.add_argument("-l", "--log", default=False, action="store_true", help="active log info.")16 17     args = parser.parse_args()18     main(args)

##分別執行下述指令：

#python test_argparse.py

python test_argparse.py --port 80

python test_argparse.py --port 80 --flag apk

python test_argparse.py --port 80 -l

 更多python取得命令列參數的方法總結相關文章請注意PHP中文網！