Python Language
Debuggen

Der Python-Debugger: Schrittweises Debuggen mit _pdb_

Die Python Standard Library enthält eine interaktive Debugging-Bibliothek namens pdb . pdb verfügt über umfangreiche Funktionen, wobei die am häufigsten verwendete Möglichkeit ist, ein Programm schrittweise durchzugehen .

Um sofort mit dem schrittweisen Debugging zu beginnen, verwenden Sie Folgendes:

python -m pdb <my_file.py>

Dadurch wird der Debugger in der ersten Zeile des Programms gestartet.

Normalerweise möchten Sie einen bestimmten Abschnitt des Codes für das Debugging verwenden. Dazu importieren wir die pdb-Bibliothek und unterbrechen mit set_trace () den Fluss dieses problematischen Beispielcodes.

import pdb

def divide(a, b):
    pdb.set_trace()
    return a/b 
    # What's wrong with this? Hint: 2 != 3

print divide(1, 2)

Wenn Sie dieses Programm ausführen, wird der interaktive Debugger gestartet.

python foo.py 
> ~/scratch/foo.py(5)divide()
-> return a/b
(Pdb) 

Häufig wird dieser Befehl in einer Zeile verwendet, sodass er mit einem einzelnen # -Zeichen auskommentiert werden kann

 import pdf; pdb.set_trace()

Bei der Eingabeaufforderung (Pdb) können Befehle eingegeben werden. Diese Befehle können Debugger-Befehle oder Python sein. Um Variablen zu drucken, können wir p aus dem Debugger oder den Python- Druck verwenden .

(Pdb) p a
1
(Pdb) print a
1

Um eine Liste aller lokalen Variablen anzuzeigen, verwenden Sie

locals

eingebaute Funktion

Dies sind gute Debugger-Befehle, die Sie kennen sollten:

b <n> | <f>: set breakpoint at line *n* or function named *f*.
# b 3
# b divide
b: show all breakpoints.
c: continue until the next breakpoint.
s: step through this line (will enter a function).
n: step over this line (jumps over a function).
r: continue until the current function returns.
l: list a window of code around this line.
p <var>: print variable named *var*.
# p x
q: quit debugger.
bt: print the traceback of the current execution call stack
up: move your scope up the function call stack to the caller of the current function
down: Move your scope back down the function call stack one level
step: Run the program until the next line of execution in the program, then return control back to the debugger
next: run the program until the next line of execution in the current function, then return control back to the debugger
return: run the program until the current function returns, then return control back to the debugger
continue: continue running the program until the next breakpoint (or set_trace si called again)

Der Debugger kann Python auch interaktiv auswerten:

-> return a/b
(Pdb) p a+b
3
(Pdb) [ str(m) for m in [a,b]] 
['1', '2']
(Pdb) [ d for d in xrange(5)]
[0, 1, 2, 3, 4]

Hinweis:

Wenn einer Ihrer Variablennamen mit den Debugger-Befehlen übereinstimmt, verwenden Sie ein Ausrufezeichen ' ! 'vor dem var, um explizit auf die Variable und nicht auf den Debuggerbefehl zu verweisen. Beispielsweise kann es oft vorkommen, dass Sie den Variablennamen ' c ' für einen Zähler verwenden und Sie ihn möglicherweise im Debugger drucken möchten. Ein einfacher ' c' -Befehl würde die Ausführung bis zum nächsten Haltepunkt fortsetzen. Verwenden Sie stattdessen ' ! C ', um den Wert der Variablen wie folgt zu drucken:

(Pdb) !c
4

Über IPython und ipdb

Wenn IPython (oder Jupyter ) installiert ist, kann der Debugger folgendermaßen aufgerufen werden:

import ipdb
ipdb.set_trace()

Bei Erreichen wird der Code beendet und gedruckt:

 /home/usr/ook.py(3)<module>()
      1 import ipdb
      2 ipdb.set_trace()
----> 3 print("Hello world!")

ipdb>

Das bedeutet natürlich, dass man den Code bearbeiten muss. Es gibt einen einfacheren Weg:

from IPython.core import ultratb
sys.excepthook = ultratb.FormattedTB(mode='Verbose',
                                     color_scheme='Linux',
                                     call_pdb=1)

Dies bewirkt, dass der Debugger aufgerufen wird, wenn eine nicht erfasste Ausnahme ausgelöst wird.

Remote-Debugger

rpdb müssen Sie Python-Code debuggen, der von einem anderen Prozess ausgeführt wird. In diesem Fall ist rpdb .

rpdb ist ein Wrapper um pdb, der stdin und stdout zu einem Socket-Handler umleitet. Standardmäßig wird der Debugger an Port 4444 geöffnet

Verwendungszweck:

# In the Python file you want to debug.
import rpdb
rpdb.set_trace()

Und dann müssen Sie dies im Terminal ausführen, um eine Verbindung zu diesem Prozess herzustellen.

# Call in a terminal to see the output
$ nc 127.0.0.1 4444

Und du wirst pdb Promt bekommen

> /home/usr/ook.py(3)<module>()
-> print("Hello world!")
(Pdb)