宁缺毋滥:只在确信是真缺陷时才提出问题,上下文不清晰时保持沉默——误报比漏报一个次要问题更损耗评审者的信任。将安全与正确性发现视为阻断项,风格或惯用法建议视为非阻断项。
明显的拼写错误
2 项死代码
4 项- 永远无法到达的代码块(例如条件恒为假的分支,
return、raise、break或continue之后的代码)内置来源与改动说明
- 已声明但从未被读取或引用的变量、导入或函数参数内置
来源与改动说明
- 大段被注释掉的代码,且没有明显的保留意图内置
来源与改动说明
- 不要报告
.pyistub 文件中未使用的导入、变量或参数;stub 声明的是它从不执行的接口,因此重新导出的导入、仅用于注解的声明和未被引用的参数名是预期现象而非死代码内置来源与改动说明
可变默认参数与共享状态
5 项- 可变默认参数,例如
def f(x=[])或def f(x={});默认值只创建一次并在所有调用间共享。应默认用None,并在函数体内构造该值内置来源与改动说明
- 本意是每实例一份的值,却意外成为跨实例共享的类级可变属性内置
来源与改动说明
- 模块级可变全局量(列表、字典、缓存)在多个请求或线程间被修改,以令调用方意外的方式保留状态内置
来源与改动说明
- 闭包按引用捕获循环变量,最终全部看到的是循环结束后的值内置
来源与改动说明
- 当函数从不修改该参数,或共享默认值是有意为之且有文档说明的缓存或哨兵值时,不要报告内置
来源与改动说明
边界与极端情况处理
8 项- 假定输入非空:索引
xs[0]、调用max()/min()或切片,却未先处理空的list、str、dict或迭代器内置来源与改动说明
- 索引、区间或切片上的差一(off-by-one)与越界访问,尤其是在首/末元素处内置
来源与改动说明
None到达假定有值的代码,而上游调用或默认值可能合法地返回None(报告前先用file_read确认数据来源)内置来源与改动说明
- 用
==比较浮点数是否精确相等;应使用math.isclose或显式容差,因为浮点结果并不精确内置来源与改动说明
- 整数/浮点与除法假设:
//造成意外截断,或除数可能为零时的ZeroDivisionError内置来源与改动说明
- 集合中出现代码假定类型统一但实际异构或意外的元素(例如
None、数字与字符串混用)内置来源与改动说明
- 按键访问字典却未处理键缺失的情形(
d[k]与d.get(k)),或假定键必然存在的 set/dict 操作内置来源与改动说明
- 调用方或类型契约已排除的极端情况,或在上游已验证边界下不可能出现的输入,不要报告内置
来源与改动说明
错误处理与异常
6 项- 裸
except:会吞掉一切,包括KeyboardInterrupt和SystemExit;至少应捕获except Exception,并优先捕获预期的具体异常类型内置来源与改动说明
except Exception仍比所处理的故障更宽泛;应收窄到受保护调用实际抛出的异常内置来源与改动说明
- 异常被捕获后悄悄丢弃(
pass),既不记录日志也不重新抛出内置来源与改动说明
- 重新抛出时丢失了原始回溯;应优先使用
raise NewError(...) from err以保留原因内置来源与改动说明
- 宽泛的
try块包裹了远超真正可能失败的那一行,掩盖了错误来源内置来源与改动说明
- 用
assert对外部输入做运行时校验——断言在python -O下会被剥离内置来源与改动说明
同一性与相等性比较
4 项- 用
is/is not与字符串、数字或元组等字面量比较;这依赖实现特定的驻留(interning)而非值相等——应使用==(真实的正确性风险)内置来源与改动说明
- 用
==与True/False比较,而真值但非True的值(例如1、非空容器)会不相等;应优先使用普通的真值判断内置来源与改动说明
is应保留用于与单例和哨兵值的同一性检查内置来源与改动说明
- 用
==/!=而非is/is not与None比较属于风格偏好;作为次要问题报告,不作为阻断项内置来源与改动说明
资源管理
5 项- 打开文件、套接字、锁或数据库连接却未使用
with语句,在提前返回或异常时有泄漏风险内置来源与改动说明
- 已有上下文管理器可用,却绕过它改用手动
open()/close()配对内置来源与改动说明
- 在
try中获取的资源,其finally清理在错误路径上缺失或不完整内置来源与改动说明
- 迭代器或生成器持有资源的时间超出必要内置
来源与改动说明
- 不要报告短生命周期脚本,或已由外层
with或框架管理生命周期的句柄(报告前先用file_read确认周边作用域)内置来源与改动说明
性能
5 项报告前先确认数据规模以及代码位于热路径上:
- 在循环中用
+=拼接字符串,而不是先累积到列表再"".join(...),或使用 f-string内置来源与改动说明
- 对
list反复做成员测试,而set或dict可将 O(n) 查找变为 O(1)内置来源与改动说明
- 构建完整列表,而使用生成器可避免把所有内容都保存在内存中内置
来源与改动说明
- 在循环内重复计算跨迭代不变的值(例如编译正则、热路径上的属性查找)内置
来源与改动说明
- 向
logging传入提前格式化的 f-string(例如logging.info(f"..."))而非logging.info("%s", value);前者使级别被禁用时的惰性格式化失效内置来源与改动说明
并发与异步
5 项只在有多线程、多进程或异步调用的证据时才报告并发问题(报告前先确认调用上下文):
- 在 GIL 下用
threading并行化 CPU 密集型工作,而multiprocessing或进程池才是正确工具(指传统 CPython;自由线程构建除外);线程真正有帮助的是 I/O 密集型工作内置来源与改动说明
- 共享状态上没有
Lock的先检查后执行(check-then-act)竞态,或把非原子的复合更新当作原子操作内置来源与改动说明
async def内的阻塞调用(同步 I/O、time.sleep、requests、CPU 密集工作)卡住事件循环;应使用对应的异步版本或在执行器中运行内置来源与改动说明
- 创建了
asyncio任务却从未 await,异常因此被吞掉,工作可能在完成前就被垃圾回收内置来源与改动说明
- 跨线程或任务共享可变状态,却没有同步机制或线程安全结构内置
来源与改动说明
不要报告局部变量(每个线程各有一份)、对共享数据的只读访问,或没有任何并发使用证据的代码。
安全敏感代码
7 项报告前先验证数据来源;确认输入确实由攻击者可控,而非可信常量:
- 对不可信输入使用
eval、exec或compile;这是任意代码执行内置来源与改动说明
- 用未经转义处理的输入构造
shell=True的subprocess;应传参数列表并避免使用 shell内置来源与改动说明
- 对不可信数据使用
pickle、marshal或yaml.load(未带SafeLoader);反序列化可能执行任意代码内置来源与改动说明
- 用字符串拼接或 f-string 构造 SQL,而不是参数化查询内置
来源与改动说明
- 密钥、令牌、密码或 PII 被写入日志或提交进源码内置
来源与改动说明
- 弱密码学或误用密码学(用
hashlib.md5/sha1处理密码、用random生成安全令牌);应使用secrets和经过审查的库内置来源与改动说明
- 不可信文件路径未经校验即拼接,造成路径遍历内置
来源与改动说明