Tutoriel graphique sur la définition du style de code dans Pycharm

Cet article présente principalement en détail le style de codage de la deuxième partie du didacticiel d'apprentissage Pycharm le plus complet. Les amis intéressés peuvent se référer à

Comment créer un projet Python. il a le style de codage de Pycharm, comme suit

1. Thème

Cette partie du tutoriel présente principalement comment créer un projet Python et lui donner le style de codage de Pycharm. Vous verrez que Pycharm rend votre code source très concis et beau, avec une indentation, des espaces, etc. appropriés, donc Pycharm est également un outil de gestion de la qualité du code.

Cette partie du didacticiel ne présente pas comment utiliser Python pour la programmation Pour plus de connaissances sur la programmation Python, veuillez vous référer à : Programmation Python

2. , Préparation

Avant de commencer, veuillez confirmer la situation :

(1) Installer Logiciel Pycharm2.7 ou version supérieure

(2) Un nouveau projet Python (Fichier → Nouveau projet) a été créé. Pour plus de détails, veuillez vous référer à : Pycharm New Project File

(3) Deux répertoires ont été ajoutés sous le projet : src et test_dir (Fichier→Nouveau ou Alt+Insert), pour plus de détails, veuillez vous référer à : Fichier de nouveau projet Pycharm

(4) Le fichier Python correspondant a été ajouté au répertoire du projet (Fichier→Nouveau ou Alt +Insérer), pour plus de détails, veuillez vous référer à : : Nouveau fichier de projet Pycharm

3. Mode de surbrillance des erreurs de code

Ouvrir un nouveau fichier Python pour l'éditer (F4) . Il y a deux lignes dans ce fichier par défaut Code : Nom de l'auteur et nom du projet. La raison pour laquelle ces deux lignes de code apparaissent est que le fichier Python est créé sur la base du modèle de fichier lors de sa création, donc ces deux variables sont prédéfinies.

Ensuite, saisissez le mot-clé class Lorsque vous commencez à taper, le mécanisme d'invite d'orthographe de Pycharm répertoriera immédiatement les candidats pour vous aider à compléter le code :

Cette ligne ondulée rouge marque la position attendue de la prochaine entrée de code, qui dans ce cas est un délimiteur de saisie anticipée. Tapez le nom de la classe Solver et la ligne ondulée rouge se déplacera après le nom de la classe. Si vous passez le pointeur de la souris sur la ligne ondulée, vous verrez le

message d'erreur ("Côlon attendu"). Bien sûr, le signe rouge sur la barre de défilement droite donnera également le même message d'erreur. .

OK, entrez deux points et appuyez sur Entrée. Selon les normes de style de codage Python, la prochaine déclaration de classe doit être définie, et bien sûr, nous pouvons l'annuler en entrant un espace à ce moment-là.

4. Focus sur l'inspection du style de code PEP8

Cependant, ces rappels d'avertissement sont invisibles par défaut, la première chose à faire est donc de les améliorer

Priorité pour l'affichage. Cliquez sur le bouton Définir, puis sur la page Inspections de la boîte de dialogue DéfinirParamètres/Préférences, tapez PEP8 pour trouver toutes les options associées dans la liste déroulante correspondante. menu :

Cliquez sur Appliquer pour fermer la boîte de dialogue et revenir à l'interface d'édition du code source.

5. Explication détaillée du style de code PEP8

Désormais, Ptcharm peut afficher sa

spécification de code

normalement pour garantir l'intégrité du format de code que vous écrivez. . Ensuite, lorsque nous entrons l'instruction suivante (telle que def demo(self,a,b,c):), Pycharm signalera les problèmes de format actuels selon le mécanisme de spécification du code PEP8.

Comme vous pouvez le voir, Pycharm définit la spécification PEP8 qu'il prend en charge comme norme de format de code Python formel par défaut. Si vous ouvrez la liste des inspections (Ctrl+Alt+S→Inspections), vous pouvez voir que Pycharm a chargé l'outil pep8.py dans votre code pour identifier vos problèmes de style de code.

6. Inspection du code et paramètres associés

D'ailleurs, si vous observez attentivement les paramètres par défaut du profil d'inspection dans la page Inspections (si vous le configurez pour la première fois), vous constaterez que Pycharm a appliqué toutes les règles de code au projet en cours.

Ensuite, nous apportons deux modifications au mécanisme d'inspection du code :

(1) Dans le script de test, marquez les fautes d'orthographe en vert

(2) Dans la description Dans le document (Commentaire), remplacez la faute d'orthographe par une invite rouge

Ensuite, nous présenterons un par un

Créer une portée <.>

Nous devons d’abord créer deux scopes pour configurer deux scopes d’application différents. Cliquez sur le bouton Paramètres pour accéder à la boîte de dialogue Paramètres/Préférences, ouvrez la page Étendues, cliquez sur le signe plus vert ci-dessus pour créer une étendue de type local :

Dans Ajouter une nouvelle étendue Dans la boîte de dialogue, saisissez le nom de la portée, puis sélectionnez le répertoire qui doit être inclus dans la portée actuelle dans le gestionnaire de projet (arborescence) : test_dir. Notez que la barre de modèles à ce moment a automatiquement affiché le chemin de chargement :

Répétez les étapes ci-dessus pour créer une nouvelle portée de production.

8. Créez un fichier de contrôle d'inspection de code dans la nouvelle portée

Ensuite, créez une copie du fichier de contrôle de code par défaut (dans

Sécurité considérations) :

Ensuite, nommez-le, par exemple, nous le nommons ici MyProjectProfile. Ce nouveau

fichier de configuration est une copie du fichier de configuration par défaut précédent, et les paramètres des deux sont exactement les mêmes.

Ensuite, sélectionnez le fichier de contrôle de code que nous avons copié, localisez l'élément Orthographe et apportez les modifications correspondantes. Pour trouver rapidement la feuille d'options Orthographe, tapez simplement Spel dans la barre

Recherche.

Ajoutez ensuite la portée de test que nous avons créée précédemment en cliquant sur le signe plus vert, puis cliquez à nouveau pour ajouter la portée de production :

Dans Test Dans le Dans la portée de production, le niveau strict d'inspection du code est affiché sur le côté gauche de la figure. Il existe des paramètres similaires dans la portée de production, mais le niveau de sécurité dans la liste déroulante

sélectionnée est différent :

Faites attention à la couleur de police du nom de la portée dans la boîte de dialogue. Si elle est grise, cela signifie qu'aucune modification n'a été apportée. Si elle est bleue, cela signifie que le. les paramètres pertinents ont été modifiés.

Appliquez les modifications et fermez la boîte de dialogue.

À ce stade, le fichier de configuration modifié comme requis a été complété, nommé MyProjectProfile, qui a des paramètres de vérification orthographique différents dans la portée Test et la portée Production. Ensuite, nous appliquons cette configuration à la zone de code correspondante, sélectionnons Code → Inspecter le code dans le menu principal du programme et spécifions la portée définie et le fichier de configuration dans la boîte de dialogue :

Bien sûr, nous devons le faire deux fois, car il existe deux domaines de définition qui nécessitent des modifications de configuration associées, et la liste de configuration associée peut être exportée.

Comparez les résultats de la vérification orthographique de ces deux scopes :

Comme vous pouvez le constater, il y a des lignes ondulées rouges dans le scope Production et dans le scope Test Les domaines sont des lignes ondulées vertes.

9. Affichage du code en surbrillance des invites d'erreur

De plus, Pycharm mettra également en évidence certaines erreurs actuelles en fonction du contrôle du fichier de configuration.

Par exemple, si votre fichier de configuration de vérification orthographique contient la règle de vérification "Références non résolues" et que vous utilisez un symbole qui n'a pas été importé, Pycharm soulignera les symboles inexpliqués pour vous inviter à importer les modules associés :

Référez-vous au tutoriel d'importation automatique pour terminer l'importation des modules associés

10 Prototypage rapide et plus de conseils.

Avez-vous déjà remarqué qu'il y a une ampoule jaune ou rouge qui s'allume à l'extrémité gauche du code mais vous ne vous attendez pas à la voir ?

11. Génération automatique de code source

Pycharm fournit de nombreux mécanismes de génération automatique de code Vous pouvez vous référer à l'introduction de la génération automatique de code dans la documentation du produit : Auto. -génération de code. Ensuite, explorons le principal mécanisme de génération de code de Pycharm. Bien sûr, nous devons d'abord supprimer le contenu existant dans Solver.py et recommencer.

Tout d'abord, créez une instance de classe :

OK, Pycharm a réussi à créer une classe :

Ensuite, nous ajoutons une méthode membre à la classe. Pour y parvenir, nous devons d'abord entrer un point après l'instance de classe, puis taper le nom de la fonction membre . Pour le moment, cette fonction membre n'est pas définie, donc Pycharm nous demandera d'en créer une :

Ensuite, saisissez manuellement le code source dans le corps de la fonction, par exemple, nous saisissons une section pour calculer le quadratique Le programme pour l'équation discriminante, dans lequel il y a une fonction sqrt() du module mathématique, mais elle n'est pas encore incluse, nous continuons à entrer et voir comment Pycharm résout ce problème :

Par conséquent, notre code source final est le suivant :

Cependant, le code manque d'une analyse logique importante. Nous devons analyser le résultat discriminant d. S'il s'agit de zéro ou d'un nombre positif, résolvez la racine de l'équation normalement ; s'il s'agit d'un nombre négatif, nous devons lever une exception. Comment Pycharm nous aidera-t-il à accomplir cette tâche ?

Utilisons une instruction if pour inclure un bloc de code, c'est-à-dire, sélectionnons l'instruction qui doit être exécutée lorsque d est un nombre non négatif :

Appuyez ensuite sur Ctrl+Alt +T, ou cliquez sur l'option Code→Surround With dans le menu principal, Pycharm fera apparaître un menu déroulant affichant les structures de contrôle de plage disponibles dans la situation actuelle :

Sélectionnez l'option if, Pycharm ajoutera automatiquement l'instruction if True: à la ligne sélectionnée :

Ici, nous n'expliquons pas trop sur le Booléen expression Selon Il faut remplacer directement True par d >= 0, puis positionner le curseur sur la dernière ligne, appuyer sur Entrée, le curseur apparaîtra sur la ligne suivante, garder la même indentation que if, entrez else: , puis observez l'invite de saisie anticipée donnée par Pycharm :

Appuyez à nouveau sur Entrée et déplacez le curseur. Ici, nous entrons. lance une exception code :

12. Modification du format du code

En regardant. le fichier Solver.py à nouveau, vous constaterez que dans la rainure de défilement à droite, de nombreuses marques jaunes sont affichées. Passez la souris dessus et Pycharm affichera les problèmes de format de code correspondants :

.

Heureusement, ces messages sont des messages d'avertissement et n'affecteront pas les résultats d'exécution du code, mais il y a trop de problèmes de format. Alors, comment ajuster le format du code pour qu'il soit plus beau et standardisé ?

Ce qui est utilisé ici, c'est du code re

pourle passe-partout, autant l'essayer.

Pour appeler l'opération de formatage, appuyez simplement sur la touche de raccourci Ctrl+Alt+L, ou cliquez sur Code→Reformater le code dans le menu principal. À ce moment-là, nous avons été surpris de constater que tous les problèmes de formatage PEP8. ont été éliminés.

Bien sûr, nous pouvons personnaliser la norme de formatage, ouvrir la boîte de dialogue des paramètres de style de code, sélectionner le langage spécifié (Python) et apporter les modifications nécessaires :

13. Ajouter un document d'annotation

Une fois le format du code ajusté, il y a encore des drapeaux jaunes sur le côté gauche. souris Un message d'avertissement similaire à "Document manquantstring" s'affiche. La petite ampoule jaune devant le code affiche également le même message :

La solution est également très simple. Sélectionnez Insérer une docstring

dans le menu déroulant contextuel, et Pycharm ajoutera automatiquement un texte formaté en tant que document d'annotation :

Faites attention ici. Il existe plusieurs formats pour les documents de commentaires. Vous pouvez définir le format de document de commentaires que vous devez actuellement insérer sur la page des outils intégrés Python, tels que Epytext, texte brut, etc.

14. Saisir des commentaires

Commentaires Le document est utilisé pour expliquer les paramètres

, la valeur de retour, le type de variable et la signification de la fonction . Par exemple, si nous devons contrôler le type de paramètre d'entrée de demo(), nous devons ajouter les informations de commentaire correspondantes dans le document de commentaire :

À ce stade, le document de commentaire de la fonction principale Finish.

Ensuite, lors de l'appel de fonction, s'il y a une incompatibilité de type de paramètre, Pycharm donnera un message d'erreur de réponse basé sur le document d'annotation :

【 Recommandations connexes】

1.

Tutoriel vidéo gratuit Python

2

Vidéo d'explication complète de la grammaire de base Python de Marco Education

3. .

Manuel d'apprentissage Python

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!