python中 getopt 模块,该模块是专门用来处理命令行参数的。目前有短选项和长选项两种格式:
- 短选项格式为"-"加上单个字母选项;
- 长选项为"--"加上一个单词。长格式是在Linux下引入的。
许多Linux程序都支持这两种格式。在Python中提供了getopt模块很好的实现了对这两种用法的支持,而且使用简单。
H3取得命令行参数
在使用之前,首先要取得命令行参数。使用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个为脚本的文件名。
H3函数getopt(args, shortopts, longopts = [])
参数args一般是sys.argv[1:],shortopts 短格式 (-), longopts 长格式(--)
选项的写法要求
-
短格式:"-"号后面要紧跟一个选项字母。如果还有此选项的附加参数,可以用空格分开,也可以不分开。长度任意,可以用引号。如以下是正确的: -obbbb -o bbbb -o "a b"
-
长格式:"--"号后面要跟一个单词。如果还有些选项的附加参数,后面要紧跟"=",再加上参数。"="号前后不能有空格。如以下是正确的: --help=file1
如何用getopt进行分析
使用getopt模块分析命令行参数大体上分为三个步骤: 1.导入getopt, sys模块 2.分析命令行参数 3.处理结果
说明:
import getopt, sys
opts, args = getopt.getopt(sys.argv[1:], "ho:", ["help", "output="])#"ho:"也可以写成'-h-o:'
print(opts)
print(args)
- 处理所使用的函数叫getopt(),因为是直接使用import导入的getopt模块,所以要加上限定getopt才可以。
- 使用sys.argv[1:]过滤掉第一个参数(它是执行脚本的名字,不应算作参数的一部分)。
- 使用短格式分析串"ho:"。当一个选项只是表示开关状态时,即后面不带附加参数时,在分析串中写入选项字符。当选项后面是带一个附加参数时,在分析串中写入选项字符同时后面加一个":"号。所以"ho:"就表示"h"是一个开关选项;"o:"则表示后面应该带一个参数。
- 使用长格式分析串列表:["help", "output="]。长格式串也可以有开关状态,即后面不跟"="号。如果跟一个等号则表示后面还应有一个参数。这个长格式表示"help"是一个开关选项;"output="则表示后面应该带一个参数。
- 调用getopt函数。函数返回两个列表:opts和args。opts为分析出的格式信息。args为不属于格式信息的剩余的命令行参数,即不是按照getopt()里面定义的长或短选项字符和附加参数以外的信息。opts是一个两元组的列表。每个元素为:(选项串,附加参数)。如果没有附加参数则为空串''。
- 整个过程使用异常来包含,这样当分析出错时,就可以打印出使用信息来通知用户如何使用这个程序。
范例:
命令行中输入:
# python test.py -i 127.0.0.1 -p 80 55 66
# python test.py --ip=127.0.0.1 --port=80 55 66
下面的代码:
#!/usr/bin/python
import getopt
import sys
def usage():
print ' -h help \n' \
' -i ip address\n' \
' -p port number\n' \
''
if __name__ == '__main__':
try:
options, args = getopt.getopt(sys.argv[1:], "-h-p-v-i:", ['help', "ip=", "port="])
for name, value in options:
if name in ('-h', '--help'):
usage()
elif name in ('-v','--version'):
print("[*] Version is 0.0.1 ")
sys.exit()
elif name in ('-i', '--ip'):
print value
elif name in ('-p', '--port'):
print value
except getopt.GetoptError:
usage()
options,args = getopt.getopt(sys.argv[1:],"hp:i:",["help","ip=","port="])
“hp:i:”短格式 h 后面没有冒号:表示后面不带参数,p:和 i:后面有冒号表示后面需要参数
["help","ip=","port="]长格式 help后面没有等号=,表示后面不带参数,其他三个有=,表示后面需要参数
返回值 options 是个包含元祖的列表,每个元祖是分析出来的格式信息,比如 [('-i','127.0.0.1'),('-p','80')] ;
args 是个列表,包含那些没有‘-’或‘--’的参数,比如:['55','66']
注意:定义命令行参数时,要先定义带'-'选项的参数,再定义没有‘-’的参数