IPython help functionality in ipdb debugger

Question

Help is available in a standard IPython shell via the help command or by using the ? character. For example, for help on the built-in sum function, either of the below commands in an IPython shell could be used.

In [1]: help(sum)
Help on built-in function sum in module builtin:
...

In [2]: sum?
Signature: sum(iterable, start=0, /)
Docstring: ...

I want to have the same functionality in an ipdb debugger. One enters an ipdb debugger by placing the below code at the location for a debug breakpoint.

from ipdb import set_trace
set_trace()

However, once inside the ipdb debugger the Help functions no longer work.

ipdb> help(sum)
*** No help for '(sum)'
ipdb> sum?
*** SyntaxError: invalid syntax
ipdb>

Help in IPython shell and ipdb debugger

The below command represents a way to print a docstring inside the ipdb debugger, however this is not exactly the same functionality as help(sum) and sum? in the IPython shell.

ipdb> print(sum.__doc__)

How then do I get the same help functionality in an ipdb debugger that exists in the IPython shell?

Interesting that you don't get help, as that's a python builtin. — Wayne Werner
– Wayne Werner, Commented Nov 8, 2016 at 5:53

Wayne Werner · Accepted Answer · 2016-11-08 05:55:48Z

12

It looks like you can preface it with a ! (which is short for exec)

ipdb> !help(sum)
Help on built-in function sum in module builtins:

sum(iterable, start=0, /)
    Return the sum of a 'start' value (default: 0) plus an iterable of numbers

    When the iterable is empty, return the start value.
    This function is intended specifically for use with numeric values and may
    reject non-numeric types.
(END)

answered Nov 8, 2016 at 5:55

Wayne Werner

52.3k35 gold badges213 silver badges304 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

IPython help functionality in ipdb debugger

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related