rich: [BUG] pdb/breakpoint() isn't very usable during progress

Describe the bug When calling breakpoint() during progress, the pdb prompt doesn’t echo typed characters. Thus, it’s not really possible to debug anything in the code running while progress is shown.

I suppose rich could set sys.breakpointhook to first get the terminal out of raw mode when breakpoint() is used?

(This is probably somewhere between bug report and feature request)

To Reproduce

import time
import rich.progress

for n in rich.progress.track(range(5)):
    time.sleep(0.5)
    if n == 3:
        breakpoint()

Platform Arch Linux, Kitty

Diagnose See #1052.

About this issue

  • Original URL
  • State: closed
  • Created 6 years ago
  • Reactions: 8
  • Comments: 17 (6 by maintainers)

Most upvoted comments

Could this be reopened? This is a complete dealbreaker if you use breakpoint()

I do not believe this issue can be marked as resolved. Currently, rich.progress influences the debugging process of the user codebase.

With a custom breakpoint hook, the user would expect the trace to be set at frame sys._getframe().f_back. Using a wrong frame will cause great confusion for the user. Thus it is impossible to override sys.breakpointhook while respecting what is already there, because what’s already there may not take in a frame as input – even pdb.set_trace does not. The only way is to do it is to disrespect what’s already there, and use:

pdb.Pdb(sys._getframe().f_back).set_trace()

It is a tough ask to expect each rich user to know how to do this correctly.

A solution that works for ninnies like me is using a pipe when debugging instead of fiddling with the rich.progress.Progress code or environment variables. Since Rich detects the pipe, it omits all the eye candy and at least pdb.set_trace() works like a charm. Conveniently, you get a free log on top if you pipe to tee instead of cat/tail.

my_cli_tool_with_rich buggy_command --some param | tee output.log

as far as I know every rich construct accepts a Console, and something like the original statement of rich.progress.track is just a shorthand for rich.progress.Progress().track, where Progress accepts a console, and would otherwise be using a default console.

I’d guess that setting TERM=dumb environment variable would have the same effect, if your code wouldn’t be amenable to threading Console objects around.

Either way, its essentially just forcing rich to act as it would inside a pipe or whatever where it wont output its fancy control codes. Which obviously isn’t helpful if you’re debugging rich output, but my own purposes were debugging my own code which just happened to be running in a context where rich was causing the described issues. And my guess would be most of the time/people in this thread are in the same boat.

@jacobian Only thing that occurs to me is to disable the refresh thread if the debugger is active. That’s probably good enough, assuming you didn’t want to debug the progress bars themselves.

Perhaps as a compromise, there should be a manual escape hatch? If I could blindly type rich.reset() or whatever and then go on with debugging, I suppose that’d work - though it’s not particularly discoverable, I guess.