python中getopt函数详解

在运行程序时，可能需要根据不同的条件，输入不同的命令行选项来实现不同的功能。目前有短选项和长选项两种格式。短选项格式为"-"加上单个字母选项；长选项为"--"加上一个单词。长格式是在Linux下引入的。许多Linux程序都支持这两种格式。在Python中提供了getopt模块很好的实现了对这两种用法的支持，而且使用简单。

一、getopt模块有两个函数，两个属性：

函数：

getopt.getopt
getopt.gnu_getopt

属性：

getopt.error
getopt.GetoptError
这两个属性主要是用来抛出错误信息的，非常友好不是吗？

我们经常用到的是：getopt函数：

getopt.getopt(args, shortopts, longopts=[])
args指的是当前脚本接收的参数，它是一个列表，可以通过sys.argv获得
shortopts 是短参数　　啥是短参数啊？　　类似于　这样：python test.py -h # 输出帮助信息
longopts 是长参数　　啥是长参数啊？　　类似于　这样：python test.py -help # 输出帮助信息

import getopt
import sys

arg = getopt.getopt(sys.argv[1:],'-h',['help'])
print(arg)

结果如下：

root@Kali:~/python# python3.5 test.py -h
([('-h', '')], [])
root@Kali:~/python# python3.5 test.py --help
([('--help', '')], [])
root@Kali:~/python#

可以看到已经接收了参数。并且做了处理，为啥我传入sys.argv[1:]？

因为sys.argv里的argv[0]是当前脚本的文件名，不需要它去参与，要不然你的选项和选项值无法匹配，问题多多。
假设我要接收一个参数+参数值的选项怎么办？

#!/usr/bin/env python3.5
import urllib.request
import getopt
import sys

opts,args = getopt.getopt(sys.argv[1:],'-h-f:-v',['help','filename=','version'])
for opt_name,opt_value in opts:
    if opt_name in ('-h','--help'):
        print("[*] Help info")
        exit()
    if opt_name in ('-v','--version'):
        print("[*] Version is 0.01 ")
        exit()
    if opt_name in ('-f','--filename'):
        fileName = opt_value
        print("[*] Filename is ",fileName)
        # do something
        exit()

运行测试结果如下：

root@Kali:~/python# python3.5 test.py --filename=test
[*] Filename is  test
root@Kali:~/python# python3.5 test.py --filename=
[*] Filename is  
root@Kali:~/python# python3.5 test.py --help
[*] Help info
root@Kali:~/python# python3.5 test.py --version
[*] Version is 0.01 
root@Kali:~/python# python3.5 test.py -v
[*] Version is 0.01 
root@Kali:~/python# python3.5 test.py -f test
[*] Filename is  test
root@Kali:~/python#

来详细解释一下这几行代码
首先从短参数名开始。
我定义了'-h-f:-v' 大家发现没有，在-f后面多了一个":"
这个":"代表了当前参数是有值的，是一个参数名+参数值的参数
如果我再加一个-o: 那么证明-o后面是可以接收一个值，这个值就是-o的参数值，将会保存到opts变量中。
长参数名的方式和短参数差不多，唯一的区别就是长参数如果要接收值，那必须得在后面加上一个"="

短参数使用的时候是参数名[空格]参数值
长参数使用的时候是参数名=参数值
PS:不理解可以看我的测试结果

opts与args:

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

eg:

#!/usr/bin/env python
#-*- coding:utf-8 -*-

import sys
import getopt

list=['-t','192.168.26.216','-r',256,'-p',80]
args=['-h','-o','file','--help','--output=out','file1','file2']
opts, arg = getopt.getopt(args, "ho:", ["help", "output="])#"ho:"也可以写成'-h-o:'
print(opts)
print(arg)

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

输出结果：

E:\testPython\venv\Scripts\python.exe E:/testPython/a111/test1.py
[('-h', ''), ('-o', 'file'), ('--help', ''), ('--output', 'out')]
['file1', 'file2']

Process finished with exit code 0

白清羽

发布了84 篇原创文章 · 获赞 46 · 访问量 20万+

私信关注

python中getopt函数详解

猜你喜欢