[Python] — Google met à jour son « Style Guide Python »

Google met (enfin…) à jour son style guide Python!

Pour celles et ceux qui lisent un peu ce site ou le livre que j’ai écrit sur Raspberry et Python, ils ont conscience que de l’importante d’avoir un code python cohérent et respectant quelques règles.
La recommandation PEP 8 qui regroupe un ensemble de consignes de formes permet d’avoir un code lisible par la plus grande partie des développeurs Python, qu’ils soient débutants ou experts.
Une autre de mes sources favorites quant aux bonnes pratiques à adopter est le google « Guide Style » qu’on trouvait anciennement ici : liens.

Les « guide style » de Google sont un regroupement d’instruction sur les bonnes pratiques à adopter selon le point de vue du géant de Mountain View pour la rédaction de code informatique. Il est à noter que les « guide style » ne sont pas seulement dédiés au langage Python, mais il en existe pour de nombreux langages, on peut par exemple citer C++, javascript…

Comme indiqué, quelques lignes plus hautes, les instructions et les exemples contenus dans les fiches permettent d’avoir une certaine cohérence lors de la création de code qu’on travaille en équipe ou seul. Pour vous illustrer ce qu’on y trouve, voici un exemple pour le nommage des différents éléments :


module_name,
package_name,
ClassName,
method_name,
ExceptionName,
function_name,
GLOBAL_CONSTANT_NAME,
global_var_name,
instance_var_name,
function_parameter_name,
local_var_name.

Function names, variable names, and filenames should be descriptive; eschew
abbreviation. In particular, do not use abbreviations that are ambiguous or
unfamiliar to readers outside your project, and do not abbreviate by deleting
letters within a word.

Always use a .py filename extension. Never use dashes.


C’est exactement le genre de convention que j’utilise lorsque je développe et lors d’une hésitation, je n’hésite pas à utiliser le Style Guide.

Bon bref… Ce billet n’est pas là pour vous convaincre du bienfait de ce genre de recommandations, mais plutôt pour vous informer que Google après de nombreuses années sans activité a mis à jour ces dépôts et que l’URL du « Style Guide Python » a changé. Vous pourrez donc le retrouver ici : liens vers le repo.

En ce qui concerne le contenu et l’organisation, la structure a l’air d’avoir changé un peu et l’on trouve de nouvelles recommandations liées aux évolutions des versions de Python 3. Vous pouvez donc avantageusement mettre à jour vos bookmark!!!