Quelle est la bonne façon de déboguer dans le notebook iPython?

Comme je le sais, %debug magic peut faire le débogage dans une cellule.

Cependant, j'ai des appels de fonction sur plusieurs cellules.

Par exemple,

In[1]: def fun1(a)
           def fun2(b)
               # I want to set a breakpoint for the following line #
               return do_some_thing_about(b)

       return fun2(a)

In[2]: import multiprocessing as mp
       pool=mp.Pool(processes=2)
       results=pool.map(fun1, 1.0)
       pool.close()
       pool.join

Ce que j'ai essayé:

1. J'ai essayé de définir %debugdans la première ligne de cell-1. Mais il entre en mode débogage immédiatement, avant même d'exécuter cell-2.

2. J'ai essayé d'ajouter %debugla ligne juste avant le code return do_some_thing_about(b). Mais alors le code s'exécute pour toujours, ne s'arrête jamais.

Quelle est la bonne façon de définir un point d'arrêt dans le bloc-notes ipython?

Utiliser ipdb

Installez-le via

pip install ipdb

Usage:

In[1]: def fun1(a):
   def fun2(a):
       import ipdb; ipdb.set_trace() # debugging starts here
       return do_some_thing_about(b)
   return fun2(a)
In[2]: fun1(1)

Pour exécuter une utilisation ligne par ligne net pour accéder à une fonction, utiliser set quitter l'invite de débogage c.

Pour la liste complète des commandes disponibles: https://appletree.or.kr/quick_reference_cards/Python/Python%20Debugger%20Cheatsheet.pdf

Vous pouvez utiliser à l' ipdbintérieur de jupyter avec:

from IPython.core.debugger import Tracer; Tracer()()

Edit : les fonctions ci-dessus sont obsolètes depuis IPython 5.1. Voici la nouvelle approche:

from IPython.core.debugger import set_trace

Ajoutez set_trace()là où vous avez besoin d'un point d'arrêt. Tapez helppour les ipdbcommandes lorsque le champ de saisie apparaît.

Votre fonction de retour est en ligne avec la fonction def (fonction principale), vous devez lui donner un onglet. Et utilise

%%debug 

au lieu de

%debug 

pour déboguer la cellule entière non seulement la ligne. J'espère que cela vous aidera peut-être.

Vous pouvez toujours ajouter ceci dans n'importe quelle cellule:

import pdb; pdb.set_trace()

et le débogueur s'arrêtera sur cette ligne. Par exemple:

In[1]: def fun1(a):
           def fun2(a):
               import pdb; pdb.set_trace() # debugging starts here
           return fun2(a)

In[2]: fun1(1)

En Python 3.7, vous pouvez utiliser la fonction breakpoint () . Entrez simplement

breakpoint()

partout où vous souhaitez que l'exécution s'arrête et à partir de là, vous pouvez utiliser les mêmes commandes pdb (r, c, n, ...) ou évaluer vos variables.

Tapez import pdbsimplement le notebook jupyter, puis utilisez cette feuille de triche pour déboguer. C'est très pratique.

c-> continuer, s-> pas, b 12-> définir le point d'arrêt à la ligne 12 et ainsi de suite.

Quelques liens utiles: Document officiel Python sur pdb , exemples de débogueur Python pdb pour mieux comprendre comment utiliser les commandes du débogueur .

Quelques captures d'écran utiles:

Après avoir obtenu une erreur, dans la cellule suivante, exécutez simplement %debuget c'est tout.

La %pdbcommande magique est également bonne à utiliser. Dites simplement %pdb onet par la suite, le pdbdébogueur fonctionnera sur toutes les exceptions, quelle que soit la profondeur de la pile d'appels. Très utile.

Si vous avez une ligne particulière que vous souhaitez déboguer, il suffit de lever une exception à cet endroit (souvent vous l'êtes déjà!) Ou d'utiliser la %debugcommande magique suggérée par d'autres personnes.

Je viens de découvrir PixieDebugger . Même si je n'ai pas encore eu le temps de le tester, cela semble vraiment la manière la plus similaire de déboguer la façon dont nous sommes utilisés en ipython avec ipdb

Il a également un onglet "évaluer"

Un débogueur natif est mis à disposition en tant qu'extension de JupyterLab. Sorti il ​​y a quelques semaines, celui-ci peut être installé en obtenant l'extension appropriée, ainsi que le noyau xeus-python (qui vient notamment sans les magies bien connues des utilisateurs d'ipykernel):

jupyter labextension install @jupyterlab/debugger
conda install xeus-python -c conda-forge

Cela permet une expérience de débogage visuelle bien connue des autres IDE.

Source: un débogueur visuel pour Jupyter