# 26.2. `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.

The debugger is extensible — it is actually defined as the class `Pdb`. This is currently undocumented but easily understood by reading the source. The extension interface uses the modules `bdb` and `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)

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

    python -m pdb myscript.py

When invoked as a script, pdb will automatically enter post-mortem debugging if the program being debugged exits abnormally. After post-mortem debugging (or after normal exit of the program), pdb will restart the program. Automatic restarting preserves pdb’s state (such as breakpoints) and in most cases is more useful than quitting the debugger upon program’s exit.

Nouveau dans la version 2.4: Restarting post-mortem behavior added.

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

    import pdb; pdb.set_trace()

at the location you want to break into the debugger. You can then step through the code following this statement, and continue running without the debugger using the `c` command.

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[, locals]])

  Execute the statement (given as a string) under debugger control. The debugger prompt appears before any code is executed; you can set breakpoints and type `continue`, or you can step through the statement using `step` or `next` (all these commands are explained below). The optional globals and locals arguments specify the environment in which the code is executed; by default the dictionary of the module `__main__` is used. (See the explanation of the `exec` statement or the `eval()` built-in function.)

`pdb.``runeval`(expression[, globals[, locals]])

  Evaluate the expression (given as a string) under debugger control. When `runeval()` returns, it returns the value of the expression. Otherwise this function is similar to `run()`.

`pdb.``runcall`(function[, argument, ...])

  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`()

  Entre le débogueur dans la frame de la pile d’appel. Ceci 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).

`pdb.``post_mortem`([traceback])

  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)

  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

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

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

  Nouveau dans la version 2.7: L’argument skip.

  `run`(statement[, globals[, locals]])
  `runeval`(expression[, globals[, locals]])
  `runcall`(function[, argument, ...])
  `set_trace`()

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

# 26.3. Commande du débogueur

The debugger recognizes the following commands. Most commands can be abbreviated to one or two letters; e.g. `h(elp)` means that either `h` or `help` can be used to enter the help command (but not `he` or `hel`, nor `H` or `Help` or `HELP`). Arguments to commands must be separated by whitespace (spaces or tabs). Optional arguments are enclosed in square brackets (`[]`) in the command syntax; the square brackets must not be typed. Alternatives in the command syntax are separated by a vertical bar (`|`).

Entering a blank line repeats the last command entered. Exception: if the last command was a `list` command, the next 11 lines are listed.

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é.

Multiple commands may be entered on a single line, separated by `;;`. (A single `;` is not used as it is the separator for multiple commands in a line that is passed to the Python parser.) No intelligence is applied to separating the commands; the input is split at the first `;;` pair, even if it is in the middle of a quoted string.

The debugger supports aliases. Aliases can have parameters which allows one a certain level of adaptability to the context under examination.

If a file `.pdbrc` exists in the user’s home directory or in the current directory, it is read in and executed as if it had been typed at the debugger prompt. This is particularly useful for aliases. If both files exist, the one in the home directory is read first and aliases defined there can be overridden by the local file.

h(elp) [command]

  Without argument, print the list of available commands. With a command as argument, print help about that command. `help pdb` displays the full documentation file; if the environment variable `PAGER` is defined, the file is piped through that command instead. Since the command argument must be an identifier, `help exec` must be entered to get help on the `!` command.

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)

  Move the current frame one level down in the stack trace (to a newer frame).

u(p)

  Move the current frame one level up in the stack trace (to an older frame).

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

  With a lineno argument, set a break there in the current file. With a function argument, set a break at the first executable statement within that function. The line number may be prefixed with a filename and a colon, to specify a breakpoint in another file (probably one that hasn’t been loaded yet). The file is searched on `sys.path`. Note that each breakpoint is assigned a number to which all the other breakpoint commands refer.

  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]]

  Temporary breakpoint, which is removed automatically when it is first hit. The arguments are the same as 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 …]]

  Disables the breakpoints given as a space separated list of breakpoint numbers. Disabling a breakpoint means it cannot cause the program to stop execution, but unlike clearing a breakpoint, it remains in the list of breakpoints and can be (re-)enabled.

enable [bpnumber [bpnumber …]]

  Enables the breakpoints specified.

ignore bpnumber [count]

  Sets the ignore count for the given breakpoint number. If count is omitted, the ignore count is set to 0. A breakpoint becomes active when the ignore count is zero. When non-zero, the count is decremented each time the breakpoint is reached and the breakpoint is not disabled and any associated condition evaluates to true.

condition bpnumber [condition]

  Condition is an expression which must evaluate to true before the breakpoint is honored. If condition is absent, any existing condition is removed; i.e., the breakpoint is made unconditional.

commands [bpnumber]

  Specify a list of commands for breakpoint number bpnumber. The commands themselves appear on the following lines. Type a line containing just “end” to terminate the commands. An example:

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

  To remove all commands from a breakpoint, type commands and follow it immediately with end; that is, give no commands.

  Sans argument bpnumber, les commandes se réfèrent au dernier point d’arrêt défini.

  You can use breakpoint commands to start your program up again. Simply use the continue command, or step, or any other command that resumes execution.

  Specifying any command resuming execution (currently continue, step, next, return, jump, quit and their abbreviations) terminates the command list (as if that command was immediately followed by end). This is because any time you resume execution (even with a simple next or step), you may encounter another breakpoint—which could have its own command list, leading to ambiguities about which list to execute.

  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.

  Nouveau dans la version 2.5.

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 execution until the next line in the current function is reached or it returns. (The difference between `next` and `step` is that `step` stops inside a called function, while `next` executes called functions at (nearly) full speed, only stopping at the next line in the current function.)

unt(il)

  Continue execution until the line with the line number greater than the current one is reached or when returning from current frame.

  Nouveau dans la version 2.6.

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.

  It should be noted that not all jumps are allowed — for instance it is not possible to jump into the middle of a `for` loop or out of a `finally` clause.

l(ist) [first[, last]]

  List source code for the current file. Without arguments, list 11 lines around the current line or continue the previous listing. With one argument, list 11 lines around at that line. With two arguments, list the given range; if the second argument is less than the first, it is interpreted as a count.

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` can also be used, but is not a debugger command — this executes the Python `print` statement.

pp expression

  Like the `p` command, except the value of the expression is pretty-printed using the `pprint` module.

alias [name [command]]

  Creates an alias called name that executes command. The command must not be enclosed in quotes. Replaceable parameters can be indicated by `%1`, `%2`, and so on, while `%*` is replaced by all the parameters. If no command is given, the current alias for name is shown. If no arguments are given, all aliases are listed.

  Aliases may be nested and can contain anything that can be legally typed at the pdb prompt. Note that internal pdb commands can be overridden by aliases. Such a command is then hidden until the alias is removed. Aliasing is recursively applied to the first word of the command line; all other words in the line are left alone.

  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

  Deletes the specified alias.

[!]statement

  Execute the (one-line) statement in the context of the current stack frame. The exclamation point can be omitted unless the first word of the statement resembles a debugger command. To set a global variable, you can prefix the assignment command with a `global` command on the same line, e.g.:

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

run [args …]

  Restart the debugged Python program. If an argument is supplied, it is split with « shlex » and the result is used as the new sys.argv. History, breakpoints, actions and debugger options are preserved. « restart » is an alias for « run ».

  Nouveau dans la version 2.6.

q(uit)

  Quit from the debugger. The program being executed is aborted.

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.