Python中getopt()函数的使用

Posted 2020-11-16 曾鸿发

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

取得命令行参数
　　在使用之前，首先要取得命令行参数。使用sys模块可以得到命令行参数。
import sys
print sys.argv

　　然后在命令行下敲入任意的参数，如：
python get.py -o t --help cmd file1 file2

　　结果为：
[‘get.py‘, ‘-o‘, ‘t‘, ‘--help‘, ‘cmd‘, ‘file1‘, ‘file2‘]

　　可见，所有命令行参数以空格为分隔符，都保存在了sys.argv列表中。其中第1个为脚本的文件名。

选项的写法要求
　　对于短格式，"-"号后面要紧跟一个选项字母。如果还有此选项的附加参数，可以用空格分开，也可以不分开。长度任意，可以用引号。如以下是正确的：
-o
-oa
-obbbb
-o bbbb
-o "a b"
　　对于长格式，"--"号后面要跟一个单词。如果还有些选项的附加参数，后面要紧跟"="，再加上参数。"="号前后不能有空格。如以下是正确的：

--help=file1

　　而这些是不正确的：
-- help=file1
--help =file1
--help = file1
--help= file1

如何用getopt进行分析
　　使用getopt模块分析命令行参数大体上分为三个步骤：

1.导入getopt, sys模块
2.分析命令行参数
3.处理结果

例如模块test1.py:
import getopt, sys

opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])#"ho:"也可以写成‘-h-o:‘
print（opts）

print(args)

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为不属于格式信息的剩余的命令行参数,即不是按照getopt(）里面定义的长或短选项字符和附加参数以外的信息。opts是一个两元组的列表。每个元素为：(选项串,附加参数)。如果没有附加参数则为空串‘‘。
6. 整个过程使用异常来包含，这样当分析出错时，就可以打印出使用信息来通知用户如何使用这个程序。

用上面解释的一个命令行例子运行：

python test1.py ‘-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

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

转自：http://blog.csdn.net/q_l_s/article/details/52921675

这里再附一个解释的较好的文章链接：http://www.jianshu.com/p/a877e5b46b2d

可以用如下的代码运行一下，输入不同命令行参数测试一下,文件test2.py：

 1 import getopt
 2 import sys
 3 
 4 opts,args = getopt.getopt(sys.argv[1:],‘-h-f:-v‘,[‘help‘,‘filename=‘,‘version‘])
 5 print(opts)
 6 for opt_name,opt_value in opts:
 7     if opt_name in (‘-h‘,‘--help‘):
 8         print("[*] Help info")
 9         sys.exit()
10     if opt_name in (‘-v‘,‘--version‘):
11         print("[*] Version is 0.01 ")
12         sys.exit()
13     if opt_name in (‘-f‘,‘--filename‘):
14         fileName = opt_value
15         print("[*] Filename is ",fileName)
16         # do something
17         sys.exit()

我在Spyder里面的ipython控制台输入：

%run sys_test2.py -f test
输出：[(‘-f‘, ‘test‘)]
[*] Filename is test

自己试试其他输入，看看功能。