getops模块

这个模块一共有两个函数,两个属性
函数:

  • 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 是一个两元组的列表。每个元素为:( 选项串, 附加参数) 。如果没有附加参数则为空串'' 。

 

 

 

 

 

 

 

 

 

第一步很简单,只需要: 
import getopt, sys
第二步处理方法如下(以Python 手册上的例子为例): 

[python] view plain copy
 
  1. try:    
  2.     opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])    
  3. except getopt.GetoptError:    
  4.     # print help information and exit  

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']
第三步主要是对分析出的参数进行判断是否存在,然后再进一步处理。主要的处理模式为: 

[python] view plain copy
 
  1. for o, a in opts:    
  2.     if o in ("-h", "--help"):    
  3.         usage()    
  4.         sys.exit()    
  5.     if o in ("-o", "--output"):    
  6.         output = a   

使用一个循环,每次从opts 中取出一个两元组,赋给两个变量。o 保存选项参数,a 为附加参数。接着对取出的选项参数进行处理。

实践:

qixuan@ubuntu:~/qixuan02$ vi 2.py
  3 import sys;  
  4 import getopt;  
  5   
  6 def usage():  
  7     print("Usage:%s [-a|-o|-c] [--help|--output] args...." %Dsys.argv[0]);
  8 
  9 
 10 if "__main__" == __name__:
 11     #lsArgs = [""];  
 12       
 13     try:
 14         opts,args = getopt.getopt(sys.argv[1:], "ao:c", ["help", "output="]);
 15 
 16         print("============ opts ==================");
 17         print(opts);
 18 
 19         print("============ args ==================");
 20         print(args);
 21 
 22         #check all param  
 23         for opt,arg in opts:
 24             if opt in ("-h", "--help"):
 25                 usage();
 26                 sys.exit(1);
 27             elif opt in ("-t", "--test"):
 28                 print("for test option");
 29             else:
 30                 print("%s  ==> %s" %(opt, arg));
 31 
 32     except getopt.GetoptError:
 33         print("getopt error!");
 34         usage();
 35         sys.exit(1);
"2.py" [New] 35L, 945C written                                                                       
qixuan@ubuntu:~/qixuan02$ python 2.py -a -oaaa -caa --output=out file1 t file2 -d
============ opts ==================
[('-a', ''), ('-o', 'aaa'), ('-c', ''), ('-a', ''), ('-a', ''), ('--output', 'out')]
============ args ==================
['file1', 't', 'file2', '-d']
-a  ==> 
-o  ==> aaa
-c  ==> 
-a  ==> 
-a  ==> 
--output  ==> out
qixuan@ubuntu:~/qixuan02$

 

posted on 2018-04-29 12:11  myworldworld  阅读(205)  评论(0)    收藏  举报

导航