|
类别 |
规范条目 |
示例/说明 |
执行等级(★) |
|
命名规范 |
1. 模块/包名全小写+下划线 |
data_processor.py |
★★★★ |
|
|
2. 类名使用大驼峰式 |
class DatabaseConnector: |
★★★★ |
|
|
3. 受保护成员加单下划线前缀 |
_internal_cache = {} |
★★★ |
|
格式规范 |
1. 必须通过black格式化 |
提交前执行black --line-length 88 . |
★★★★ |
|
|
2. import分组(标准库→第三方→本地) |
每组间隔1空行 |
★★★ |
|
|
3. 类型注解覆盖率≥90% |
def connect(url: str) -> Connection: |
★★★ |
|
文档规范 |
1. 模块级docstring使用Google风格 |
包含Args/Raises/Returns |
★★★★ |
|
|
2. 重大修改需添加.. versionchanged:: |
用于标记不兼容变更 |
★★ |
|
安全规范 |
1. 禁用eval()/exec() |
必须使用时需经过安全评审 |
★★★★ |
|
|
2. SQL操作必须参数化 |
cursor.execute("SELECT * FROM users WHERE id=?", (user_id,)) |
★★★★ |
浙公网安备 33010602011771号