Conseils sur la conception d’un script Python

La bonne conception d’un script Python sera facilitée si vous respectez certains principes élémentaires. Découpez en fonctions chaque élément atomique de votre programme. Vous pourrez ainsi tester chaque partie indépendamment du reste. Écrivez les docstrings en même temps que votre code et mettez les deux à jour en simultané. Si l’algorithme à coder est complexe, commentez votre code de manière très détaillée pour expliquer ce que vous faites. Si vous avez besoin d’un nouveau type de donnée, créez tout simplement une classe. Utilisez des noms de variables explicites, cela fait partie de la documentation. La ( re) lecture de votre code doit être la plus aisée possible. Si vous construisez une structure de données complexe comme une liste de dictionnaires ( tableaux clefs- valeurs), documentez et illustrez l’organisation de cette structure de données sur un exemple simple et compréhensible par – presque – tous.