用途:为 Megatron-LM 项目提供代码检查(linting)与格式化(formatting)流程,帮助在提交 PR 前统一代码风格。
主要能力:覆盖运行 tools/autoformat.sh 脚本,以及 ruff、black、isort、pylint、mypy 等工具的使用,并说明代码风格规则。
使用方式: 提交 PR 前运行格式化脚本。检查模式(不修改文件): BASE_REF=main CHECK_ONLY=true SKIP_DOCS=false bash tools/autoformat.sh 修复模式: BASE_REF=main CHECK_ONLY=false bash tools/autoformat.sh 脚本会调用 black、isort、pylint、ruff、mypy。
修改任意 Python 文件的 import 后,提交前需对这些文件运行 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:始终捕获具体异常类型。
适用场景:Megatron-LM 仓库的日常开发、提交 PR 前的本地检查与 CI 一致性维护。
限制:资料未提供其他平台支持、收费或价格信息。