mcore-linting-and-formatting

Linting 和格式化

---

运行格式化工具

打开 PR 前运行：

# Check mode (no changes applied)
BASE_REF=main CHECK_ONLY=true SKIP_DOCS=false bash tools/autoformat.sh

# Fix mode
BASE_REF=main CHECK_ONLY=false bash tools/autoformat.sh

调用的工具：black、isort、pylint、ruff、mypy。

---

导入排序

编辑任何 Python 文件中的导入语句后，提交前务必对这些文件运行 uv run isort：

uv run isort <file1>.py <file2>.py

---

设置 Linting 工具组

在容器中：

uv sync --locked --only-group linting

这会安装 ruff、black、isort、pylint——与 tools/autoformat.sh 和 CI 的 linting 任务所用工具相同。

---

代码风格规则

• 类型提示：所有公共 API 函数都必须添加类型提示。使用 X | None，不要使用 Optional[X]。
• 文档字符串：所有公共类和函数都必须使用 Google 风格的文档字符串。
• 命名：遵循 Python 约定——函数和变量使用 snake_case，类使用 PascalCase。
• 行长度：119 个字符（在 pyproject.toml 中配置）。
• 不要使用裸 except：始终捕获特定的异常类型。