bkcodecc/pylint_scan repository overview

⁠工具介绍

PyLint是Python代码风格检查工具，可检查代码行的长度、变量命名是否符合编码规范或声明的接口是否被真正的实现等。

目前支持的规则已经在checkers.json中进行了声明。

⁠开发新规则步骤

1.从master拉规则分支，命名建议为：story_xxx_MMdd （xxx为规则名，MMdd表示月日）

2.将规则分支代码clone到本地

3.所有自定义规则都存放在third_rules/tencent.py，新建规则可参考tencent.py内部规则实例，建议在tencent.py中创建新class实现

4.在checker.json中添加新增规则的描述。在描述时需要说明该规则对应到哪一条规范，并附上链接。规则描述示例如下：

• 单测函数行数限制也是普通函数的2倍，即为160行。即单测函数的行数，包含代码行、注释行、空白行，不得超过160行，否则需要重新评估函数的功能是否过于复杂需进行分拆。 [tencent standards/go 2.6]

5.在test目录下添加规则测试代码文件

7.MR代码到test分支

8.执行流水线部署

9.测试完成提合并请求到master分支，由工具负责人审核评估后正式发布到生产