python-code-style

Aperçu

Qu'est-ce que python-code-style ?

python-code-style est une compétence conçue pour aider les développeurs et les équipes à appliquer un style de code Python cohérent, incluant le linting, le formatage, les conventions de nommage et les standards de documentation. En intégrant des outils Python modernes et les meilleures pratiques, cette compétence rend les bases de code plus maintenables et collaboratives.

À qui s'adresse cette compétence ?

Cette compétence est idéale pour les développeurs Python, les relecteurs de code et les équipes qui souhaitent :

• Mettre en place le linting et le formatage pour de nouveaux projets
• Vérifier la cohérence du style de code
• Configurer des outils comme ruff, mypy ou pyright
• Établir des standards de codage au sein de l'équipe
• Rédiger et maintenir des docstrings claires
• Créer et appliquer la documentation du projet

Problèmes résolus

python-code-style répond aux défis courants du développement Python :

• Réduit les débats manuels sur le formatage en automatisant l'application du style
• Garantit le respect des conventions de nommage PEP 8
• Maintient la documentation à jour avec le code
• Encourage l'utilisation des annotations de type pour les API publiques

Comment l'utiliser

Étapes d'installation

1. Installez la compétence avec :
   npx skills add https://github.com/wshobson/agents --skill python-code-style
2. Consultez le fichier SKILL.md pour un résumé rapide des pratiques recommandées et des outils.
3. Explorez les fichiers complémentaires tels que README.md, AGENTS.md et metadata.json pour plus de contexte.

Configuration des outils Python

• Installez les outils Python modernes :

  pip install ruff mypy
  

• Configurez votre projet dans pyproject.toml :

  [tool.ruff]
  line-length = 120
  target-version = "py312"
  
  [tool.mypy]
  strict = true
  

• Utilisez ruff comme linter et formateur principal. Il peut remplacer flake8, isort et black dans la plupart des flux de travail.

Adaptation à votre flux de travail

• Commencez par lire le fichier SKILL.md pour comprendre les concepts et les modèles clés.
• Ajustez les paramètres de configuration selon les besoins de votre projet et la version minimale de Python.
• Intégrez les annotations de type et maintenez les docstrings dans votre processus de revue de code.

FAQ

Que couvre python-code-style ?

python-code-style couvre le style de code Python, le linting, le formatage, les conventions de nommage et les standards de documentation. Il fournit des conseils et des recommandations d'outils pour maintenir un code Python de haute qualité.

Quels outils sont recommandés ?

La compétence recommande d'utiliser ruff pour le linting et le formatage, et mypy pour la vérification des types. Des exemples de configuration sont fournis dans SKILL.md.

Comment prévisualiser les recommandations de la compétence ?

Ouvrez l'onglet Fichiers et commencez par SKILL.md pour un résumé éditorial. Des références et scripts supplémentaires peuvent se trouver dans des dossiers imbriqués.

python-code-style convient-il à tous les projets Python ?

Cette compétence est particulièrement adaptée aux projets où la qualité, la cohérence et la maintenabilité du code sont prioritaires. Elle peut ne pas être nécessaire pour des prototypes rapides ou des scripts où l'application stricte du style est moins critique.