Dans vos projets de développement en Python, nous vous recommandons de respecter les conventions de codage décrites dans la PEP 8 et de documenter le code via les docstrings suivant la convention PEP 257, en utilisant le langage de balisage reStructuredText en vue d’une génération automatique de la documentation avec Sphinx.
Pour vous aider à vous assurer que votre code respecte bien la convention PEP 8, vous pouvez utiliser l’outil d’analyse statique de code pep8. Notez que de nombreux environnements intégrés de développement pour Python disposent d’une option pour analyser automatiquement la conformité du code à la PEP 8 au cours de l’édition. Prenez donc le réflexe d’activer cette fonctionnalité dans vos projets.
À noter : Un des aspects de la convention PEP 8 qui est parfois peu apprécié est la longueur maximale des lignes de code qui doit être de 79 caractères. Si cette limite ne vous convient pas, notez que vous pouvez malgré tout utiliser l’outil pep8 en spécifiant la longueur maximale de ligne souhaitée avec l’option --max-line-length.
Retrouvez de plus amples informations sur les bonnes pratiques de codage en Python dans cette présentation.