"pdb" — Le débogueur Python
***************************

**Code source :** Lib/pdb.py

======================================================================

Le module "pdb" définit un débogueur de code source interactif pour
les programmes Python. Il supporte le paramétrage (conditionnel) de
points d'arrêt et l'exécution du code source ligne par ligne,
l'inspection des *frames* de la pile, la liste du code source, et
l'évaluation arbitraire de code Python dans le contexte de n'importe
quelle *frame* de la pile. Il supporte aussi le débogage post-mortem
et peut être contrôlé depuis un programme.

Le débogueur est extensible -- Il est en réalité défini comme la
classe "Pdb". C'est actuellement non-documenté mais facilement
compréhensible en lisant le code source. L'interface d'extension
utilise les modules "bdb" et "cmd".

L'invite du débogueur est "(Pdb)". L'usage typique pour exécuter un
programme sous le contrôle du débogueur est :

   >>> import pdb
   >>> import mymodule
   >>> pdb.run('mymodule.test()')
   > <string>(0)?()
   (Pdb) continue
   > <string>(1)?()
   (Pdb) continue
   NameError: 'spam'
   > <string>(1)?()
   (Pdb)

Modifié dans la version 3.3: La complétion via le module "readline'
est disponible pour les commandes et les arguments de commande, par
exemple les noms *global* et *local* sont proposés comme arguments de
la commande ``p`".

Le fichier "pdb.py" peut aussi être invoqué comme un script pour
déboguer d'autres scripts. Par exemple :

   python3 -m pdb myscript.py

Si le programme débogué se termine anormalement, *pdb* entrera en
débogage post-mortem. Après le débogage post-mortem (ou après une
sortie normale du programme), *pdb* redémarrera le programme. Le
redémarrage automatique préserve l'état de *pdb* (tels que les points
d'arrêt) et dans la plupart des cas est plus utile que de quitter le
débogueur à la sortie du programme.

Nouveau dans la version 3.2: Le fichier "pdb.py" accepte maintenant
une option "-c" qui exécute les commandes comme si elles provenaient
d'un fichier ".pdbrc", voir Commande du débogueur.

Nouveau dans la version 3.7: "pdb.py" accepte maintenant une option
"-m" qui déclenche l’exécution de modules de la même façon que
"python3 -m". De la même manière que dans un script, le débogueur va
mettre en pause l’exécution juste avant la première ligne du module.

L'usage typique pour forcer le débogueur depuis un programme
s'exécutant est d'insérer

   import pdb; pdb.set_trace()

à l'endroit où vous voulez pénétrer dans le débogueur.  Vous pouvez
alors parcourir le code suivant cette instruction, et continuer à
exécuter sans le débogueur en utilisant la commande "continue".

Nouveau dans la version 3.7: La fonction standard "breakpoint()",
quand elle est appelée avec les valeurs par défaut, peut être utilisée
en lieu et place de "import pdb; pdb.set_trace()".

L'usage typique pour inspecter un programme planté :

   >>> import pdb
   >>> import mymodule
   >>> mymodule.test()
   Traceback (most recent call last):
     File "<stdin>", line 1, in <module>
     File "./mymodule.py", line 4, in test
       test2()
     File "./mymodule.py", line 3, in test2
       print(spam)
   NameError: spam
   >>> pdb.pm()
   > ./mymodule.py(3)test2()
   -> print(spam)
   (Pdb)

Le module définit les fonctions suivantes; chacune entre dans le
débogueur d'une manière légèrement différente:

pdb.run(statement, globals=None, locals=None)

   Exécute la *déclaration* (donnée sous forme de chaîne de caractères
   ou d'objet code) sous le contrôle du débogueur. L'invite de
   débogage apparaît avant l'exécution de tout code; vous pouvez
   définir des points d'arrêt et taper "continue", ou vous pouvez
   passer à travers l'instruction en utilisant "step" ou "next"
   (toutes ces commandes sont expliquées ci-dessous). Les arguments
   *globals* et *locals* optionnels spécifient l'environnement dans
   lequel le code est exécuté; par défaut le dictionnaire du module
   "__main__" est utilisé. (Voir l'explication des fonctions natives
   "exec()" ou "eval()".)

pdb.runeval(expression, globals=None, locals=None)

   Évalue l'*expression* (donné comme une chaine de caractères ou un
   code objet) sous le contrôle du débogueur. Quand la fonction
   "runeval()" retourne, elle renvoie la valeur de l'expression.
   Autrement cette fonction est similaire à la fonction "run()".

pdb.runcall(function, *args, **kwds)

   Appelle la *function* (une fonction ou une méthode, pas une chaine
   de caractères) avec les arguments donnés. Quand "runcall()"
   revient, il retourne ce que l'appel de fonctionne a renvoyé.
   L'invite de débogage apparaît dès que la fonction est entrée.

pdb.set_trace(*, header=None)

   Invoque le débogueur dans la cadre d'exécution appelant. C'est
   utile pour coder en dur un point d'arrêt dans un programme, même si
   le code n'est pas autrement débogué (par exemple, quand une
   assertion échoue). S'il est donné, *header* est affiché sur la
   console juste avant que le débogage commence.

   Modifié dans la version 3.7: L’argument *keyword-only* *header*.

pdb.post_mortem(traceback=None)

   Entre le débogage post-mortem de l'objet *traceback* donné. Si
   aucun *traceback* n'est donné, il utilise celui de l'exception en
   cours de traitement (une exception doit être gérée si la valeur par
   défaut doit être utilisée).

pdb.pm()

   Entre le débogage post-mortem de la trace trouvé dans "sys.
   last_traceback".

Les fonctions "run*" et "set_trace()" sont des alias pour instancier
la classe "Pdb" et appeler la méthode du même nom. Si vous souhaitez
accéder à d'autres fonctionnalités, vous devez le faire vous-même :

class pdb.Pdb(completekey='tab', stdin=None, stdout=None, skip=None, nosigint=False, readrc=True)

   Le classe du débogueur est la classe "Pdb".

   Les arguments *completekey*, *stdin* et *stdout* sont transmis à la
   classe sous-jacente "cmd.Cmd"; voir la description ici.

   L'argument *skip*, s'il est donné, doit être un itérable des noms
   de modules de style *glob*. Le débogueur n'entrera pas dans les
   *frames* qui proviennent d'un module qui correspond à l'un de ces
   motifs. [1]

   Par défaut, Pdb définit un gestionnaire pour le signal SIGINT (qui
   est envoyé lorsque l'utilisateur appuie sur "Ctrl-C" sur la
   console) lorsque vous donnez une commande "continue". Ceci vous
   permet de pénétrer à nouveau dans le débogueur en appuyant sur
   "Ctrl-C". Si vous voulez que Pdb ne touche pas le gestionnaire
   SIGINT, assignez *nosigint* à *True*.

   L'argument *readrc* vaut *True* par défaut et contrôle si Pdb
   chargera les fichiers *.pdbrc* depuis le système de fichiers.

   Exemple d'appel pour activer le traçage avec *skip* :

      import pdb; pdb.Pdb(skip=['django.*']).set_trace()

   Nouveau dans la version 3.1: L'argument *skip*.

   Nouveau dans la version 3.2: L'argument *nosigint*.  Auparavant, un
   gestionnaire SIGINT n'était jamais configuré par Pdb.

   Modifié dans la version 3.6: L'argument *readrc*.

   run(statement, globals=None, locals=None)
   runeval(expression, globals=None, locals=None)
   runcall(function, *args, **kwds)
   set_trace()

      Voir la documentation pour les fonctions expliquées ci-dessus.


Commande du débogueur
=====================

Les commandes reconnues par le débogueur sont listées. La plupart des
commandes peuvent être abrégées à une ou deux lettres comme indiquées;
par exemple. "h(elp)" signifie que soit "h" ou "help" peut être
utilisée pour entrer la commande *help* (mais pas "he" or "hel", ni
"H" ou "HELP"). Les arguments des commandes doivent être séparées par
des espaces (espaces ou tabulations). Les arguments optionnels sont
entourés dans des crochets ("[]") dans la syntaxe de la commande; les
crochets ne doivent pas être insérés. Les alternatives dans la syntaxe
de la commande sont séparés par une barre verticale ("|").

Entrer une ligne vide répète la dernière commande entrée. Exception:
si la dernière commande était la commande "list", les 11 prochaines
lignes sont affichées.

Les commandes que le débogueur ne reconnaît pas sont supposées être
des instructions Python et sont exécutées dans le contexte du
programme en cours de débogage. Les instructions Python peuvent
également être préfixées avec un point d'exclamation ("!"). C'est une
façon puissante d'inspecter le programme en cours de débogage; il est
même possible de changer une variable ou d'appeler une fonction.
Lorsqu'une exception se produit dans une telle instruction, le nom de
l'exception est affiché mais l'état du débogueur n'est pas modifié.

Le débogueur supporte aliases. Les alias peuvent avoir des paramètres
qui permettent un certain niveau d'adaptabilité au contexte étudié.

Plusieurs commandes peuvent être saisies sur une seule ligne, séparées
par ";;". (Un seul ";" n'est pas utilisé car il est le séparateur de
plusieurs commandes dans une ligne qui est passée à l'analyseur
Python. Aucune intelligence n'est appliquée pour séparer les
commandes; l'entrée est divisée à la première paire de ";;" paire,
même si il est au milieu d'une chaîne de caractères.

Si un fichier ".pdbrc" existe dans le répertoire d'accueil de
l'utilisateur ou dans le répertoire courant, il est lu et exécuté
comme si il avait été écrit dans l'invite du débogueur. C'est
particulièrement utile pour les alias. Si les deux fichiers existent,
celui dans le répertoire d’accueil de l’utilisateur est lu en premier
et les alias définis dedans peuvent être surchargés par le fichier
local.

Modifié dans la version 3.2: Le fichier ".pdbrc" peut maintenant
contenir des commandes qui continue le débogage, comme "continue" ou
"next". Précédemment, ces commandes n'avaient aucun effet.

h(elp) [command]

   Sans argument, affiche la liste des commandes disponibles. Avec une
   *commande* comme argument, affiche l'aide de cette commande. "help
   pdb" affiche la documentation complète (la *docstring* du module
   "pdb"). Puisque l'argument *command* doit être un identificateur,
   "help exec" doit être entré pour obtenir de l'aide sur la commande
   "!".

w(here)

   Affiche une trace de pile, avec la *frame* le plus récent en bas.
   Une flèche indique le *frame* courant, qui détermine le contexte de
   la plupart des commandes.

d(own) [count]

   Déplace le niveau de la *frame* courante *count* (par défaut un)
   vers le bas dans la trace de pile (vers une *frame* plus récente).

u(p) [count]

   Déplace le niveau de la *frame* courante *count* (par défaut un)
   vers le haut dans la trace de pile (vers une *frame* plus
   ancienne).

b(reak) [([filename:]lineno | function) [, condition]]

   Avec un argument *lineno*, définit une pause dans le fichier
   courant. Avec un argument *function*, définit une pause à la
   première instruction exécutable dans cette fonction. Le numéro de
   ligne peut être préfixé d'un nom de fichier et d'un deux-points,
   pour spécifier un point d'arrêt dans un autre fichier (probablement
   celui qui n'a pas encore été chargé). Le fichier est recherché sur
   "sys.path". Notez que chaque point d'arrêt reçoit un numéro auquel
   se réfèrent toutes les autres commandes de point d'arrêt.

   Si un second argument est présent, c'est une expression qui doit
   évaluer à *True* avant que le point d'arrêt ne soit honoré.

   Sans argument, liste tous les arrêts, incluant pour chaque point
   d'arrêt, le nombre de fois qu'un point d'arrêt a été atteint, le
   nombre de ignore, et la condition associée le cas échéant.

tbreak [([filename:]lineno | function) [, condition]]

   Point d'arrêt temporaire, qui est enlevé automatiquement au premier
   passage. Les arguments sont les mêmes que pour "break".

cl(ear) [filename:lineno | bpnumber [bpnumber ...]]

   Avec un argument *filename:lineno*, efface tous les points d'arrêt
   sur cette ligne. Avec une liste de numéros de points d'arrêt
   séparés par un espace, efface ces points d'arrêt. Sans argument,
   efface tous les points d'arrêt (mais demande d'abord confirmation).

disable [bpnumber [bpnumber ...]]

   Désactive les points d'arrêt indiqués sous la forme d'une liste de
   numéros de points d'arrêt séparés par un espace. Désactiver un
   point d'arrêt signifie qu'il ne peut pas interrompre l'exécution du
   programme, mais à la différence d'effacer un point d'arrêt, il
   reste dans la liste des points d'arrêt et peut être (ré)activé.

enable [bpnumber [bpnumber ...]]

   Active les points d'arrêt spécifiés.

ignore bpnumber [count]

   Définit le nombre de fois où le point d'arrêt donné sera passé. Si
   le compte est omis, le compte est mis à 0. Un point d'arrêt devient
   actif lorsque le compte est nul. Lorsqu'il n'est pas nul, le
   comptage est diminué à chaque fois que le point d'arrêt est atteint
   et que le point d'arrêt n'est pas désactivé et que toute condition
   associée est évaluée comme vraie.

condition bpnumber [condition]

   Définit une nouvelle *condition* pour le point d'arrêt, une
   expression qui doit évaluer à *True* avant que le point d'arrêt ne
   soit honoré. Si *condition* est absente, toute condition existante
   est supprimée, c'est-à-dire que le point d'arrêt est rendu
   inconditionnel.

commands [bpnumber]

   Spécifie une liste de commandes pour le numéro du point d'arrêt
   *bpnumber*. Les commandes elles-mêmes apparaissent sur les lignes
   suivantes. Tapez une ligne contenant juste "end" pour terminer les
   commandes. Un exemple :

      (Pdb) commands 1
      (com) p some_variable
      (com) end
      (Pdb)

   Pour supprimer toutes les commandes depuis un point d'arrêt,
   écrivez "commands" suivi immédiatement de "end" ; ceci supprime les
   commandes.

   Sans argument *bpnumber*, "commands" se réfère au dernier point
   d'arrêt défini.

   Vous pouvez utiliser les commandes de point d'arrêt pour redémarrer
   votre programme.  Utilisez simplement la commande "continue", ou
   "step", ou toute autre commande qui reprend l'exécution.

   Entrer toute commande reprenant l'exécution (actuellement
   "continue", "step", "next", "return", "jump", "quit" et leurs
   abréviations) termine la liste des commandes (comme si cette
   commande était immédiatement suivie de la fin). C'est parce que
   chaque fois que vous reprenez l'exécution (même avec un simple
   *next* ou *step*), vous pouvez rencontrer un autre point d'arrêt --
   qui pourrait avoir sa propre liste de commandes, conduisant à des
   ambiguïtés sur la liste à exécuter.

   Si vous utilisez la commande 'silence' dans la liste des commandes,
   le message habituel concernant l'arrêt à un point d'arrêt n'est pas
   affiché. Ceci peut être souhaitable pour les points d'arrêt qui
   doivent afficher un message spécifique et ensuite continuer. Si
   aucune des autres commandes n'affiche quoi que ce soit, vous ne
   voyez aucun signe indiquant que le point de rupture a été atteint.

s(tep)

   Exécute la ligne en cours, s'arrête à la première occasion possible
   (soit dans une fonction qui est appelée, soit sur la ligne suivante
   de la fonction courante).

n(ext)

   Continue l'exécution jusqu'à ce que la ligne suivante de la
   fonction en cours soit atteinte ou qu'elle revienne. (La différence
   entre "next" et "step" est que "step" s'arrête dans une fonction
   appelée, tandis que "next" exécute les fonctions appelées à
   (presque) pleine vitesse, ne s'arrêtant qu'à la ligne suivante dans
   la fonction courante.)

unt(il) [lineno]

   Sans argument, continue l'exécution jusqu'à ce que la ligne avec un
   nombre supérieur au nombre actuel soit atteinte.

   Avec un numéro de ligne, continue l'exécution jusqu'à ce qu'une
   ligne avec un numéro supérieur ou égal à celui-ci soit atteinte.
   Dans les deux cas, arrête également lorsque la *frame* courante
   revient.

   Modifié dans la version 3.2: Permet de donner un numéro de ligne
   explicite.

r(eturn)

   Continue l'exécution jusqu'au retour de la fonction courante.

c(ont(inue))

   Continue l'exécution, seulement s'arrête quand un point d'arrêt est
   rencontré.

j(ump) lineno

   Définit la prochaine ligne qui sera exécutée. Uniquement disponible
   dans la *frame* inférieur. Cela vous permet de revenir en arrière
   et d'exécuter à nouveau le code, ou de passer en avant pour sauter
   le code que vous ne voulez pas exécuter.

   Il est à noter que tous les sauts ne sont pas autorisés -- par
   exemple, il n'est pas possible de sauter au milieu d'une boucle
   "for" ou en dehors d'une clause "finally".

l(ist) [first[, last]]

   Liste le code source du fichier courant. Sans arguments, liste 11
   lignes autour de la ligne courante ou continue le listing
   précédant. Avec l'argument ".", liste 11 lignes autour de la ligne
   courante. Avec un argument, liste les 11 lignes autour de cette
   ligne. Avec deux arguments, liste la plage donnée; si le second
   argument est inférieur au premier, il est interprété comme un
   compte.

   La ligne en cours dans l'image courante est indiquée par "->". Si
   une exception est en cours de débogage, la ligne où l'exception a
   été initialement levée ou propagée est indiquée par ">>", si elle
   diffère de la ligne courante.

   Nouveau dans la version 3.2: Le marqueur ">>".

ll | longlist

   Liste le code source de la fonction ou du bloc courant. Les lignes
   intéressantes sont marquées comme pour "list".

   Nouveau dans la version 3.2.

a(rgs)

   Affiche la liste d'arguments de la fonction courante.

p expression

   Évalue l'*expression* dans le contexte courant et affiche sa
   valeur.

   Note:

     "print()" peut aussi être utilisée, mais n'est pas une commande
     du débogueur --- il exécute la fonction Python "print()".

pp expression

   Comme la commande "p", sauf que la valeur de l'expression est
   joliment affiché en utilisant le module "pprint".

whatis expression

   Affiche le type de l'*expression*.

source expression

   Essaie d'obtenir le code source pour l'objet donné et l'affiche.

   Nouveau dans la version 3.2.

display [expression]

   Affiche la valeur de l'expression si elle a changée, chaque fois
   que l'exécution s'arrête dans la *frame* courante.

   Sans expression, liste toutes les expressions pour la *frame*
   courante.

   Nouveau dans la version 3.2.

undisplay [expression]

   N'affiche plus l'expression dans la *frame* courante. Sans
   expression, efface toutes les expressions d'affichage de la *frame*
   courante.

   Nouveau dans la version 3.2.

interact

   Démarre un interpréteur interactif (en utilisant le module "code")
   dont l'espace de nommage global contient tous les noms (*global* et
   *local*) trouvés dans la portée courante.

   Nouveau dans la version 3.2.

alias [name [command]]

   Créez un alias appelé *name* qui exécute *command*. La commande ne
   doit *pas* être entourée de guillemets. Les paramètres remplaçables
   peuvent être indiqués par "%1", "%2" et ainsi de suite, tandis que
   "%*" est remplacé par tous les paramètres. Si aucune commande n'est
   donnée, l'alias courant pour *name* est affiché. Si aucun argument
   n'est donné, tous les alias sont listés.

   Les alias peuvent être imbriqués et peuvent contenir tout ce qui
   peut être légalement tapé à l'invite *pdb*. Notez que les commandes
   *pdb* internes *peuvent* être remplacées par des alias. Une telle
   commande est alors masquée jusqu'à ce que l'alias soit supprimé.
   L'*aliasing* est appliqué récursivement au premier mot de la ligne
   de commande; tous les autres mots de la ligne sont laissés seuls.

   Comme un exemple, voici deux alias utiles (spécialement quand il
   est placé dans le fichier ".pdbrc") :

      # Print instance variables (usage "pi classInst")
      alias pi for k in %1.__dict__.keys(): print("%1.",k,"=",%1.__dict__[k])
      # Print instance variables in self
      alias ps pi self

unalias name

   Supprime l'alias spécifié.

! statement

   Exécute l'instruction *statement* (une ligne) dans le contexte de
   la *frame* de la pile courante. Le point d'exclamation peut être
   omis à moins que le premier mot de l'instruction ne ressemble à une
   commande de débogueur. Pour définir une variable globale, vous
   pouvez préfixer la commande d'assignation avec une instruction
   "global" sur la même ligne, par exemple :

      (Pdb) global list_options; list_options = ['-l']
      (Pdb)

run [args ...]
restart [args ...]

   Redémarre le programme Python débogué. Si un argument est fourni,
   il est splitté avec "shlex" et le résultat es utilisé comme le
   nouveau "sys.argv". L'historique, les points d'arrêt, les actions
   et les options du débogueur sont préservés. "restart" est un alias
   pour "run".

q(uit)

   Quitte le débogueur. Le programme exécuté est arrêté.

debug code

   Enter a recursive debugger that steps through the code argument
   (which is an arbitrary expression or statement to be executed in
   the current environment).

retval
Print the return value for the last return of a function.

-[ Notes ]-

[1] La question de savoir si une *frame* est considérée comme
    provenant d'un certain module est déterminée par le "__name__"
    dans les globales de la *frame*.
