使用IPython作为有效的调试器

Question

如何在代码中嵌入IPython shell，并让它自动显示调用它的行号和函数？

我目前有以下设置可以在代码中嵌入IPython shell：

from IPython.frontend.terminal.embed import InteractiveShellEmbed
from IPython.config.loader import Config

# Configure the prompt so that I know I am in a nested (embedded) shell
cfg = Config()
prompt_config = cfg.PromptManager
prompt_config.in_template = 'N.In <\\#>: '
prompt_config.in2_template = '   .\\D.: '
prompt_config.out_template = 'N.Out<\\#>: '

# Messages displayed when I drop into and exit the shell.
banner_msg = ("\n**Nested Interpreter:\n"
"Hit Ctrl-D to exit interpreter and continue program.\n"
"Note that if you use %kill_embedded, you can fully deactivate\n"
"This embedded instance so it will never turn on again")   
exit_msg = '**Leaving Nested interpreter'

# Put ipshell() anywhere in your code where you want it to open.
ipshell = InteractiveShellEmbed(config=cfg, banner1=banner_msg, exit_msg=exit_msg)

这允许我只需使用ipshell()就可以在代码的任何地方启动完整的IPython shell。例如，以下代码：

a = 2
b = a
ipshell()

frameinfo = getframeinfo(currentframe())
print 'Stopped at: ' + frameinfo.filename + ' ' +  str(frameinfo.lineno)

Answer 1

您可以从另一个用户定义函数中调用ipshell()，例如ipsh()

from inspect import currentframe

def ipsh():
    frame = currentframe().f_back
    msg = 'Stopped at {0.f_code.co_filename} and line {0.f_lineno}'.format(frame)
    ipshell(msg,stack_depth=2) # Go back one level!

然后，只要您想放入IPython shell，就使用ipsh()。

• stack_depth=2在检索新的IPython shell的命名空间时要求ipshell上升一个级别（默认值为1)。
• currentframe().f_back()检索前一个框架，以便打印调用ipsh()的位置的行号和文件。