在编写python脚本时,难免遇到需要通过命令行的方式传递参数。使用的方法跟其它可执行程序的方法是一样的。
python test.py arg1 arg2 arg3
大致的使用方式如上面所示。
那么python脚本是如何解析这些参数的呢?
命令行参数有两种,第一种就是带opt这种方式,如-h
;另外就是直接使用参数值,如python test.py arg1
。
下面就两种不同的应用场景来进行说明。
不带option的方式
在这种场景下直接使用sys.argv来获取命令行参数。
- sys.argv为命令行参数列表。
- len(sys.argv)为参数个数。
# -*- coding: UTF-8 -*-
import sys
print '参数个数为:', len(sys.argv), '个参数。'
print '参数列表:', str(sys.argv)
这种应用场景,一般来讲,使用者是知道对应的第几个参数代表是什么意思的,也就是脚本对于使用者来讲是白盒的。
带option的方式
这种方式是针对用户为黑盒模式,即,如果不告知用户使用方式是无法正常运行的。这里就涉及到了命令行选项,需要通过getopt模块来处理。
getopt模块
getopt模块是专门处理命令行参数的模块,用于获取命令行选项和参数,也就是sys.argv。命令行选项使得程序的参数更加灵活。支持短选项模式(-)和长选项模式(--)。
该模块使用getopt.getopt方法来解析命令行参数列表,原型如下:
getopt.getopt(args, options[, long_options])
该方法的参数说明:
-
args: 要解析的命令行参数列表。
-
options : 以字符串的格式定义,options 后的冒号
:
表示如果设置该选项,必须有附加的参数,否则就不附加参数。 -
long_options : 以列表的格式定义,long_options 后的等号
=
表示该选项必须有附加的参数,不带冒号表示该选项不附加参数。 -
该方法返回值由两个元素组成: 第一个是 (option, value) 元组的列表。 第二个是参数列表,包含那些没有 - 或 -- 的参数。
异常处理
在没有找到参数列表,或选项需要的参数为空时将会触发异常getopt.GetoptError
。异常的参数是一个字符串,表示错误的原因,属性msg和opt为相关选项的错误信息。
示例
usage: test.py -i <inputfile> -o <outputfile>
代码实现
# -*- coding: UTF-8 -*-
import sys, getopt
def main(argv):
inputfile = ''
outputfile = ''
try:
opts, args = getopt.getopt(argv,"hi:o:",["in=","out="])
except getopt.GetoptError:
print 'test.py -i <inputfile> -o <outputfile>'
sys.exit(2)
for opt, arg in opts:
if opt == '-h':
print 'test.py -i <inputfile> -o <outputfile>'
sys.exit()
elif opt in ("-i", "--in"):
inputfile = arg
elif opt in ("-o", "--out"):
outputfile = arg
print '输入的文件为:', inputfile
print '输出的文件为:', outputfile
if __name__ == "__main__":
main(sys.argv[1:])