写一写python code review的一些通用准则

1. PEP8、空行、缩进

在方法的 `return`、`break`、`continue`后是否有空行?
在不同语义块之间是否有空行?
循环之前和之后是否有空行?
方法和类定义下方是否有多余空行?

2. 命名

方法名、变量名 是否见名知意?
方法功能必须和方法名是否一致?

3. 长度

函数长度 是否小于`20`行,最长是否小于`50`行?
类的长度 是否小于`100`行,最长是否不超过`300`行?
文件长度 最长是否不超过`1000`行?
行的长度 单行长度是否小于`128`字符?

4. 注释

是否添加业务背景信息,执行频率,执行条件,维护者注意点?
是否移除所有注释代码行?
注释是否是准确的?

5. 函数

如有多个 `return` 的语句,概率高的是否先进行判定?
是否有可以被库函数替代的代码?
是否进行了输入输出参数校验,是否有异常处理?
调用处是否都使用了正确的参数个数?

6. 循环

循环是否设置了长度和正确的终止条件?

7. 日志

是否有可以删除的日志或调试代码?
日志是否必须要在循环内?

8. 默认值

变量初始值是否合理
函数参数默认值

9. 依赖&导入

在导入其他模块的时候是否注明导入的具体类?
不要用`from xx import * `的方式导入
是否存在依赖的三方包? 
版本是否有要求? 
安装是否有特殊注意的地方? 
是否加入`requestment.txt`?
代码是否创建了需要的数据库、工作表、字段、索引等?
是否存在初始化数据?
代码是否有前置后置脚本?

10. 结构

高内聚?松耦合?可扩展性?设计模式是否合理?

11. 性能

对数据结构的选择和设置是否合适?
是否采用通用的线程池、对象池模块等cache技术以提高性能?
是否选择合适的IO类或采用良好的方法以提高性能?
同步方法的使用是否得当,是否过度使用?

12. 安全

日志中是否打印了敏感信息?
所有的数据输入是否都进行了检查(检测正确的类型,长度,格式和范围)并且进行了编码?
在哪里使用了第三方工具,返回的错误是否被捕获?
返回的值是否进行了检查并且编码?
无效的参数值是否能够处理?

13. 功能

代码能够工作么?是否实现预期的功能,逻辑是否正确?

14. 其他

连接是否关闭、是否自动重连?
是否存在多余的或是重复的代码?
代码是否尽可能的模块化了?
是否有可以被替换的全局变量?
代码是否存在任何没有定义或没有引用到的变量、常量、或数据类型?
代码涉及到的常量是否易于修改(如使用配置、定义为类常量、使用专门的常量类等)
代码是否采取措施避免运行时的错误(如数组边界溢出、被零除、值越界、堆栈溢出等)
`DRY(Do not Repeat Yourself)`原则:同一代码不应该重复两次以上
`exception` 是否有太多的业务逻辑?
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 220,884评论 6 513
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,212评论 3 395
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,351评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,412评论 1 294
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,438评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,127评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,714评论 3 420
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,636评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,173评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,264评论 3 339
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,402评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,073评论 5 347
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,763评论 3 332
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,253评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,382评论 1 271
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,749评论 3 375
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,403评论 2 358