ipython / ipython/ipython

New tutorial section: debugging with IPython

Open
#14,347 4 comments 1 reaction 0 assignees View on GitHub
Dominant language
Python
Stars
16.8k
Forks
4.5k
Avg merge
1d 2h
Merged PRs (30d)
6

Description

My colleague @lrcouto did some extensive research on debugging techniques for IPython and for now we've added those to the Kedro docs, but we wanted to ask if you'd accept a PR with a new section under "Tutorial" called "How to debug with IPython". Could include:

- `%debug` for interactive debugging
- `%pdb` for postmortem debugging
- `%run` for running specific files
- Some cool GIFs
- An (i)pdb cheatsheet:

| Command | Description |
| ----------------- | ----------------------------------------------------- |
| `list` | Show the current location in the file |
| `h(elp)` | Show a list of commands, or find help on a specific command |
| `q(uit)` | Quit the debugger and the program |
| `c(ontinue)` | Quit the debugger, continue in the program |
| `n(ext)` | Go to the next step of the program |
| `` | Repeat the previous command |
| `p(rint)` | Print variables |
| `s(tep)` | Step into a subroutine |
| `r(eturn)` | Return out of a subroutine |
| `b(reak)` | Insert a breakpoint |
| `a(rgs)` | Print the argument list of the current function |

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.