python获取命令行参数的方法

程序员文章站 2022-05-12 13:15:13

...

介绍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:])

运行结果如下：

python获取命令行参数的方法

二、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获取命令行参数的方法