Un chercheur d'une société pharmaceutique a résumé les normes de codage Python

introduction

Cette section décrit les conventions de codage Python.

Conventions de codage définies dans PEP8

Python a une norme de codage appelée PEP8. Le contour spécifié dans PEP8 est présenté ci-dessous.

déclaration d'importation

Dans l'instruction import, n'utilisez pas ʻimport os, sys`, etc., mais divisez-le en plusieurs lignes comme indiqué ci-dessous. Insérez également une ligne vide pour faire la distinction entre les bibliothèques standard, les bibliothèques tierces, les modules locaux, etc.

import os
import sys

from django.utils import timezone

from my_app.models import User

Espace blanc dans la phrase

a = 1
b = a + 2
list_nums = [a, b]
dict_nums = {'a': a, 'b': b}

Insérez un espace demi-largeur avant et après =, et mettez un espace demi-largeur après , dans les listes et les dictionnaires. Aussi, mettez un espace demi-largeur après le : dans le dictionnaire.

Retrait

Lorsque vous définissez une instruction ʻif, une instruction for, une fonction ou une classe, commencez à écrire la ligne après le :` avec quatre espaces demi-largeur (et leurs multiples) en retrait.

if True:
    print("It's true.")

Ligne blanche

Laissez deux lignes avant la fonction de niveau supérieur ou les définitions de classe. Laissez une ligne pour les méthodes dans la classe.

def my_func():
    return 'my_func'


class MyClass():
    name = my_class

    def print_name(self):
        return self.name

Nombre de caractères par ligne

Le nombre de caractères sur une ligne est en gros de 79 caractères ou moins. Pour docstring, utilisez 72 caractères ou moins.

Vérifier avec Flake8

Il existe flake8 comme outil pour vérifier si le code source est conforme à PEP8. Il peut être exécuté avec la commande suivante.

$nom de fichier flake8.py

Lorsqu'il est exécuté, il vous montrera quelles parties du code source ne respectent pas les conventions de codage.

Résumé

Ici, j'ai expliqué le standard de codage de Python. Python est un langage lisible, il est donc essentiel pour écrire du code facile à lire pour les autres.