使用IPython作为有效的调试器

时间:2013-03-27 20:51:02

标签: python ipython

如何在我的代码中嵌入一个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()

在调用者范围内启动一个IPython shell,允许我检查ab的值。

我想做的是在我致电ipshell()自动运行以下代码:

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

这将始终显示IPython shell启动的上下文,以便我知道正在调试的文件/函数等。

也许我可以用装饰器做到这一点,但到目前为止我的所有尝试都失败了,因为我需要ipshell()在原始上下文中运行 (这样我才能访问{来自IPython shell的{1}}和a

我该如何做到这一点?

1 个答案:

答案 0 :(得分:5)

您可以在其他用户定义的功能中调用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要求ipshell在检索新IPython shell的命名空间时上升一级(默认为1)。
  • currentframe().f_back()检索上一帧,以便您可以打印调用ipsh()的位置的行号和文件。