Python笔记：命令行参数解析

Python021

Python笔记：命令行参数解析,第1张

有些时候我们需要通过命令行将参数传递给脚本，C语言中有个getopt()方法，python中也有个类似的命令行参数解析方法getopt()。python也提供了比getopt()更简洁的argparse方法。另外，sys模块也可以实现简单的参数解析，本文将对这3种命令行参数解析方法简要介绍。

sys.argv是传入的参数列表，sys.argv[0]是当前python脚本的名称，sys.argv[1]表示第一个参数，以此类推。

命令行运行：

可以看到传入的参数通过sys.argv来获取，它就是一个参数列表。

python的getopt与C语言的的getopt()函数类似。相比于sys模块，支持长参数和短参数，并对参数解析赋值。但它需要结合sys模块进行参数解析，语法格式如下：

短参数为单个英文字母，如果必须赋值需要在后面加英文冒号( : )，长参数一般为字符串(相比短参数，更能说明参数含义)，如果必须赋值需要在后面加等号( = )。

命令行运行：

注意：短参数(options)和长参数(long_options)不需要一一对应，可以任意顺序，也可以只有短参数或者只有长参数。

argparse模块提供了很多可以设置的参数，例如参数的默认值，帮助消息，参数的数据类型等。argparse类主要包括ArgumentParser、add_argument和parse_args三个方法。

下面介绍这三个函数的使用方法。

argparse默认提供了 -h | --help 参数：

命令行运行：

下面列出部分参数：

下面来添加参数：

命令行运行：

parse_args() 方法用于解析参数，在前面的示例代码中使用parse_args方法来提取参数值，对于无效或者错误的参数会打印错误信息和帮助信息：

命令行运行：

本文介绍了Python的三种命令行参数解析方法sys.argv、getopt和argparse，可以根据自己的需要进行选择，getopt和argparse两种方法相比来说，建议选择argparse，代码量更少更简洁。更详细的使用方法参考官方文档：

--THE END--

本文实例讲述了python读取命令行参数的方法。分享给大家供大家参考。具体分析如下：

如果想对python脚本传参数，python中对应的argc, argv(c语言的命令行参数)是什么呢？

需要模块：sys

参数个数：len(sys.argv)

脚本名：sys.argv[0]

参数1： sys.argv[1]

参数2： sys.argv[2]

test.py：

import sys

print "脚本名：", sys.argv[0]

for i in range(1, len(sys.argv)):

print "参数", i, sys.argv[i]

>>>python test.py hello world

脚本名：test.py

参数 1 hello

参数 2 world

python中使用命令行选项：

例如我们需要一个convert.py脚本。它的作用是处理一个文件,并将处理后的结果输出到另一个文件中。

要求该脚本满足以下条件：

1.通过-i -o选项来区别参数是输入文件还是输出文件.

>>>python convert.py -i inputfile -o outputfile

2.当不知道convert.py需要哪些参数时，用-h打印出帮助信息

>>>python convert.py -h

getopt函数原形:

getopt.getopt(args, options[, long_options])

convert.py：

import sys, getopt

opts, args = getopt.getopt(sys.argv[1:], "hi:o:")

input_file=""

output_file=""

for op, value in opts:

if op == "-i":

input_file = value

elif op == "-o":

output_file = value

elif op == "-h":

usage()

sys.exit()

代码解释：

a) sys.argv[1:]为要处理的参数列表，sys.argv[0]为脚本名，所以用sys.argv[1:]过滤掉脚本名。

b) "hi:o:": 当一个选项只是表示开关状态时，即后面不带附加参数时，在分析串中写入选项字符。当选项后面是带一个附加参数时，在分析串中写入选项字符同时后面加一个":"号。所以"hi:o:"就表示"h"是一个开关选项；"i:"和"o:"则表示后面应该带一个参数。

c) 调用getopt函数。函数返回两个列表：opts和args。opts为分析出的格式信息。args为不属于格式信息的剩余的命令行参数。opts是一个两元组的列表。每个元素为：(选项串,附加参数)。如果没有附加参数则为空串''。

getopt函数的第三个参数[, long_options]为可选的长选项参数，上面例子中的都为短选项(如-i -o)

长选项格式举例:

--version

--file=error.txt

让一个脚本同时支持短选项和长选项

getopt.getopt(sys.argv[1:], "hi:o:", ["version", "file="])

希望本文所述对大家的Python程序设计有所帮助。

Python 标准库中的 argparse 可以根据程序中的定义，从 sys.argv 中解析参数，并且自动生成帮助信息。

使用 add_argument 方法为应用程序添加参数，其中 add_argument 方法的参数比较多，这也使得 argparse 库的使用不够简洁，后续将继续为大家介绍更好用的命令行参数解析的开源库 click 。

下面是 add_argument 方法的参数及含义总结：

解析参数需要使用 ArgumentParser 实例的 parse_args 方法，此方法返回一个 NameSpace 对象；可以通过访问 NameSpace 对象属性的方式获取参数值。

下面是一个简单的例子：通过 parser.server 获取 --host 选项的值，通过 parse.boolean_switch 获取 -t 选项的值。

查看帮助信息：

参数默认值：

指定参数：

打印帮助信息：

打印版本信息：

传递参数：