PyCharm pour un développement productif de Python (Guide)

Cet article utilisera PyCharm Community Edition 2019.1 car il est gratuit et disponible sur toutes les principales plateformes. Seule la section sur les fonctionnalités professionnelles utilisera PyCharm Professional Edition 2019.1.

La manière recommandée d’installer PyCharm est d’utiliser JetBrains Toolbox App. Avec son aide, vous pourrez installer différents produits JetBrains ou plusieurs versions du même produit, mettre à jour, restaurer et supprimer facilement tout outil si nécessaire. Vous pourrez également ouvrir rapidement n’importe quel projet dans le bon IDE et la bonne version.

Pour installer l’application Toolbox, reportez-vous à la documentation de JetBrains. Il vous donnera automatiquement les bonnes instructions en fonction de votre système d’exploitation. Dans le cas où il ne reconnaît pas correctement votre système d’exploitation, vous pouvez toujours le trouver dans la liste déroulante en haut à droite:

https://files.realpython.com/media/pycharm-jetbrains-os-list.231740335aaa.png [image: https://files.realpython.com/media/pycharm-jetbrains-os-list.231740335aaa.png [ Liste des OS sur le site Web de JetBrains, largeur = 1010, hauteur = 679]]

Après l’installation, lancez l’application et acceptez le contrat d’utilisation. Sous l’onglet Outils, vous verrez une liste des produits disponibles. Trouvez la communauté PyCharm là-bas et cliquez sur Installer:

https://files.realpython.com/media/pycharm-toolbox-installed-pycharm.cdcf1b52bc02.png [image: https://files.realpython.com/media/pycharm-toolbox-installed-pycharm.cdcf1b52bc02.png [ PyCharm installé avec l’application Toolbox, largeur = 337, hauteur = 537]]

Voilà! PyCharm est disponible sur votre machine. Si vous ne souhaitez pas utiliser l’application Toolbox, vous pouvez également effectuer une stand-alone installation de PyCharm.

Lancez PyCharm et vous verrez la fenêtre contextuelle des paramètres d’importation:

https://files.realpython.com/media/pycharm-import-settings-popup.4e360260c697.png [image: https://files.realpython.com/media/pycharm-import-settings-popup.4e360260c697.png [image Fenêtre contextuelle des paramètres d’importation PyCharm, largeur = 416, hauteur = 156]]

PyCharm détectera automatiquement qu’il s’agit d’une nouvelle installation et choisira Ne pas importer les paramètres pour vous. Cliquez sur OK et PyCharm vous demandera de sélectionner un schéma de clavier. Laissez la valeur par défaut et cliquez sur Suivant: Thèmes UI en bas à droite:

PyCharm vous demandera alors de choisir un thème sombre appelé Darcula ou un thème clair. Choisissez celui que vous préférez et cliquez sur Suivant: Script de lancement:

https://files.realpython.com/media/pycharm-set-ui-theme.c48aac8e3fe0.png [image: https://files.realpython.com/media/pycharm-set-ui-theme.c48aac8e3fe0.png [ Page de thème de l’interface utilisateur de PyCharm Set, largeur = 803, hauteur = 666]]

J’utiliserai le thème sombre Darcula tout au long de ce didacticiel. Vous pouvez trouver et installer d’autres thèmes sous forme de lien: # using-plugins-and-external-tools-in-pycharm [plugins], ou vous pouvez également les importer.

Sur la page suivante, laissez les valeurs par défaut et cliquez sur Suivant: Plugins recommandés. Là, PyCharm vous montrera une liste de plugins que vous voudrez peut-être installer car la plupart des utilisateurs aiment les utiliser. Cliquez sur Commencer à utiliser PyCharm, et maintenant vous êtes prêt à écrire du code!

Dans PyCharm, vous faites tout dans le contexte d’un projet . Ainsi, la première chose que vous devez faire est d’en créer un.

Après avoir installé et ouvert PyCharm, vous êtes sur l’écran d’accueil. Cliquez sur Créer un nouveau projet et vous verrez la fenêtre contextuelle New Project:

Spécifiez l’emplacement du projet et développez la liste déroulante Project Interpreter. Ici, vous avez la possibilité de créer un nouvel interpréteur de projet ou de réutiliser un interpréteur existant. Choisissez Nouveau environnement utilisant. Juste à côté, vous avez une liste déroulante pour sélectionner l’un de Virtualenv, Pipenv ou Conda, qui sont les outils qui aident à garder les dépendances requises par différents projets séparés en créant pour eux des environnements Python isolés.

Vous êtes libre de sélectionner ce que vous voulez, mais Virtualenv est utilisé pour ce tutoriel. Si vous le souhaitez, vous pouvez spécifier l’emplacement de l’environnement et choisir l’interpréteur de base dans la liste, qui est une liste d’interprètes Python (tels que Python2.7 et Python3.6) installés sur votre système. Habituellement, les valeurs par défaut sont correctes. Ensuite, vous devez sélectionner des cases pour hériter des packages de sites globaux dans votre nouvel environnement et les rendre disponibles pour tous les autres projets. Laissez-les désélectionnés.

Cliquez sur Créer en bas à droite et vous verrez le nouveau projet créé:

image:https://files.realpython.com/media/pycharm-project-created.99dffd1d4e9a.png}Project créé dans PyCharm]

Vous verrez également un petit Tip of the Day popup où PyCharm vous donne une astuce à apprendre à chaque démarrage. Allez-y et fermez cette fenêtre.

Il est maintenant temps de démarrer un nouveau programme Python. Tapez [.keys] # Cmd + N # si vous êtes sur Mac ou [.keys] # Alt + Ins # si vous êtes sur Windows ou Linux. Ensuite, choisissez Python File. Vous pouvez également sélectionner Fichier → Nouveau dans le menu. Nommez le nouveau fichier + guess_game.py + et cliquez sur OK. Vous verrez une fenêtre PyCharm similaire à la suivante:

Pour notre code de test, codons rapidement un jeu de devinettes simple dans lequel le programme choisit un nombre que l’utilisateur doit deviner. Pour chaque supposition, le programme indiquera si la supposition de l’utilisateur était plus petite ou plus grande que le nombre secret. Le jeu se termine lorsque l’utilisateur devine le numéro. Voici le code du jeu:

Tapez ce code directement plutôt que de copier et coller. Vous verrez quelque chose comme ceci:

Comme vous pouvez le voir, PyCharm fournit Intelligent Coding Assistance avec complétion de code, inspections de code, surlignage d’erreurs à la volée et suggestions de correction rapide. En particulier, notez comment lorsque vous avez tapé + main + puis appuyé sur tab, PyCharm a automatiquement complété la clause + main + pour vous.

Notez également comment, si vous oubliez de taper + if + avant la condition, ajoutez + .if +, puis appuyez sur [.keys] # Tab #, PyCharm corrige la clause + if + pour vous. La même chose est vraie avec `+ True. while + '. C’est PyCharm’s Postfix completeions qui travaille pour vous afin d’aider à réduire les sauts de curseur en arrière.

Maintenant que vous avez codé le jeu, il est temps pour vous de l’exécuter.

Vous avez trois manières d’exécuter ce programme:

Utilisez l’une des options ci-dessus pour exécuter le programme et le volet Exécuter l’outil apparaîtra en bas de la fenêtre, avec la sortie de votre code indiquant:

Jouez le jeu un peu pour voir si vous pouvez trouver le nombre deviné. Conseil de pro: commencez par 50.

Avez-vous trouvé le numéro? Si c’est le cas, vous avez peut-être vu quelque chose de bizarre après avoir trouvé le numéro. Au lieu d’imprimer le message de félicitations et de quitter, le programme semble recommencer. C’est un bug ici. Pour découvrir pourquoi le programme recommence, vous devez maintenant déboguer le programme.

Tout d’abord, placez un point d’arrêt en cliquant sur l’espace vide à gauche de la ligne numéro 8:

Ce sera le point où le programme sera suspendu, et vous pourrez commencer à explorer ce qui n’a pas fonctionné à partir de là. Ensuite, choisissez l’une des trois méthodes suivantes pour démarrer le débogage:

Ensuite, vous verrez une fenêtre Debug ouverte en bas:

image:https://files.realpython.com/media/pycharm-debugging-start.04246b743469.png}Début de débogage dans PyCharm]

Suivez les étapes ci-dessous pour déboguer le programme:

Toutes nos félicitations! Vous avez corrigé le bogue.

Aucune application n’est fiable sans tests unitaires. PyCharm vous aide à les écrire et à les exécuter très rapidement et confortablement. Par défaut, https://docs.python.org/3/library/unittest.html [+ unittest +] est utilisé comme lanceur de test, mais PyCharm prend également en charge d’autres cadres de test tels que http://www.pytest. org/en/latest/[+ pytest +], + nose +, https://docs.python.org/3/library/doctest. html [+ doctest +], https://www.jetbrains.com/help/pycharm/tox-support.html [+ tox +] et https://twistedmatrix.com/trac/wiki/TwistedTrial [` + essai + ]. Vous pouvez, par exemple, activer `+ pytest + pour votre projet comme ceci:

Pour cet exemple, nous utiliserons le lanceur de test par défaut + unittest +.

Dans le même projet, créez un fichier appelé + calculator.py + et mettez-y la classe + Calculator + suivante:

PyCharm facilite la création de tests pour votre code existant. Avec le fichier + calculator.py + ouvert, exécutez l’une des opérations suivantes que vous aimez:

Choisissez _Créer un nouveau test… _, et vous verrez la fenêtre suivante:

Laissez les valeurs par défaut de Target directory, Test file name et Test class name. Sélectionnez les deux méthodes et cliquez sur OK. Voila! PyCharm a automatiquement créé un fichier appelé + test_calculator.py + et a créé pour vous les tests de stub suivants:

Exécutez les tests en utilisant l’une des méthodes ci-dessous:

Vous verrez la fenêtre des tests ouverte en bas avec tous les tests échouant:

image:https://files.realpython.com/media/pycharm-failed-tests.810aa9c365cb.png}Failed tests dans PyCharm]

Notez que vous avez la hiérarchie des résultats des tests à gauche et la sortie du terminal à droite.

Maintenant, implémentez + test_add + en changeant le code comme suit:

Exécutez à nouveau les tests et vous verrez qu’un test a réussi et l’autre a échoué. Explorez les options pour afficher les tests réussis, pour afficher les tests ignorés, pour trier les tests par ordre alphabétique et pour trier les tests par durée:

Notez que la méthode + sleep (0.1) + que vous voyez dans le GIF ci-dessus est intentionnellement utilisée pour ralentir l’un des tests afin que le tri par durée fonctionne.

Ces projets à fichier unique sont parfaits pour les exemples, mais vous travaillerez souvent sur des projets beaucoup plus importants sur une plus longue période. Dans cette section, vous allez voir comment PyCharm fonctionne avec un projet plus vaste.

Pour explorer les fonctionnalités de PyCharm axées sur les projets, vous allez utiliser le framework Web Alcazar qui a été conçu à des fins d’apprentissage. Pour continuer à suivre, clonez le référentiel localement:

Une fois que vous avez un projet localement, ouvrez-le dans PyCharm en utilisant l’une des méthodes suivantes:

Après l’une de ces étapes, recherchez le dossier contenant le projet sur votre ordinateur et ouvrez-le.

Si ce projet contient un virtual environment, PyCharm utilisera automatiquement cet environnement virtuel et en fera l’interpréteur de projet.

Si vous devez configurer un autre + virtualenv +, ouvrez Preferences sur Mac en appuyant sur [.keys] #Cmd +, # ou Settings sur Windows ou Linux en appuyant sur [.keys] # Ctrl + Alt + S # et recherchez le Project : Section ProjectName. Ouvrez le menu déroulant et choisissez Project Interpreter:

Choisissez le + virtualenv + dans la liste déroulante. Si ce n’est pas le cas, cliquez sur le bouton Paramètres à droite de la liste déroulante, puis choisissez _Ajouter… _. Les autres étapes devraient être les mêmes que lorsque nous étions link: # writing-code-in-pycharm [création d’un nouveau projet].

Dans un grand projet où il est difficile pour une seule personne de se souvenir où tout se trouve, il est très important de pouvoir naviguer rapidement et trouver ce que vous cherchez. PyCharm vous couvre également ici. Utilisez le projet que vous avez ouvert dans la section ci-dessus pour pratiquer ces raccourcis:

Quant à la navigation, les raccourcis suivants peuvent vous faire gagner beaucoup de temps:

Pour plus de détails, consultez la documentation officielle.

Les systèmes de contrôle de version tels que Git et Mercurial sont quelques-uns des outils les plus importants dans le monde du développement logiciel moderne. Il est donc essentiel qu’un IDE les soutienne. PyCharm fait très bien cela en s’intégrant à de nombreux systèmes VC populaires tels que Git (et Github), Mercurial, https://www.perforce.com/solutions/version-control [ Perforce] et, Subversion.

Vous pouvez trouver presque tout ce dont vous avez besoin pour le développement dans PyCharm. Si vous ne le pouvez pas, il existe très probablement un plugin qui ajoute les fonctionnalités dont vous avez besoin à PyCharm. Par exemple, ils peuvent:

Par exemple, IdeaVim ajoute l’émulation Vim à PyCharm. Si vous aimez Vim, cela peut être une très bonne combinaison.

Material Theme UI change l’apparence de PyCharm en un aspect Material Design:

Vue.js ajoute la prise en charge des projets Vue.js. Markdown offre la possibilité de modifier les fichiers Markdown dans l’EDI et de voir le HTML rendu dans un aperçu en direct. Vous pouvez trouver et installer tous les plugins disponibles en allant dans Preferences → Plugins sur Mac ou Settings → Plugins sur Windows ou Linux, sous l’onglet Marketplace:

Si vous ne trouvez pas ce dont vous avez besoin, vous pouvez même développer votre propre plugin.

Si vous ne trouvez pas le bon plugin et que vous ne souhaitez pas développer le vôtre car il existe déjà un package dans PyPI, vous pouvez l’ajouter à PyCharm en tant qu’outil externe. Prenez par exemple + Flake8 +, l’analyseur de code.

Tout d’abord, installez + flake8 + dans votre virtualenv avec + pip install flake8 + dans l’application Terminal de votre choix. Vous pouvez également utiliser celui intégré à PyCharm:

Ensuite, accédez à Préférences → Tools sur Mac ou Settings → Tools sur Windows/Linux, puis choisissez External Tools. Cliquez ensuite sur le petit bouton _ + _ en bas (1). Dans la nouvelle fenêtre contextuelle, insérez les détails comme indiqué ci-dessous et cliquez sur OK pour les deux fenêtres:

Ici, Program (2) fait référence à l’exécutable Flake8 qui se trouve dans le dossier /bin de votre environnement virtuel. Arguments (3) fait référence au fichier que vous souhaitez analyser à l’aide de Flake8. Working directory est le répertoire de votre projet.

Vous pouvez coder en dur les chemins absolus pour tout ici, mais cela signifierait que vous ne pourriez pas utiliser cet outil externe dans d’autres projets. Vous ne pourrez l’utiliser que dans un seul projet pour un seul fichier.

Vous devez donc utiliser quelque chose appelé Macros. Les macros sont essentiellement des variables au format + $ name $ + qui changent en fonction de votre contexte. Par exemple, + $ FileName $ + est + first.py + lorsque vous modifiez + first.py +, et il est + second.py + lorsque vous modifiez + second.py +. Vous pouvez voir leur liste et insérer n’importe laquelle d’entre elles en cliquant sur les boutons _Insert Macro… _. Étant donné que vous avez utilisé des macros ici, les valeurs changeront en fonction du projet sur lequel vous travaillez actuellement, et Flake8 continuera de faire son travail correctement.

Pour l’utiliser, créez un fichier + example.py + et mettez-y le code suivant:

Il enfreint délibérément certaines des règles Flake8. Cliquez avec le bouton droit sur l’arrière-plan de ce fichier. Choisissez Outils externes puis Flake8. Voilà! La sortie de l’analyse Flake8 apparaîtra en bas:

Afin de le rendre encore meilleur, vous pouvez lui ajouter un raccourci. Accédez à Preferences sur Mac ou à Settings sur Windows ou Linux. Ensuite, accédez à Keymap → Outils externes → Outils externes. Double-cliquez sur Flake8 et choisissez Ajouter un raccourci clavier. Vous verrez cette fenêtre:

Dans l’image ci-dessus, le raccourci est [.keys] # Ctrl + Alt + A # pour cet outil. Ajoutez votre raccourci préféré dans la zone de texte et cliquez sur OK pour les deux fenêtres. Vous pouvez désormais utiliser ce raccourci pour analyser le fichier sur lequel vous travaillez actuellement avec Flake8.

PyCharm Professional est une version payante de PyCharm avec plus de fonctionnalités et d’intégrations prêtes à l’emploi. Dans cette section, vous serez principalement présenté avec des aperçus de ses principales fonctionnalités et des liens vers la documentation officielle, où chaque fonctionnalité est discutée en détail. N’oubliez pas qu’aucune des fonctionnalités suivantes n’est disponible dans l’édition communautaire.