[Norme de codage Python] PEP 8 vs Google Style

introduction

La norme de codage la plus connue pour Python est la norme de code de bibliothèque standard PEP 8, mais [Google Python Style Guide](https: /) /google.github.io/styleguide/). J'ai donc essayé de résumer en quoi Google Style est différent de PEP 8. De la conclusion, c'était presque le même que PEP 8, donc j'ai omis les règles communes (en particulier les lignes vides et les blancs). Bien qu'il existe des différences, il se peut que certains points ne puissent pas être abordés, mais pardonnez-moi.

Remarque

――Les deux traductions japonaises sont disponibles, mais elles ne sont peut-être pas les plus récentes, j'ai donc fait référence autant que possible à la version anglaise. --PEP 8 est du domaine public, Google Style Guide est CC by 3.0

Tableau de comparaison

Comment écrire lors de la jonction de lignes entre parenthèses

#OK avec PEP8 ou Google
#Aligner pour ouvrir les crochets
 foo = long_function_name(var_one, var_two,
                          var_three, var_four)
 meal = (spam,
         beans)
#OK avec PEP8 ou Google
#retrait suspendu (4 espaces)
foo = long_function_name(
    var_one, var_two, var_three,
    var_four)
meal = (
    spam,
    beans)

#Autorisé pour PEP8, NG pour Google (2 espaces)
foo = long_function_name(
  var_one, var_two,
  var_three, var_four)

#Non mentionné dans PEP8, OK dans Google
foo = {
    long_dictionary_key: value1 +
                         value2,
    ...
}
foo = {
    long_dictionary_key:
        long_dictionary_value,
        ...
}

#Aucune mention dans PEP8, NG dans Google
foo = {
    long_dictionary_key:
    long_dictionary_value,
    ...
}

#OK pour PEP8, pas de mention pour Google?
def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)


#OK dans PEP8, non mentionné dans Google, peut-être NG
my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )

#Je pense que Google aime ce style d'écriture. PEP8 est également OK.
my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f')

--Break break avant opérateur binaire dans PEP8, non mentionné dans Google --PEP8 illustre la description lorsque la condition de l'instruction if devient longue, Google ne la mentionne pas --Google stipule la notation lors de l'utilisation d'annotations de fonction, PEP8 ne mentionne pas ――Personnellement, le retrait suspendu est moins gênant et je l'aime parce que je peux utiliser efficacement une ligne.

• Mais je pense qu'il est plus facile de voir les arguments de la fonction entre crochets ouverts ...

Autres éléments mentionnés uniquement dans le guide de style Google

• Laissez une ligne entre l'instruction de définition de la classe et la première méthode --ʻSi name == Utilisez '__ main __' `
• Considérez le fractionnement lorsque la fonction dépasse 40 lignes --Utilisez + pour concaténer deux chaînes. Utilisez %, str.format (), f-string,str.join ()pour concaténer plus que cela.
• Ne combinez pas map () et filter () --Nest quand l'instruction with fait exactement deux lignes, n'utilisez pas \ --Sheban n'a pas besoin d'être écrit, cela n'a pas de sens d'écrire dans un fichier qui n'est pas exécuté directement
• N'écrivez pas inutile (). Écrivons () pour spécifier le taple.
• N'utilisez pas deux ou plusieurs instructions for ou deux ou plusieurs instructions de contrôle dans la notation d'inclusion / expression du générateur.
• En principe, n'utilisez pas @ staticmethod et faites-en une fonction de niveau module. --Utilisez @ classmethod pour les méthodes utilisées comme constructeurs nommés ou pour les méthodes qui changent l'état global d'une classe
• N'utilisez pas mutable dans la définition des arguments par défaut
• Évitez les variables globales et utilisez des constantes --Comment écrire une annotation de type

Impressions

Google, écris la même chose que PEP 8 orz, il était difficile de tout lire. C'était bien que j'ai décidé comment écrire une docstring et une annotation de type en détail.