python / python/cpython

Add advanced debugging examples to pdb documentation

Open
#119,579 4 comments 2 reactions 1 assignee View on GitHub

@gaogaotiantian is already working on this.

Since May 26, 2024.

docs
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

Documentation

With gh-90095 being closed out by #116660, I believe a section on Advanced Usage of the pdb module would be beneficial. While the current documentation for pdb does discuss the use of .pdbrc file, it does not provide many examples of what is capable, these capabilities are mostly inferred. In fact a googling of ".pdbrc python" provides a few SO posts 1 2 asking how to set commands in .pdbrc with no real explanation. Additionally I only find 2 real webpages 3 4 that discuss at length the use of .pdbrc and it is mostly for defining aliases.

This Advanced Usage section would demonstrate how to set breakpoints and issue commands to those breakpoints from within the .pdbrc file as an alternative to placing inline breakpoint() and print() calls for debugging purposes.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.