Python自动化测试项目的代码编写规范,个人给出几点实用建议:
以下都是从一些实际项目工程中,经过N次血和泪的教训后总结出的,欢迎大家指正和补充~
0. 文件名称写明模块方法,方法名称写清楚具体作用
举例:
login.py 可以写成 global_login.py 表示全局的登录,所有人可直接调用;
1. 按需引入:模块引入时考虑清楚具体会用到哪个类或者哪个方法,使用from xx import xx
,不到万不得已千万别用from xx import *
2. 建议每个独立可运行的脚本都在底部加入:if __name__ == '__main__':
即充当了测试用例,也可以当执行范例,其他人调用或修改时可大大节省时间
3. 日志不要泛滥,debug和info尽量区分开,debug是调试时使用,info是项目整体运行时使用
4. 尽量不要使用递归调用,例如self.abc(self), 违背了面向对象的原则
5. 一份代码“临时能用”和“当下够用”==将就, 建议多参考软件工程核心标准:高内聚(可多次复用的代码,能抽即抽,单独作为模块),低耦合(调用某个模块时不要影响其他正在使用该模块的人的代码,可参考函数式编程思想或者面向接口编程的思想)
6. 把运行者当小白,异常捕捉抛出时:建议提示“问题+解决方法” , 而自我检查日志: 建议提示“做了什么检查 + 确定性结果”,使得不熟悉的人可以以最小的时间代价去修改或优化代码
7. 编写模块和demo文档,让新人得以最快介入、让学习者快速理解运行逻辑、快速学会各模块基础调用规则,20%时间看,80%时间写, 而不是80%时间看, 20%时间写,【最好提供一个最佳实现的demo模板,如下:
import xxx
class DemoPreCheck:
def __init__():
self.check_networt()
self.check_mysql_connet_num()
def check_networt(self):
def check_mysql_connet_num(self):
class TestDemo:
def setup_class(self):
app.info("info:我是开始")
DemoPreCheck()
def teardown_class(self):
app.warn("info:我是结束")
def test_a():
assert 1==1
def test_b():
assert 1==2
if __name__ == '__main__':
#作者在这里写覆盖测试或调用示例代码,也可以代替单测