Dans ce cours nous allons explorer les fonctionnalités de débugging de deux IDE, Visual Studio Code et PyCharm. Vous êtes libre de choisir l’un ou l’autre de ces IDE. Il vous suffira de vous rendre dans la section correspondant à votre IDE.
Utilisez pleinement Visual Studio Code
Selon le Stack Overflow Developer Survey de 2019, Visual Studio Code est l’IDE le plus populaire. D’ailleurs, de nombreux développeurs Python en on fait leur IDE préféré. Parmi les raisons principales, il y a ses nombreuses fonctionnalités, comme le fait de pouvoir travailler avec un Jupyter Notebook. Dans notre cas, les fonctionnalités qui nous intéressent concernent le débugging. Découvrons-les ensemble.
Ouvrez Visual Studio Code. Dans le menu à gauche, cliquez sur le bouton menant à “Extensions”.
Ensuite, nous allons installer l’extension de Python dans Visual Studio Code. Il faut pour cela cliquer dans la zone d'extension à gauche et chercher “Python”. Il s’agit de l’extension créée par Microsoft “Python extension for Visual Studio Code”. Vous ne pouvez pas la manquer, elle a été téléchargée plus de 35 millions de fois !
Comme vous le voyez, cette extension contient un linteur, un débuggeur et tout un tas d’autres outils très utiles.
Enfin, sélectionnez l’interpréteur Python de Visual Studio Code. Pour cela, cliquez sur “Affichage”, puis “Palettes de commandes…”. Tapez “python select” et choisissez “Python: Select Interpreter”.
En fonction du nombre de versions de Python installées sur votre ordinateur, vous pouvez avoir plusieurs interpréteurs. Je vous recommande d’en choisir un qui est récent et stable.
Voilà, nous avons tout ce qu’il faut pour débugger nos projets Python avec Visual Studio Code !
Traquez les bugs dans Visual Studio Code
Dans le screencast suivant, nous allons découvrir les fonctionnalités de débugging de Visual Studio Code pour traquer les bugs de notre projet logiciel. Nous allons utiliser le linteur, créer un fichier launch.json et explorer le mode débug. Vous êtes prêt ?
Nous venons de voir que Visual Studio Code propose de nombreuses fonctionnalités pratiques pour le débugging. Nous avons modifié le fichier launch.json pour éviter que le mode débug n’arrête à chaque instruction. N’hésitez pas à lire attentivement les informations que vous renvoie le linteur, cela vous évitera de très nombreux bugs.
Voyons maintenant comment créer des points d'arrêt, des points d'arrêt conditionnels et des points de journalisation :
Utilisez pleinement PyCharm
Contrairement à Visual Studio Code, Pycharm a été créé et pensé exclusivement pour la programmation en Python. Autrement dit, pas la peine d'installer des extensions pour intégrer Python à l’IDE. Avec PyCharm, vous pouvez également travailler avec des Jupyter Notebook, sur des projets web ou encore des outils de virtualisation comme Docker. Mais trêve de paroles, passons à la pratique.
Traquez les bugs dans PyCharm
Dans le screencast suivant, nous allons découvrir les fonctionnalités de débugging de Pycharm. Nous verrons comment utiliser le mode débug, créer des points d’arrêt simples, ainsi que des logs points. Prêt ?
Voyons maintenant comment créer des points d'arrêt conditionnels et des points de journalisation avec PyCharm :
Comme nous l’avons vu, PyCharm propose globalement les mêmes fonctionnalités que Visual Studio Code pour le débugging. Nous avons vu comment passer en mode débug pour créer des points d'arrêt simples et conditionnels, ainsi que des points de journalisation. Nous avons également utilisé le linteur pour anticiper les bugs avant qu’ils ne se produisent et deviennent un problème. N’hésitez donc pas à prendre le temps de lire ce que PyCharm vous dit.
Bonus : Traquez les bugs dans un notebook Jupyter
Le notebook Jupyter est le meilleur ami du Data Analyst et du Data Scientist. Il s’agit d’un logiciel qui permet d’écrire du code et du texte dans des cellules.
Voyons comment débugger avec Jupyter Notebook dans le screencast ci-dessous :
Dans ce screencast, nous avons découvert le fonctionnement des commandes magiques. Nous avons modifié le détail des informations renvoyées par les stack traces grâce à la commande magique %xmode, et avons vu comment lancer pdb avec les commandes magiques %debug et %pdb on ou %pdb off.
En résumé
Visual Studio Code est un IDE très populaire qui contient de nombreuses options pour traquer les bugs en Python. Il faut installer les extensions nécessaires pour qu’il fonctionne avec Python.
PyCharm est un IDE créé spécialement pour le langage Python. Il possède de nombreuses fonctionnalités natives de débugging.
Le notebook Jupyter permet comme les IDE de débugger son programme. Il permet d’utiliser des commandes magiques permettant notamment de lancer pdb.
Voilà nos environnements paramétrés pour le débugging des logiciels Python ! Mais attendez, est-ce que les projets web ont des erreurs spécifiques à eux à débugger aussi ? 🤔 Eh oui ! Dans le prochain chapitre, nous verrons les erreurs les plus communes pour des projets Django et Flask. Vous êtes prêt ?
