Maison  >  Article  >  développement back-end  >  Spécifications du code Python

Spécifications du code Python

高洛峰
高洛峰original
2017-03-12 10:25:301568parcourir

1 : L'arrière-plan

est utilisé pour standardiser le développement ocp python et utiliser un style unifié pour les programmes développés en utilisant python afin de faciliter codage Maintenance de

2 : python spécification de style

  • points Symbole : N'ajoutez pas de point-virgule à la fin de la ligne, et n'utilisez pas de point-virgule pour mettre deux commandes sur la même ligne

  • Parenthèses : Utilisez les parenthèses avec parcimonie plutôt qu'avec excès. À moins d'être utilisé pour implémenter la concaténation de lignes, n'utilisez pas de parenthèses dans les instructions return ou les instructions conditionnelles, mais les parenthèses autour des tuples sont autorisées

  • Indentation : utilisez 4 espaces au lieu d'indenter le code. N’utilisez jamais de tabulations et ne mélangez jamais de tabulations et d’espaces. Pour la concaténation de lignes, vous devez soit aligner verticalement les éléments enveloppés, soit utiliser un retrait suspendu de 4 espaces (auquel cas la première ligne ne doit avoir aucun paramètre)

  • ligne vide :Deux lignes vides entre les définitions de niveau supérieur, telles que les fonctions ou les définitions de classe. Il doit y avoir une ligne vide entre la définition de méthode, la définition de classe et la première méthode. Dans les fonctions ou les méthodes, si vous pensez que cela est approprié à certains endroits, laissez une ligne vide

  • Espace : utilisez des espaces de part et d'autre de la ponctuation selon les conventions de formatage standard. Il ne doit y avoir aucun espace entre parenthèses ; n'ajoutez pas d'espaces avant les virgules, les points-virgules et les deux-points, mais ils doivent être ajoutés après eux (sauf à la fin de la ligne, il ne doit pas y avoir d'espaces dans les listes de paramètres, ) ; index, ou parenthèses ouvrantes de tranches ; Ajouter un espace des deux côtés de l'opérateur binaire , tel que affectation (=), comparaison (==, <, >, !=, < ;>, <=, > =, dans, pas dans, est, n'est pas), booléen (et, ou, non). Quant à la manière d’utiliser les espaces des deux côtés des opérateurs arithmétiques, vous devez faire votre propre jugement. Cependant, les deux côtés doivent être cohérents ; lorsque '=' est utilisé pour indiquer des paramètres de mot-clé ou des valeurs de paramètres par défaut, n'utilisez pas d'espaces des deux côtés ; n'utilisez pas d'espaces pour aligner verticalement les marques entre plusieurs lignes, car cela deviendra un problème de maintenance Fardeau (applicable à :, #, =, etc.)

  • classe : Si une classe n' hérite de autres classes , il sera affiché à partir de la classe d'objet hérite de

  • chaîne  : Même si les paramètres sont tous des chaînes, utilisez l'opérateur % ou le format pour formater les caractères String , n'utilisez pas la méthode d'import

  •  : chaque import a sa propre ligne. Les importations doivent toujours être placées en haut du fichier, après le module commentaires et les docstrings, et avant le module global variables et constantes . Les importations doivent être classées du Groupe le plus courant au moins commun : importation de bibliothèque standard ; importation de bibliothèque tierce applicationimportation spécifiée par le programme. chaque module. Les chemins des packages sont triés lexicographiquement, en ignorant les instructions

  •  : généralement, chaque instruction doit être sur sa propre ligne. Si les résultats des tests et les instructions de test tiennent sur une seule ligne, vous pouvez les placer sur la même ligne. Dans le cas d'une instruction if, cela ne peut être fait que s'il n'y a pas de else. En particulier, ne faites jamais cela avec try/sauf car try et except ne peuvent pas être sur la même ligne.

  • Nom : ob_module_name ob_package_name ObClassName TestObClassName nom_méthode test_method_name ExceptionNom nom_fonction GLOBAL_VAR_NAME instance_var_name function_parameter_name local_var_name

  • D'autres points seront ajoutés ultérieurement

Trois : Exigences :

  • Une fois le code modifié, vous devez d'abord exécuter pylint puis lancer une révision. Le score pylint doit être contrôlé au-dessus de 90. Certaines irrégularités évidentes doivent être corrigées

  • Utilisation de pylint : Exécutez tools/pylint.sh dans le répertoire obztools

    fichier

Quatre : Référence :

  • PEP 8 – Guide de style pour Code Python : http://legacy.python.org/dev/peps/pep-0008/

  • Guide de style de codage Python Traduction chinoise (Google SOC) : http://www.elias.cn/Python/PythonStyleGuide?from= Développer .PythonStyleGuide

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!

Déclaration:
Le contenu de cet article est volontairement contribué par les internautes et les droits d'auteur appartiennent à l'auteur original. Ce site n'assume aucune responsabilité légale correspondante. Si vous trouvez un contenu suspecté de plagiat ou de contrefaçon, veuillez contacter admin@php.cn