SuperAPI AI 工具集

python-style

编程与开发

查看项目

更新于 10-16 02:39

技能介绍

用途:在评审 anomalib 仓库中 src/anomalib/ 或 tests/ 下的 Python 代码时使用,检查代码风格、类型标注、导入导出、版权头与基本代码卫生。

主要能力与规则:以仓库 Python 基线为准,遵循 Ruff 配置的 120 字符行宽;建议风格改写前先匹配附近 anomalib 代码;偏好显式可读代码而非取巧写法。

需要提出修改的情形:公共 API 缺少类型标注;新代码引入弱类型(如不必要的 Any 或无类型的公共 **kwargs);导入或导出偏离邻近包模式;被改动的 Python 文件缺少预期的版权/SPDX 头;错误处理变得不显式或遗留调试代码。

类型标注:公共函数、方法和构造函数应有显式类型标注;优先使用仓库既有模式,如 X | None、type[...]、Sequence[...]、TypeVar、Generic;无充分理由不得弱化类型;标记不必要的 Any、宽泛无类型 **kwargs 或掩盖真实问题的类型抑制。

导入与导出:导入按标准库、第三方、本地分组;anomalib 内优先绝对导入;向 init.py 添加公共符号时确认 all 保持准确。

版权与许可头:Python 源文件应包含仓库通用的 Intel 版权与 SPDX 头。新文件仅用当前年份,例如:

Copyright (C) 2026 Intel Corporation

SPDX-License-Identifier: Apache-2.0

2026 年更新的既有文件,年份或年份范围应包含 2026,如将 2024 改为 2024-2026。

错误处理与代码卫生:捕获具体异常而非宽泛或静默失败;要求显式异常与信息性错误消息;标记调试打印、死代码、注释掉的代码以及应命名为常量或配置的魔法值;优先显式校验并抛出异常,而非脆弱假设。

评审锚点:pyproject.toml 定义 Ruff、pydocstyle、mypy、pytest 与 Commitizen 期望。检查清单:公共 API 类型、导入导出、被改动文件的版权/SPDX 头、明显的代码卫生回归。

限制:资料未提供安装命令、平台支持、收费或价格信息。