出现异常时启动 IPython shell

Question

当我的程序运行引发异常的行时，有没有办法启动 IPython shell 或提示？

我最感兴趣的是引发异常的上下文、变量和范围（和子范围）。就像 Visual Studio 的调试一样，当抛出异常但没有被任何人捕获时，Visual Studio 将停止并为我提供调用堆栈和每个级别上存在的变量。

您认为有没有办法使用 IPython 获得类似的东西？

编辑：启动IPython时的-pdb选项似乎没有达到我想要的效果（或者也许我不知道如何正确使用它，这是完全可能的） 。我运行以下脚本：

def func():
    z = 2
    g = 'b'
    raise NameError("This error will not be caught, but IPython still"
                    "won't summon pdb, and I won't be able to consult"
                    "the z or g variables.")

x = 1
y = 'a'

func()

使用命令 :

ipython -pdb exceptionTest.py

在引发错误时停止执行，但会显示 IPython 提示，在其中我可以访问脚本的全局变量，但不能访问函数 func 的局部变量。 pdb 仅当我直接在 ipython 中键入导致错误的命令时才被调用，即 raise NameError("This, sent from the IPython Prompt, will tr​​igger pdb.") 。

我不一定需要使用 pdb，我只是想访问 func 内的变量。

编辑2：已经有一段时间了，IPython的-pdb选项现在可以按照我想要的方式工作了。这意味着当我引发异常时，我可以返回到 func 的范围并读取其变量 z 和 g ，没有任何问题。即使不设置 -pdb 选项，也可以在交互模式下运行 IPython，然后在程序因错误退出后调用神奇函数 %debug ——这也会让你失望进入交互式 ipdb 提示符，所有范围均可访问。

Answer 1

IPython v0.13：

import sys
from IPython.core import ultratb
sys.excepthook = ultratb.FormattedTB(mode='Verbose',
     color_scheme='Linux', call_pdb=1)

Answer 2

做法：

ipython --pdb -c "%run exceptionTest.py"

在 IPython 初始化后启动脚本，然后进入正常的 IPython+pdb 环境。

Answer 3

你可以试试这个：

from ipdb import launch_ipdb_on_exception

def main():
    with launch_ipdb_on_exception():
        # The rest of the code goes here.
        [...]

Answer 4

ipdb 将 IPython 功能集成到 pdb 中。在发生未经处理的异常后，我使用以下代码将我的应用程序放入 IPython 调试器中。

import sys, ipdb, traceback

def info(type, value, tb):
    traceback.print_exception(type, value, tb)
    ipdb.pm()

sys.excepthook = info

Answer 5

@snapshoe 的答案不适用于较新版本的 IPython。

然而，这确实：

import sys 
from IPython import embed

def excepthook(type, value, traceback):
    embed()

sys.excepthook = excepthook

Answer 6

@Adam 的工作就像一个魅力，除了 IPython 加载有点慢（在我的机器上 800 毫秒）。这里我有一个技巧可以让负载变得懒惰。

class ExceptionHook:
    instance = None

    def __call__(self, *args, **kwargs):
        if self.instance is None:
            from IPython.core import ultratb
            self.instance = ultratb.FormattedTB(mode='Verbose',
                 color_scheme='Linux', call_pdb=1)
        return self.instance(*args, **kwargs)
sys.excepthook = ExceptionHook()

现在我们不需要在一开始就等待。只有当程序崩溃时才会导致IPython被导入。

Answer 7

您可以执行类似以下操作：

import sys
from IPython.Shell import IPShellEmbed
ipshell = IPShellEmbed()

def excepthook(type, value, traceback):
    ipshell()

sys.excepthook = excepthook

请参阅 sys.excepthook 和 < a href="http://ipython.readthedocs.io/en/stable/interactive/reference.html#embedding" rel="nofollow noreferrer">嵌入 IPython。

Answer 8

这个 手册页 说 iPython 有 --[ no]pdb 选项在命令行中传递以启动 iPython 以处理未捕获的异常。您在寻找更多吗？

编辑：
python -m pdb pythonscript.py 可以启动pdb。但不确定 iPython 是否有类似的情况。如果您正在寻找程序异常退出的堆栈跟踪和一般事后分析，这应该可行。

Answer 9

如果您想要获取回溯并使用异常点处的环境打开 IPython shell：

def exceptHook(*args):
    '''A routine to be called when an exception occurs. It prints the traceback
    with fancy formatting and then calls an IPython shell with the environment
    of the exception location.
    '''
    from IPython.core import ultratb
    ultratb.FormattedTB(call_pdb=False,color_scheme='LightBG')(*args)
    from IPython.terminal.embed import InteractiveShellEmbed
    import inspect
    frame = inspect.getinnerframes(args[2])[-1][0]
    msg   = 'Entering IPython console at {0.f_code.co_filename} at line {0.f_lineno}'.format(frame)
    savehook = sys.excepthook # save the exception hook
    InteractiveShellEmbed()(msg,local_ns=frame.f_locals,global_ns=frame.f_globals)
    sys.excepthook = savehook # reset IPython's change to the exception hook

import sys
sys.excepthook = exceptHook

请注意，有必要从回溯 (arg[2]) 引用的最后一帧中提取命名空间信息

(12/ 23) 上述代码需要更改以匹配最新版本的 IPython。下面是我现在在 exceptHook 函数中使用的内容。我已经在 IPython 8.x 和 7.x 上尝试过，它可能适用于更旧的版本，但尚未经过测试。

try: 
    from IPython.terminal.embed import InteractiveShellEmbed
    import IPython.core
    if sys.platform.startswith('win'):
        IPython.core.ultratb.FormattedTB(
           call_pdb=False,color_scheme='NoColor')(*args)
    else:
        IPython.core.ultratb.FormattedTB(
           call_pdb=False,color_scheme='LightBG')(*args)
    from IPython.core import getipython
    if getipython.get_ipython() is None:
        ipshell = InteractiveShellEmbed.instance()
    else:
        ipshell = InteractiveShellEmbed()
except ImportError:
    print ('IPython not found or really old')
    return

import inspect
frame = inspect.getinnerframes(args[2])[-1][0]
msg   = 'Entering IPython console at {0.f_code.co_filename} at line {0.f_lineno}\n'.format(frame)
savehook = sys.excepthook # save the exception hook
try:
    ipshell(msg,local_ns=frame.f_locals,global_ns=frame.f_globals) # newest (IPython >= 8)
except DeprecationWarning: # IPython <=7
    try: # IPython >=5
        class c(object): pass
        pseudomod = c() # create something that acts like a module
        pseudomod.__dict__ = frame.f_locals
        InteractiveShellEmbed(banner1=msg)(module=pseudomod,global_ns=frame.f_globals)
    except: # 'IPython <5
        InteractiveShellEmbed(banner1=msg)(local_ns=frame.f_locals,global_ns=frame.f_globals)
sys.excepthook = savehook # reset IPython's change to the exception hook

Answer 10

你真的想在每个异常点打开一个 pdb 会话吗？ （因为我认为从 ipython 打开的 pdb 会话与在普通 shell 中打开的 pdb 会话相同）。如果是这样的话，技巧如下：
http://code.activestate.com/食谱/65287-出现异常时自动启动调试器/