De nombreux développeurs ou étudiants écrivent du code, beaucoup de code, mais parfois ils oublient de suivre quelques bonnes pratiques qui peuvent rendre le code écrit plus efficace et lisible. Il y a quelques bonnes pratiques à suivre lors de la programmation. Ce n'est pas seulement pour les développeurs Python, il est applicable pour tous les langages de programmation comme C ++, Java, C #, etc. Ensuite, dans cet article, nous examinerons certaines de ces pratiques négligées mais intéressantes et importantes à garder à l'esprit lors de la programmation.
La source: Google images
Regardez l'image ci-dessus. je sais c'est assez marrant. Mais le point que je veux faire ici est que Python est si cool. Les programmeurs Python peuvent accomplir une tâche sans effort, tandis que d'autres doivent transpirer beaucoup de la même tâche. Donc, pour les développeurs python, il est important de suivre certaines pratiques qui rendront votre travail encore plus productif.
Alors commençons.
1. Documentation et commentaires adéquats
C'est le premier et le plus important point que je veux faire pour être un bon développeur Python. Il est très important de suivre cette. Tout code que vous écrivez doit être bien documenté et commenté par vous chaque fois que nécessaire. Mais, Savez-vous pourquoi nous avons besoin de la documentation du code? La réponse est très simple. Un projet d'entreprise peut durer des années et des années. De nouveaux développeurs rejoignent le projet à tout moment, alors maintenant ils doivent savoir et comprendre ce qu'il y a dans le code, à cette fin, la documentation du code est importante. Ils peuvent simplement s’y référer et comprendront clairement le code. Pensez simplement à ce développeur s’il n’y avait pas de documentation et que vous venez de la jeter dans le pool de code.. C’est vraiment difficile pour lui sans ça.. Les commentaires servent également le même but, vous devez ajouter des commentaires dans votre code si nécessaire.
La source: Google images
Il existe principalement trois types de commentaires:
ongle. Commentaire d’une ligne: Ils commencent par le symbole du hashtag (#) et durer jusqu’à la fin de la ligne.
Exemple:
#This is a comment
#Printing Hello World!
imprimer("Bonjour le monde!")
B. Commentaire multiligne: Il s’agit d’un texte enfermé dans un délimiteur. (""")
à chaque extrémité du commentaire. Il ne doit pas y avoir d’espaces vides entre le délimiteur (""")
. Utilisé lorsque le texte du commentaire est long de plus d’une ligne.
Exemple:
""" Ceci est un commentaire de plusieurs lignes, s’étendant sur trois lignes. Voici comment c’est fait. """ imprimer("Somme de deux nombres:", 45+23)
C. Commentaires de Docstring: C’est une fonctionnalité intégrée de
Piton. Utilisé pour associer la documentation qui a été écrite avec des modules, les fonctions, Classes et méthodes Python. Utilisé seul
sous les fonctions, modules, des classes pour dire ce qu’ils font. Le commentaire de chaîne de document est disponible à l’aide de l’attribut __doc__.
Exemple:
def ajouter(une, b):
return a+b
print(add.__doc__)
Production:
Ajouter les deux chiffres a et b
Donc, utilisez l’un de ces commentaires et aidez les autres développeurs à savoir ce que vous avez fait.
2. Évitez de créer des variables globales
Les variables globales sont celles qui restent dans l’application jusqu’au dernier souffle, c'est-à-dire, jusqu'à ce que l'application s'exécute, existent dans l'espace de code et peuvent être invoqués à tout moment de n'importe où. Ils sont parfois utiles en raison de leur accessibilité, mais en même temps, cela s'avère être un désastre pour les développeurs. En raison de ces variables, la mémoire ne peut pas non plus être utilisée efficacement, car une grande partie de votre mémoire ira en permanence à ces variables globales.
Il y a un autre problème avec eux. Étant donné que chaque fonction de votre application peut accéder aux variables globales, il est très difficile d'identifier quelle fonction lit ou écrit la valeur de ces variables globales. À présent, pour identifier ce, vous devez examiner de plus près toutes les fonctions individuellement, qui est un mal de tête.
Donc, éviter ces variables globales.
3. Gestion des exceptions
La source: Google images
Il s'agit d'une pratique très importante à suivre pour les développeurs., pas seulement les développeurs python, mais aussi tous les développeurs de chacun des langages. Ensuite, laissez-moi vous dire les raisons pour lesquelles il est nécessaire. Supposons que vous ayez écrit un programme pour ouvrir un fichier texte et y effectuer certaines opérations, comment lire le fichier, Ferme le, trouver la longueur du fichier. Ce serait un code simple à écrire, mais que faire si des erreurs comme celles-ci se sont produites lors de l'exécution?
- Que faire si le fichier ne peut pas être ouvert?
- Que faire si la longueur du fichier ne peut pas être déterminée?
- Que faire si la lecture échoue?
- Que faire si le dossier ne peut pas être fermé?
Que faire si le programme renvoie ces erreurs? Votre code s'arrêtera et votre application ne fonctionnera pas. Ensuite, ce sont des erreurs potentielles qui peuvent se produire pour n'importe quelle raison. Donc, il est important de gérer ces exceptions plutôt que de les ignorer. Donc, il est impératif d'utiliser la gestion des exceptions dans votre code.
Exemple:
essayer: imprimer(Oui) sauf: imprimer("Une exception s'est produite dans votre code!")
Les try
le bloc lèvera une exception, parce que y
il n'est pas défini.
4. Créer des environnements séparés
Les programmeurs Python essaient souvent de travailler dans un seul environnement, ils ne créent pas un environnement séparé pour différents projets. Ce n'est pas strictement une bonne pratique de mettre en œuvre tous les projets dans un seul environnement car vous pouvez rencontrer des problèmes dans les dernières étapes du développement, alors vous devez changer certaines installations, modifier leurs versions, installer nouveau. Cela peut affecter les projets précédents qui pourraient ne pas accepter ces nouveaux changements car ils dépendaient de ces dépendances. Donc, préfèrent toujours utiliser un nouvel environnement.
La source: Google images
Installation de VirtualEnv
$ pip installer virtualenv
Testez votre installation:
$ virtualenv --version
Utilisation de virtualenv
$ virtualenv mon_nom
À présent, une fois que vous avez créé votre environnement virtuel, faut l'activer. Ensuite, pour cela utilisez cette commande:
$ source virtualenv_name/bin/activate
Lorsque votre travail est terminé dans cet environnement, fermez-le avec cette commande:
(virtualenv_name)$ désactiver
5. Utiliser les fonctionnalités intégrées
Utilisez les fonctions intégrées de Python au lieu de les écrire à partir de zéro, car ils sont déjà compilés, optimisé pour une exécution efficace et si vous les écrivez à partir de zéro, un grand avantage est perdu.
6. Structuration du projet
La structuration du projet est également une partie très importante du développement car elle montre l'efficacité avec laquelle vous allez écrire votre code., comment l'ensemble du projet s'articule. Ensuite, si votre projet a un front-end, back-end, parte de base de donnéesUne base de données est un ensemble organisé d’informations qui vous permet de stocker, Gérez et récupérez efficacement les données. Utilisé dans diverses applications, Des systèmes d’entreprise aux plateformes en ligne, Les bases de données peuvent être relationnelles ou non relationnelles. Une bonne conception est essentielle pour optimiser les performances et garantir l’intégrité de l’information, facilitant ainsi la prise de décision éclairée dans différents contextes...., API et d'autres choses et si vous n'avez pas géré tout cela, alors ce sera un projet très compliqué. Supposons plus tard que vous souhaitiez apporter des modifications à votre code, mais il ne pourra pas le faire, car il n'y a pas de structure dans votre code et maintenant c'est un vrai problème de trouver ce qui est et où.
La source: Google images
Ensuite, pour structurer votre projet il existe un outil intéressant appelé emporte-pièce. Vous aide à créer la structure complète du projet, alors essaie d'utiliser ceci. C'est un outil utilitaire en ligne de commande qui crée des projets à partir de emporte-pièce (projet
modèles). Par exemple, créer un projet de package Python à partir d'un projet de package Python
modèle.
Lien GitHub: https://github.com/cookiecutter/cookiecutter
Documentation: https://cookiecutter.readthedocs.io
7. Avis (2)
J'espère que vous lisez cette citation:
Seul nous pouvons faire si peu; ensemble nous pouvons faire beaucoup.
Ceci est également applicable dans le monde de la programmation. Essayez de donner des avis sur le code des autres et soyez également ouvert aux opinions des autres. C'est un bon moyen d'apprendre et de grandir, la vitesse d'apprentissage augmente comme par magie. Ensuite, essaie de faire ça.
La source: Google images
Remarques finales:
Ce sont de très bonnes pratiques que chaque étudiant ou développeur devrait suivre. Ils ne manqueront pas de vous aider dans votre carrière de programmeur. J'espère que les conseils de cet article vous seront utiles. Connectons-nous Linkedin.
Merci d'avoir lu si vous êtes arrivé ici :).
Les médias présentés dans cet article ne sont pas la propriété de DataPeaker et sont utilisés à la discrétion de l'auteur.