6 Meilleures pratiques Python pour un meilleur code

Meilleures pratiques Python 

1. Meilleures pratiques Python pour la qualité du code

La rédaction d'un code lisible et organisé peut faire la différence et améliorer vos perspectives de carrière. Si le codage peut sembler un processus mécanique et complexe pour les débutants, la vérité est que le codage est un art. 

Il existe de nombreuses astuces que vous pouvez suivre pour améliorer la qualité du code en Python. Voici une liste de quelques-unes des plus pertinentes.

La tyrannie de l'indentation

L'indentation désigne les espaces au début d'une ligne de code. Alors que l'indentation dans d'autres langages de programmation n'est qu'une ressource pour la lisibilité, l'indentation en Python est obligatoire. Python utilise l'indentation pour ouvrir un bloc de code. Plus précisément, 4 espaces consécutifs par niveau d'indentation, comme le montre le code suivant :

for number in [1,2,3,4]:
    if number % 2 == 0:
        print(number)
    else:
        continue

Longueur maximale de la ligne

Le PEP 8 recommande qu'aucune ligne ne dépasse 79 caractères. C'est logique, car les lignes plus courtes sont plus faciles à lire. De plus, cette longueur vous permet d'avoir plusieurs fichiers ouverts les uns à côté des autres.

Lignes vierges

Entourez les définitions de fonctions et de classes de premier niveau de deux lignes vierges. Les définitions de méthodes à l'intérieur d'une classe sont entourées d'une seule ligne vide. Des lignes vierges supplémentaires peuvent être utilisées (avec parcimonie) pour séparer des groupes de fonctions apparentées. Enfin, utilisez des lignes blanches dans les fonctions (avec parcimonie) pour indiquer les sections logiques. 

Utiliser des linters et des autoformateurs

La maîtrise du code prend du temps. Faire attention à tous les détails lors du codage peut s'avérer difficile et prendre du temps. Heureusement, les machines, en particulier les linters et les formateurs, peuvent nous aider à garantir la qualité du code. 

Les linters effectuent une analyse statique des codes sources et vérifient les divergences sémantiques. Les formateurs sont des outils similaires qui tentent de restructurer l'espacement de votre code, la longueur des lignes, le positionnement des arguments, etc. afin de garantir la cohérence de votre code dans différents fichiers ou projets. Python vous offre une pléthore de linters et de formateurs parmi lesquels choisir.

Gardez à l'esprit les principes

Si certaines des règles susmentionnées sont simples, le codage est souvent une question de bon goût et d'intuition. Pour devenir un artiste du codage, vous devez connaître certains des principes qui sous-tendent Python. Un excellent exemple de ces principes est le Zen of Python, abordé dans un article distinct.  

2. Meilleures pratiques de journalisation en Python

Le cursus est un moyen de suivre les événements qui se produisent lors de l'exécution d'un logiciel. En particulier lorsque les applications gagnent en taille et en complexité, la journalisation devient une technique essentielle pour le développement, le débogage, l'exécution et le cursus.  

Le module dejournalisation fait partie de la bibliothèque standard de Python depuis la version 2.3 pour traiter les pratiques de journalisation. Il s'agit du premier paquetage de référence pour la plupart des développeurs Python en ce qui concerne la journalisation et est décrit en détail dans la PEP 282.

L'enregistrement est similaire à une fonction d'impression. Cependant, une fonction d'impression manque de nombreuses informations qui pourraient être utiles à un développeur. La journalisation, en revanche, permet d'enregistrer l'heure et le numéro de ligne auxquels l'erreur s'est produite. Il peut également enregistrer les erreurs ou toute autre information dans des fichiers, des sockets, etc.

Pour importer le module, il vous suffit d'exécuter ce code :

import logging

Tous les messages ne se ressemblent pas. En effet, le module fournit une catégorie de niveaux de journalisation en fonction de la gravité du message. Elle se présente comme suit :

• NOTSET (0): Cela signifie que tous les messages seront enregistrés.
• Debug (10): Utile pour diagnostiquer les problèmes dans le code. 
• Info (20): Il peut être utilisé pour reconnaître qu'il n'y a pas de bogues dans le code. Un bon cas d'utilisation de la journalisation au niveau des informations est le cursus de la progression de l'entraînement d'un modèle d'apprentissage automatique. 
• Avertissement (30): Indique un problème qui pourrait survenir à l'avenir. Par exemple, un avertissement peut être émis pour un module qui risque d'être supprimé à l'avenir ou un avertissement pour un faible nombre de béliers. 
• Erreur (40): Un bogue sérieux dans le code ; il peut s'agir d'une erreur de syntaxe, d'une erreur de mémoire insuffisante ou d'exceptions. 
• Critique (50): Une erreur à cause de laquelle le programme peut s'arrêter de fonctionner ou se terminer brusquement.

import logging
logging.info('This message is just informative')
logging.debug('My missions is to provide information about debugging.')
logging.critical("A Critical Logging Message")

Cela dit, vous trouverez ci-dessous une liste de six bonnes pratiques pour gérer la journalisation en Python.  

Utilisez des journaux au lieu d'impressions

Nous avons dit précédemment que les journaux fournissent des informations dans la même veine que les fonctions d'impression. Cependant, les journaux sont beaucoup plus puissants et peuvent fournir des informations plus granulaires. 

Il peut être tentant d'utiliser la fonction d'impression, surtout si vous n'êtes pas familiarisé avec les routines d'enregistrement, mais l'enregistrement est toujours l'option la plus sûre. Ils sont mieux adaptés à la mise à l'échelle et à la gestion d'applications complexes. 

Le web regorge de guides et de documentation. Par exemple, ce tutoriel sur la journalisation de DataCamp est peut-être ce qu'il vous faut pour commencer.

Utilisez le module de journalisation 

Ce module est l'option de choix pour la plupart des développeurs Python. Cela signifie que le module est bien entretenu et soutenu par une vaste communauté qui aura toujours une réponse à vos doutes.

Choisissez judicieusement le niveau de journalisation

Le module de journalisation propose six niveaux de messages différents. Chacun d'entre eux est conçu dans un but précis. Plus vous les respectez, plus il vous sera facile, à vous et aux utilisateurs, de comprendre ce qui se passe dans votre code.

Utiliser les horodatages lors de l'enregistrement

Il s'agit d'une caractéristique essentielle des journaux que les fonctions d'impression ne possèdent pas. En plus de savoir où un problème est apparu, il est important de savoir quand il s'est produit. Les horodatages sont vos meilleurs alliés dans ces situations. Veillez à utiliser le format standard pour écrire les horodatages, c'est-à-dire le format ISO-8601.

Vider la corbeille à papier

Utilisez les classes RotatingFileHandler, telles que TimedRotatingFileHandler, au lieu de FileHandler, pour archiver, compresser ou supprimer les anciens fichiers journaux afin d'éviter les problèmes d'espace mémoire. Ces classes nettoient l'espace une fois qu'une limite de taille ou une condition de temps est déclenchée.

3. Meilleures pratiques en matière de commentaires en Python

Les commentaires sont très importants pour faire des annotations à l'intention des futurs lecteurs de notre code. Bien qu'il soit difficile de définir comment le code doit être commenté, il existe certaines lignes directrices que nous pouvons suivre : 

• Tout commentaire qui contredit le code est pire que l'absence de commentaire. C'est pourquoi il est très important de mettre à jour le code et les commentaires pour éviter de créer des incohérences. 
• Les commentaires doivent être des phrases complètes, avec la première lettre en majuscule. 
• Essayez de rédiger vos commentaires en anglais. Bien que chacun soit libre de rédiger ses commentaires dans la langue qu'il juge appropriée, il est recommandé de le faire en anglais. 
• Veillez à ce que vos commentaires soient clairs et facilement compréhensibles pour les autres locuteurs de la langue dans laquelle vous écrivez.

Il existe deux types de commentaires : les commentaires en bloc et les commentaires en ligne. 

Un commentaire de bloc explique le code qui le suit. En règle générale, vous indentez un commentaire de bloc au même niveau que le bloc de code. Chaque ligne d'un commentaire de bloc commence par un # et un espace, comme suit :

# This is a block comment
print('Welcome to DataCamp!")

En revanche, les commentaires en ligne apparaissent au même niveau que le code. Les commentaires en ligne doivent être séparés de l'énoncé par au moins deux espaces. Comme un commentaire en bloc, un commentaire en ligne commence par un signe dièse (#) et est suivi d'un espace et d'une chaîne de texte. 

print ("Have you ever tried Python?") # This is an inline comment

4. Meilleures pratiques en matière de chaînes de documentation Python

Une chaîne de documentation est une chaîne littérale qui apparaît comme première déclaration dans la définition d'un module, d'une fonction, d'une classe ou d'une méthode. En général, vous utilisez une chaîne de documentation pour générer automatiquement la documentation du code. Ainsi, il est possible d'accéder à une chaîne de documents au moment de l'exécution en utilisant l'attribut spécial obj.__doc__ de cet objet.

Pour des raisons de cohérence, les chaînes de documents sont toujours placées entre trois guillemets doubles (""").

Il existe deux formes de docstrings : les docstrings d'une ligne et les docstrings de plusieurs lignes. Les jeux de mots sont réservés aux cas les plus évidents. Ils devraient vraiment tenir sur une seule ligne. L'exemple suivant illustre une chaîne de documents d'une ligne dans la fonction multiply():

def multiply(x, y):
    """ Return the product of two numbers """
    result = x * y
    return result

En revanche, une chaîne de documentation multi-lignes peut s'étendre sur plusieurs lignes. Une telle docstring doit documenter la fonction du script, la syntaxe de la ligne de commande, les variables d'environnement et les fichiers. Les messages d'utilisation peuvent être relativement élaborés et devraient être suffisants pour permettre à un nouvel utilisateur d'utiliser la commande correctement.

def calculate_salary(hours, price=20):
    """ Return the salary according to the hours worked

    Arguments:
    hours: total hours investe
    price: price of each hours worked. Minimum price is 20 dollars
    """
    salary = hours * price
    return salary

Vous trouverez une explication plus détaillée des chaînes de documents dans la PEP257.

5. Meilleures pratiques en matière de documentation Python

Alors que les commentaires sont importants pour permettre aux autres développeurs avec lesquels vous travaillez de comprendre votre code, la documentation est destinée à aider une communauté d'utilisateurs potentiels à apprendre à utiliser votre logiciel. Il s'agit d'une étape cruciale : quelle que soit la qualité de votre logiciel, si la documentation n'est pas suffisante, ou pire, si elle est absente, les utilisateurs ne l'utiliseront pas. 

Inclure un fichier README est toujours une bonne pratique, surtout si vous travaillez sur un nouveau projet. Ces fichiers constituent normalement le principal point d'entrée pour les lecteurs de votre code et contiennent des informations générales destinées aux utilisateurs et aux responsables du projet. 

Bien que concis, le fichier README doit expliquer l'objectif du projet, l'URL de la source principale du logiciel et les informations de crédit.

De même, vous devez toujours inclure un fichier setup.py, garantissant que le logiciel ou la bibliothèque a été empaqueté et distribué avec Distulils, la norme de distribution des modules Python.

En outre, si votre logiciel nécessite d'autres dépendances ou paquets pour fonctionner, vous devez inclure un fichier requirements.txt qui décrit les dépendances nécessaires et leurs versions.

Enfin, vous pouvez ajouter toute autre information que vous jugez pertinente pour les utilisateurs potentiels. Par exemple, c'est une bonne pratique que de fournir des exemples de fonctionnement de votre paquet ou de vos fonctions. 

6. Meilleures pratiques en matière d'environnement virtuel Python 

Pour assurer l'ordre et la cohérence de vos projets de données, la création d'un environnement virtuel pour chaque projet que vous démarrez est une bonne pratique. 

Les environnements virtuels, également appelés virtualenvs, permettent de découpler et d'isoler les versions de Python et des bibliothèques nécessaires à votre projet, ainsi que les versions de pip qui leur sont associées. Cela autorise les utilisateurs finaux à installer et à gérer leur propre ensemble de logiciels et de versions, indépendamment de ceux fournis par le système. 

Pour créer virtualenvs, nous devons d'abord installer le paquetage requis, en écrivant la ligne de code suivante dans votre terminal :

pip install virtualenv

Pour créer un nouveau virtualenv, le code suivant fera la magie. Nous appelons le nouveau serveur virtuel "new_venv"

python3 -m venv /path/to/new/virtual/environment/new_venv

Conventions d'appellation Python

L'une des erreurs les plus courantes chez les développeurs Python débutants consiste à mal nommer les variables, les classes, les fonctions, etc. Les conventions d'appellation sont des éléments essentiels pour assurer la lisibilité du code.

La PEP 8 explique la manière standard de nommer les objets en Python. Selon les lignes directrices, les nouveaux modules et paquets (y compris les frameworks tiers) doivent être écrits selon ces normes, mais la cohérence interne est privilégiée lorsqu'une bibliothèque existante a un style différent.

Vous devez éviter d'utiliser des noms trop généraux ou trop mondains. En outre, les identificateurs utilisés dans la bibliothèque standard doivent être compatibles ASCII, comme décrit dans le PEP 3131.

# Bad naming:
data_structure, ríos_españa, dictionary_with_countries_and_capitals
# Good naming:
user_profile, stop_words, global_emissions_df

Vous trouverez ci-dessous une liste des conventions de dénomination des objets les plus courants en Python.

• Paquets et modules
• Les noms des paquets et des modules doivent être en minuscules
• Les traits d'union ne peuvent être utilisés dans le nom du paquet et du module que s'ils améliorent la lisibilité.
• Classes
• Les noms de classe doivent respecter la convention Majuscule-Camel-Case.
• Les classes intégrées de Python, cependant, sont typiquement des mots en minuscules
• Variables d'instance, méthodes et fonctions
• Les noms des variables d'instance doivent être en minuscules
• Utilisez le trait de soulignement pour ajouter de nouveaux mots à des instances de variables.
• Les variables d'instance non publiques doivent commencer par un seul trait de soulignement.
• Constantes
• Les noms des constantes doivent être entièrement en majuscules
• Utilisez le trait de soulignement pour ajouter de nouveaux mots aux constantes

Conclusion

La maîtrise des meilleures pratiques de Python est essentielle pour écrire un code propre, efficace et facile à maintenir. En respectant les lignes directrices relatives à la qualité du code, à la journalisation, aux commentaires et à la documentation, et en utilisant des outils tels que les environnements virtuels, vous pouvez vous assurer que vos projets sont plus faciles à gérer, à collaborer et à mettre à l'échelle.

Alors que vous continuez à améliorer vos compétences en Python, envisagez d'explorer des ressources d'apprentissage plus approfondies pour approfondir votre compréhension de Python et de son large éventail d'applications. Si vous êtes à la recherche de conseils structurés, consultez ces ressources :

• Comment apprendre Python : Un guide pour devenir un expert - Ce guide d'expert vous aidera à naviguer dans le processus d'apprentissage, en vous proposant des conseils et des techniques pour maîtriser Python.
• Introduction à Python pour les développeurs - Parfait pour les développeurs qui cherchent à s'initier à Python, ce cours couvre les concepts et les fonctionnalités de base du langage d'une manière pratique et concrète.
• Introduction à la science des données en Python - Une fois que vous êtes à l'aise avec Python, plongez dans la science des données avec ce cours adapté aux débutants. Il couvre les bibliothèques et techniques essentielles pour travailler avec des données en Python.