Python 命令行参数和getopt模块详解

时间:2023-03-08 17:26:36
Python 命令行参数和getopt模块详解

有时候我们需要写一些脚本处理一些任务,这时候往往需要提供一些命令行参数,根据不同参数进行不同的处理,在Python里,命令行的参数和C语言很类似(因为标准Python是用C语言实现的)。在C语言里,main函数的原型为int main(int argc, char **argv),这里主要指linux平台, argc指的是命令行传入的参数个数(程序的name为第一个参数),而argv则是一个指针数组,每一个元素为指向一个命令行参数的指针。在Python里的命令行参数是存储在sys.argv里,argv是一个列表,第一个元素也为程序名称。

看下面的例子:

test.py

# -*- coding:utf-8 -*-

import sys

if __name__ == '__main__':
for item in sys.argv:
print i

在命令行运行./test.py  1 2 3,结果如下:

test.py

1

2

3

用这种方式可以进行命令行参数的判断从而进行不同的动作。
而Python的标准库里实际上有专门处理命令行参数的getopt模块,里面的提供了2个函数和一个类,我们主要使用getopt函数,先看下函数原型:
def getopt(args, shortopts, longopts = []):
先看一个例子,这样会便于理解。

try:
opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])
except getopt.GetoptError:
# print help information and exit: for name, value in opts:
print name, value
for item in args:
print item

1. 处理所使用的函数叫getopt() ,因为是直接使用import 导入的getopt 模块,所以要加上限定getopt 才可以。

2. 使用sys.argv[1:] 过滤掉第一个参数(它是执行脚本的名字,不应算作参数的一部分)。

3. 使用短格式分析串"ho:"
。当一个选项只是表示开关状态时,即后面不带附加参数时,在分析串中写入选项字符。当选项后面是带一个附加参数时,在分析串中写入选项字符同时后面加一个":"
号 。所以"ho:" 就表示"h" 是一个开关选项;"o:" 则表示后面应该带一个参数。

4. 使用长格式分析串列表:["help", "output="] 。长格式串也可以有开关状态,即后面不跟"="
号。如果跟一个等号则表示后面还应有一个参数 。这个长格式表示"help" 是一个开关选项;"output=" 则表示后面应该带一个参数。

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

6. 整个过程使用异常来包含,这样当分析出错时,就可以打印出使用信息来通知用户如何使用这个程序。

如上面解释的一个命令行例子为:

'-h -o file --help --output=out file1 file2'

在分析完成后,opts 应该是:

[('-h', ''), ('-o', 'file'), ('--help', ''), ('--output', 'out')]

而args 则为:

['file1', 'file2']

下面就是根据不同参数处理:

for o, a in opts:
if o in ("-h", "--help"):
usage()
sys.exit()
if o in ("-o", "--output"):
output = a