classification
Title: pdb doc: Explain how to extend debugger instead of sending readers to the source
Type: enhancement Stage:
Components: Documentation, Library (Lib) Versions: Python 3.10, Python 3.9, Python 3.8
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: docs@python, eric.araujo, orsenthil, rhettinger, techtonik
Priority: normal Keywords:

Created on 2012-06-01 13:03 by techtonik, last changed 2020-10-22 18:49 by iritkatriel.

Messages (5)
msg162074 - (view) Author: anatoly techtonik (techtonik) Date: 2012-06-01 13:03
http://docs.python.org/library/pdb.html#pdb.Pdb

Documentation for pdb says: "The debugger is extensible — it is actually defined as the class Pdb. This is currently undocumented but easily understood by reading the source."

There should a link to the source.
msg162089 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2012-06-01 18:03
Sounds good to me.  Raymond, do you concur?
msg164063 - (view) Author: Senthil Kumaran (orsenthil) * (Python committer) Date: 2012-06-26 10:31
Adding link to pdb source may be not be suitable. Readers may require to understand the states which pdb goes through. Docs here are better, IMO. -1 vote from me.
msg164066 - (view) Author: anatoly techtonik (techtonik) Date: 2012-06-26 11:45
I agree that reading the source doesn't make it clear how to extend or use PDB, so I've changed the title. High level overview is required.

I think an example would really help there. For instance a simple execution scroller - analogue of `python -m trace --trace <filename.py>`, but with PDB and play/pause buttons controlled from external script.
msg184962 - (view) Author: anatoly techtonik (techtonik) Date: 2013-03-22 11:44
A minimal example of debugger is needed, with the explanation how frame.f_trace is used by debuggers.
History
Date User Action Args
2020-10-22 18:49:43iritkatrielsettype: enhancement
versions: + Python 3.8, Python 3.9, Python 3.10, - Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5
2013-03-22 11:44:12techtoniksetmessages: + msg184962
versions: + Python 3.4, Python 3.5
2012-06-26 11:45:19techtoniksetmessages: + msg164066
title: pdb doc: Add link to source -> pdb doc: Explain how to extend debugger instead of sending readers to the source
2012-06-26 10:31:13orsenthilsetnosy: + orsenthil
messages: + msg164063
2012-06-01 18:03:50eric.araujosetnosy: + rhettinger, eric.araujo
title: pdb: Link to source -> pdb doc: Add link to source
messages: + msg162089

versions: + Python 2.7, Python 3.2, Python 3.3
2012-06-01 13:03:25techtonikcreate