估计有很多小伙伴在linux系统上或win的doc中遇到没有UI页面的程序,只能通过命令行输入参数的形式去运行
那么python是怎么实现的呢?
熟悉python的小伙伴都知道python有个原生库 sys,顾名思义都是关于系统上的一些功能
sys的方法非常多,本篇文章不做过多个拓展,只讲其中一个方法。
sys.argv 该方法用于接受运行文件时附带的其他命令行信息,以空格作为分隔,return出list格式的字符串
D:\code\apiautotest>python run.py a s d e
['run.py', 'a', 's', 'd', 'e']
例子中在运行run.py时 在后面接了任意参数,最终打印了 运行文件和其他参数
到这里我们完成了命令行传参的关键一步,接受命令行的参数
这个时候我们凭借以上的信息通过对list的遍历也能获得相关的参数,但这样的话逻辑需要写的很多。
有没有一个库可以给我们直接分辨出哪些是我们要的参数呢?
这就是我们本篇文章要介绍的另一个库 getopt。这个库也是原生库 无需安装
这个库里面的方法非常简单,看似源码有几个函数,其实都是围绕主方法使用的
我们只要懂 getopt.getopt(args, shortopts, longopts = [])
即可
以下是这个方法的源码,doc中说的很清楚
def getopt(args, shortopts, longopts = []):
"""getopt(args, options[, long_options]) -> opts, args
Parses command line options and parameter list. args is the
argument list to be parsed, without the leading reference to the
running program. Typically, this means "sys.argv[1:]". shortopts
is the string of option letters that the script wants to
recognize, with options that require an argument followed by a
colon (i.e., the same format that Unix getopt() uses). If
specified, longopts is a list of strings with the names of the
long options which should be supported. The leading '--'
characters should not be included in the option name. Options
which require an argument should be followed by an equal sign
('=').
The return value consists of two elements: the first is a list of
(option, value) pairs; the second is the list of program arguments
left after the option list was stripped (this is a trailing slice
of the first argument). Each option-and-value pair returned has
the option as its first element, prefixed with a hyphen (e.g.,
'-x'), and the option argument as its second element, or an empty
string if the option has no argument. The options occur in the
list in the same order in which they were found, thus allowing
multiple occurrences. Long and short options may be mixed.
"""
opts = []
if type(longopts) == type(""):
longopts = [longopts]
else:
longopts = list(longopts)
while args and args[0].startswith('-') and args[0] != '-':
if args[0] == '--':
args = args[1:]
break
if args[0].startswith('--'):
opts, args = do_longs(opts, args[0][2:], longopts, args[1:])
else:
opts, args = do_shorts(opts, args[0][1:], shortopts, args[1:])
return opts, args
- 参数args:用来接受输入参数即将 sys.argv中去掉首个运行文件的列表传进去 == sys.argv[1:]
- 参数shortopts:短选项(单个字母)后面带冒号(:)时 使用该参数时必须附带参数,否则报错,使用时要在短选项前加 - (-a)此处为字符串
- 参数longopts:长选项(单词)后面带等号(=)时 使用该参数时必须附带参数,否则报错,使用时要在长选项前加 -- (--argv);此处时列表
return两个参数
- opts :包含元组的列表,此处只有函数设置好的选项名字及所带的参
[(opt1, value1), (opt2, value2)]
- args : 包含字符串的列表,此处为未在函数中设置好的选项,跟sys.argv一样以空格分隔
option, args = getopt.getopt(args, "e:p:d:h", ["help", "env=", "product=", "report_path="])
# 短选项有:e、p、d、h 其中使用e、p、d后面必须带有参数
# 长选项有:help、env、product、report_path 其中使用env、product、report_path后面必须带有参数
tips:报错时,报错类型为:getopt.GetoptError,只有要求带参选项没有带参才会报,如果压根就没有输入该选项是不会报错的(此时注意逻辑判断)
以下实例场景为多环境多产品线结合jenkins实现CI/CD以及allure报告输出
建议结合jenkins&allure&pytest 参数化构建一起观看效果更佳
下方实例有一个bug:如果运行文件时不传 env 及 product 这两个参数 整个程序都无法执行
不过实际情况无影响所以未做相关措施
- -e --env 环境 必须带参
- -p --product 产品线 必须带参
- -d --report_path allure报告路径(基于工程目录) 必须带参
- -h --help 帮助 无需带参
import sys
import getopt
import pytest
from common.constant import REPORT_DIR
from common.context import Context
def main(args):
path = REPORT_DIR + "/allure" # 默认报告存放地址
try: # 异常捕获,如果有选项未带参时给予使用提示
option, args = getopt.getopt(args, "e:p:d:h", ["help", "env=", "product=", "report_path"])
except getopt.GetoptError:
print("run.py \n-h <help> -e <env> -p <product> -d <report_path> \n")
sys.exit()
for key, value in option: # 遍历opt及value
if key in ("-h", "--help"):
print("run.py \n-h <help> -e <env> -p <product> -d <report_path>")
break
elif key in ("-e", "--env"):
setattr(Context, "env", value) # 此处跟本文无关
elif key in ("-p", "--product"):
setattr(Context, "product", value) # 此处跟本文无关
elif key in ("-d", "--report_path"):
path = value
else:
raise TypeError("args error")
pytest.main(["-v", "-m", "smoke", "--alluredir={}".format(path)])
if __name__ == '__main__':
argv = sys.argv[1:]
main(argv)