Maison
mcore-linting-and-formatting
NVIDIA/skills
Lintez et formatez le code Python de Megatron-LM en utilisant ruff, black, isort, pylint et mypy, avec des commandes pour le formatage automatique et l’ordre des imports.
...Développer toutLintage et formatage
Exécution du formateur
Exécuter avant d'ouvrir une PR :
# Mode de vérification (aucune modification appliquée)
BASE_REF=main CHECK_ONLY=true SKIP_DOCS=false bash tools/autoformat.sh
# Mode de correction
BASE_REF=main CHECK_ONLY=false bash tools/autoformat.sh
Outils invoqués : black, isort, pylint, ruff, mypy.
Ordre des importations
Après avoir modifié les importations dans n'importe quel fichier Python, exécutez toujours uv run isort sur ces fichiers avant de valider :
uv run isort <file1>.py <file2>.py
</file2></file1>Configuration du groupe de lintage
À l'intérieur du conteneur :
uv sync --locked --only-group linting
Cela installe ruff, black, isort, pylint — les mêmes outils utilisés par tools/autoformat.sh et le job linting du CI.
Règles de style de code
- Annotations de type : obligatoires sur toutes les fonctions d'API publique. Utilisez
X | None, pasOptional[X]. - Docstrings : style Google sur toutes les classes et fonctions publiques.
- Nommage : suivez les conventions Python —
snake_casepour les fonctions et variables,PascalCasepour les classes. - Longueur de ligne : 119 caractères (configuré dans
pyproject.toml). - Pas de
exceptnu : capturez toujours des types d'exceptions spécifiques.
---
name: mcore-linting-and-formatting
description: Lint and format Python code for Megatron-LM using ruff, black, isort, pylint, and mypy, with commands for autoformatting and import ordering.
license: Apache-2.0
---
# Linting and Formatting
---
## Running the Formatter
Run before opening a PR:
```bash
# 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
```
Tools invoked: `black`, `isort`, `pylint`, `ruff`, `mypy`.
---
## Import Ordering
After editing imports in any Python files, always run `uv run isort` on those
files before committing:
```bash
uv run isort <file1>.py <file2>.py
```
---
## Setting Up the Linting Group
Inside the container:
```bash
uv sync --locked --only-group linting
```
This installs `ruff`, `black`, `isort`, `pylint` — the same tools used by
`tools/autoformat.sh` and CI's `linting` job.
---
## Code Style Rules
- **Type hints**: required on all public API functions. Use `X | None`, not `Optional[X]`.
- **Docstrings**: Google-style on all public classes and functions.
- **Naming**: follow Python conventions — `snake_case` for functions and variables, `PascalCase` for classes.
- **Line length**: 119 characters (configured in `pyproject.toml`).
- **No bare `except`**: always catch specific exception types.
Installer mcore-linting-and-formatting
Téléchargez et extrayez les fichiers de compétences dans votre répertoire .claude/skills/.
Télécharger le ZIPClonez le dépôt et copiez les fichiers de compétence dans votre projet.
git clone https://github.com/NVIDIA/skills/tree/main/skills/mcore-linting-and-formatting # Copy SKILL.md to your .claude/skills/ directory
Copier
