Python Debugging Fundamentals

mage
Python DEBUGGING Fundamentals

Python Debugging Fundamentals
Saturday, October 20, 2012
PyCarolinas
UNC School of Pharmacy
Chapel Hill, NC
Chris Calloway
University of North Carolina
Department of Marine Sciences

Programming
PyCamp™ Copyright © 2012
Trizpug For The People

mage
What Is Debugging

A method for isolating
program errors

Programming

mage
What Is Debugging

• Execute program one statement at
a time
• Inspect the state of objects bound
to identiﬁers
• Lather, rinse, repeat

Programming

mage
pdb Module

Python's pdb module to
the rescue!

Programming

mage
Invoking Python's Debugger

$ python -m pdb fizzbuzz.py

Programming

mage

Run a module as a script


Programming

mage

Module to run
as a script

Programming

mage

Argument to pdb:
script to debug

Programming

mage

> /Users/cbc/pycarolinas/fizzbuzz.py(7)<module>()
-> """
(Pdb)

Programming

mage

-> """
(Pdb) Full path to script
being debugged

Programming

mage

-> """
(Pdb) Line number of next
statement to execute

Programming

mage

-> """
(Pdb) Type of object
last evaluated

Programming

mage

-> """
(Pdb)
Instruction pointer to
next statement to execute

Programming

mage

-> """
(Pdb)

Debugger prompt

Programming

mage
Python's Debugger Prompt

(Pdb) help

Documented commands (type help <topic>):
========================================
EOF cl disable interact next return u where
a clear display j p retval unalias
alias commands down jump pp run undisplay
args condition enable l print rv unt
b cont exit list q s until
break continue h ll quit source up
bt d help longlist r step w
c debug ignore n restart tbreak whatis

Miscellaneous help topics:
==========================
exec pdb

(Pdb)

Programming

mage

(Pdb) help list
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 . as argument, list 11 lines around the current
line. With one argument, list 11 lines starting at that line.
With two arguments, list the given range; if the second
argument is less than the first, it is a count.

The current line in the current frame is indicated by "->".
If an exception is being debugged, the line where the
exception was originally raised or propagated is indicated by
">>", if it differs from the current line.
(Pdb)

Programming

mage

(Pdb) h l
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 . as argument, list 11 lines around the current
line. With one argument, list 11 lines starting at that line.
With two arguments, list the given range; if the second
argument is less than the first, it is a count.

The current line in the current frame is indicated by "->".
If an exception is being debugged, the line where the
exception was originally raised or propagated is indicated by
">>", if it differs from the current line.
(Pdb)

Programming

mage

(Pdb) l
2 Generate the first n Fizz Buzz answers.
3
4 Usage:
5
6 > python fizzbuzz.py n
7 -> """
8
9 import sys
10
11 def fizzbuzz(n):
12 """
(Pdb)

Programming

mage

(Pdb) l 6
1 """
3
4 Usage:
5
7 -> """
8
9 import sys
10
11 def fizzbuzz(n):
(Pdb)

Programming

mage

(Pdb) l .
3
4 Usage:
5
7 -> """
8
9 import sys
10
11 def fizzbuzz(n):
12 """
(Pdb)

Programming

mage

(Pdb) 3 ** (1 / 2)
1.7320508075688772
(Pdb) dir()
['__builtins__', '__file__', '__name__']
(Pdb) print(__name__)
'__main__'
(Pdb)

Programming

mage

(Pdb) !list
<class 'list'>
(Pdb)

Programming

mage
Single Stepping

(Pdb) s
-> import sys
(Pdb)

Programming

mage
Single Stepping

(Pdb) l
4 Usage:
5
7 """
8
9 -> import sys
10
11 def fizzbuzz(n):
12 """
13 fizzbuzz(n) -> [first n Fizz Buzz answers]
14 """
(Pdb)

Programming

mage
Single Stepping

(Pdb) dir()
['__builtins__', '__doc__', '__file__', '__name__']
(Pdb) !print(__doc__)

Generate the first n Fizz Buzz answers.

Usage:

> python fizzbuzz.py n

(Pdb)

Programming

mage
Single Stepping

(Pdb) s
-> def fizzbuzz(n):
(Pdb) dir()
['__builtins__', '__doc__', '__file__', '__name__', 'sys']
(Pdb)

Programming

mage
Single Stepping

(Pdb) l
7 """
8
9 import sys
10
11 -> def fizzbuzz(n):
12 """
14 """
15
16 answers = []
(Pdb)

Programming

mage
Single Stepping

(Pdb) l
17 for x in range(1,n+1):
18 answer = ""
19 if not x%3:
20 answer += "Fizz"
21 if not x%5:
22 answer += "Buzz"
23 if not answer:
24 answer = x
25 answers.append(answer)
26 return answers
27
(Pdb)

Programming

mage
Single Stepping

(Pdb) l .
7 """
8
9 import sys
10
12 """
14 """
15
16 answers = []
(Pdb)

Programming

mage
Single Stepping

(Pdb) s
-> if __name__ == '__main__':
(Pdb) dir()
['__builtins__', '__doc__', '__file__',
'__name__', 'fizzbuzz', 'sys']
(Pdb)

Programming

mage
Single Stepping

(Pdb) l
23 if not answer:
24 answer = x
26 return answers
27
28 -> if __name__ == '__main__':
29 try:
30 if len(sys.argv) != 2:
31 raise ValueError("Incorrect number of arguments")
32 answers = fizzbuzz(int(sys.argv[1]))
33 print(" ".join([str(answer) for answer in answers]))
(Pdb)

Programming

mage
Single Stepping

(Pdb) s
-> try:
(Pdb) s
-> if len(sys.argv) != 2:
(Pdb) s
-> raise ValueError("Incorrect number of arguments")
(Pdb) s
ValueError: Incorrect number of arguments
(Pdb)

Programming

mage
Single Stepping

(Pdb) s
-> except:
(Pdb) s
-> print(__doc__)
(Pdb)

Programming

mage
Single Stepping

(Pdb) s

Generate the first n Fizz Buzz answers.

Usage:

> python fizzbuzz.py n

--Return--
> /Users/cbc/pycarolinas/fizzbuzz.py(35)<module>()->None
-> print(__doc__)
(Pdb)

Programming

mage
Single Stepping

(Pdb) s
--Return--
> <string>(1)<module>()->None
(Pdb) l
[EOF]
(Pdb)

Programming

mage
Single Stepping

(Pdb) s
> /opt/python330/lib/python3.3/bdb.py(409)run()
-> self.quitting = True
(Pdb) s
The program finished and will be restarted
-> """
(Pdb) dir()
['__builtins__', '__file__', '__name__']
(Pdb)

Programming

mage
Single Stepping

(Pdb) q
$

Programming

mage

$ python -m pdb fizzbuzz.py 100

Programming

mage

$ python -m pdb fizzbuzz.py 100
-> """
(Pdb)

Programming

mage

(Pdb) l
14 """
15
16 answers = []
18 answer = ""
19 if not x%3:
20 answer += "Fizz"
21 if not x%5:
22 answer += "Buzz"
23 if not answer:
(Pdb)

Programming

mage

(Pdb) l
24 answer = x
26 return answers
27
28 if __name__ == '__main__':
29 try:
30 if len(sys.argv) != 2:
34 except:
(Pdb)

Programming

mage
Setting a Breakpoint

(Pdb) b 30
Breakpoint 1 at /Users/cbc/pycarolinas/fizzbuzz.py:30
(Pdb) l 30
26 return answers
27
28 if __name__ == '__main__':
29 try:
30 B if len(sys.argv) != 2:
34 except:
35 print(__doc__)
(Pdb)

Programming

mage

(Pdb) l .
3
4 Usage:
5
7 -> """
8
9 import sys
10
11 def fizzbuzz(n):
12 """
(Pdb)

Programming

mage

(Pdb) c
(Pdb) l
26 return answers
27
28 if __name__ == '__main__':
29 try:
30 B-> if len(sys.argv) != 2:
34 except:
35 print(__doc__)
(Pdb)

Programming

mage
Stepping Into a Function

(Pdb) len(sys.argv)
2
(Pdb) s
-> answers = fizzbuzz(int(sys.argv[1]))
(Pdb)

Programming

mage

(Pdb) s
--Call--
> /Users/cbc/pycarolinas/fizzbuzz.py(11)fizzbuzz()
-> def fizzbuzz(n):
(Pdb) l
7 """
8
9 import sys
10
12 """
14 """
15
16 answers = []
(Pdb)

Programming

mage

(Pdb) p n
100
(Pdb) s
-> answers = []
(Pdb) s
-> for x in range(1,n+1):
(Pdb) s
-> answer = ""
(Pdb)

Programming

mage

(Pdb) l
14 """
15
16 answers = []
18 -> answer = ""
19 if not x%3:
20 answer += "Fizz"
21 if not x%5:
22 answer += "Buzz"
23 if not answer:
(Pdb)

Programming

mage

(Pdb) dir()
['answers', 'n', 'x']
(Pdb) where
/opt/python330/lib/python3.3/bdb.py(405)run()
-> exec(cmd, globals, locals)
<string>(1)<module>()
/Users/cbc/pycarolinas/fizzbuzz.py(32)<module>()
-> answer = ""
(Pdb)

Programming

mage
Stack Frames

(Pdb) up
(Pdb) dir()
['__builtins__', '__doc__', '__file__',
'__name__', 'fizzbuzz', 'sys']
(Pdb) down
-> answer = ""
(Pdb) down
*** Newest frame
(Pdb)

Programming

mage

(Pdb) c
1 2 Fizz 4 Buzz Fizz 7 8 Fizz Buzz 11 Fizz 13 14 FizzBuzz 16 17
Fizz 19 Buzz Fizz 22 23 Fizz Buzz 26 Fizz 28 29 FizzBuzz 31 32
Fizz 94 Buzz Fizz 97 98 Fizz Buzz
-> """
(Pdb)

Programming

mage
Listing Breakpoints

(Pdb) b
Num Type Disp Enb Where
1 breakpoint keep yes at /Users/cbc/pycarolinas/fizzbuzz.py:30
breakpoint already hit 1 time
(Pdb) c
(Pdb) s
(Pdb)

Programming

mage
Stepping Over a Function

(Pdb) n
-> print(" ".join([str(answer) for answer in answers]))
(Pdb) pp answers
[1,
2,
'Fizz',
...
98,
'Fizz',
'Buzz']
(Pdb)

Programming

mage

(Pdb) c
1 2 Fizz 4 Buzz Fizz 7 8 Fizz Buzz 11 Fizz 13 14 FizzBuzz 16 17
Fizz 94 Buzz Fizz 97 98 Fizz Buzz
-> """
(Pdb)

Programming

mage

(Pdb) c
(Pdb) b
Num Type Disp Enb Where
1 breakpoint keep yes at /Users/cbc/pycarolinas/fizzbuzz.py:30
breakpoint already hit 3 times
(Pdb) s
(Pdb)

Programming

mage

(Pdb) s
--Call--
-> def fizzbuzz(n):
(Pdb) s
-> answers = []
(Pdb) s
-> for x in range(1,n+1):
(Pdb) s
-> answer = ""
(Pdb)

Programming

mage

(Pdb) r
--Return--
> /Users/cbc/pycarolinas/fizzbuzz.py(26)fizzbuzz()->
[1, 2, 'Fizz', 4, 'Buzz', 'Fizz', ...]
-> return answers
(Pdb)

Programming

mage
Stepping Over a List Comprehension

(Pdb) s
(Pdb) s
--Call--
> /Users/cbc/pycarolinas/fizzbuzz.py(33)<listcomp>()
(Pdb) s
> /Users/cbc/pycarolinas/fizzbuzz.py(33)<listcomp>()
(Pdb)

Programming

mage
Stepping Over a List Comprehension

(Pdb) r
--Return--
> /Users/cbc/pycarolinas/fizzbuzz.py(33)<listcomp>()->
['1', '2', 'Fizz', '4', 'Buzz', 'Fizz', ...]
(Pdb)

Programming

mage
Clear Breakpoints

(Pdb) h clear
cl(ear) filename:lineno
cl(ear) [bpnumber [bpnumber...]]
With a space separated list of breakpoint numbers, clear
those breakpoints. Without argument, clear all breaks (but
first ask confirmation). With a filename:lineno argument,
clear all breaks at that line in that file.
(Pdb)

Programming

mage
Disable Breakpoints

(Pdb) h disable
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.
(Pdb)

Programming

mage
Enable Breakpoints

(Pdb) h enable
enable bpnumber [bpnumber ...]
Enables the breakpoints given as a space separated list of
breakpoint numbers.
(Pdb)

Programming

mage
Monitor Objects for Changes

(Pdb) h display
display [expression]

Display the value of the expression if it changed, each time execution
stops in the current frame.

Without expression, list all display expressions for the current frame.
(Pdb)

Programming

mage
Conditional Breakpoints

(Pdb) h condition
condition bpnumber [condition]
Set a new condition for the breakpoint, 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.
(Pdb)

Programming

mage
Skip Over Breakpoints

(Pdb) h ignore
ignore bpnumber [count]
Set 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.
(Pdb)

Programming

mage
Debugger Macros

(Pdb) help alias
alias [name [command [parameter parameter ...] ]]
Create 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 name is given, all
aliases are listed.

Programming

mage
One Time Breakpoints

(Pdb) h tbreak
tbreak [ ([filename:]lineno | function) [, condition] ]
Same arguments as break, but sets a temporary breakpoint: it
is automatically deleted when first hit.
(Pdb)

Programming

mage
What Is Debugging

• Execute entire program one step at
the time
• Execute only suspect portions of
program
• Isolate suspect portions of program

Programming

mage
Setting a Trace

if __name__ == '__main__':
try:
if len(sys.argv) != 2:
import pdb; pdb.set_trace()
raise ValueError("Incorrect number of arguments")
answers = fizzbuzz(int(sys.argv[1]))
print(" ".join([str(answer) for answer in answers]))
except:
print(__doc__)

Programming

mage
Setting a Trace

$ python fizzbuzzNG.py
> /Users/cbc/pycarolinas/fizzbuzzNG.py(32)<module>()
(Pdb)

Programming

mage
Post-mortem Debugging

if __name__ == '__main__':
if len(sys.argv) != 2:
answers = fizzbuzz(int(sys.argv[1]))
print(" ".join([str(answer) for answer in answers]))

Programming

mage

$ python -i fizzbuzzNG2.py
Traceback (most recent call last):
File "fizzbuzzNG2.py", line 30, in <module>
ValueError: Incorrect number of arguments
>>>

Programming

mage

>>> import pdb; pdb.pm()
> /Users/cbc/pycarolinas/fizzbuzzNG2.py(30)<module>()
(Pdb)

Programming

mage
Debugger Runner

>>> import fizzbuzz
>>> import pdb
>>> pdb.run('fizzbuzz.fizzbuzz(100)')
> <string>(1)<module>()
(Pdb) s
--Call--
-> def fizzbuzz(n):
(Pdb)

Programming

mage
Python DEBUGGING Fundamentals

Questions?
cbc@chriscalloway.org
http://drunkenpython.org/pycarolinas.zip
http://docs.python.org/py3k/library/pdb.html#module-pdb

Programming

Python Debugging Fundamentals

More Related Content

What's hot (20)

Viewers also liked (8)

Similar to Python Debugging Fundamentals (20)

Python Debugging Fundamentals