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_chars='-', fromfile_prefix_chars=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: 存儲值到列表，該參數可以重復使用

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

　　　　count: 統計參數簡寫的輸入個數

　　　　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代碼如下：

#encoding=utf-8
import argparse

def main(args):
    print("--address {0}".format(args.code_address))    #args.address會報錯，因為指定了dest的值
    print("--flag {0}".format(args.flag))   #如果命令行中該參數輸入的值不在choices列表中，則報錯
    print("--port {0}".format(args.port))   #prot的類型為int類型，如果命令行中沒有輸入該選項則報錯
    print("-l {0}".format(args.log))  #如果命令行中輸入該參數，則該值為True。因為為短格式"-l"指定了別名"--log"，所以程序中用args.log來訪問

if __name__ == '__main__':
    parser = argparse.ArgumentParser(usage="it's usage tip.", description="help info.")
    parser.add_argument("--address", default=80, help="the port number.", dest="code_address")
    parser.add_argument("--flag", choices=['.txt', '.jpg', '.xml', '.png'], default=".txt", help="the file type")
    parser.add_argument("--port", type=int, required=True, help="the port number.")
    parser.add_argument("-l", "--log", default=False, action="store_true", help="active log info.")

    args = parser.parse_args()
    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

 

---

轉載請注明作者和出處~

藍閃