介绍了如何在程序代码中嵌入IPython用于调试，并分析了优点与不足

关于IPython使用的入门文章，主要介绍了如何在程序代码中嵌入ipython用于调试，并分析了优点与不足。

在 Python 中编程时，我会花费大量时间使用 IPython 及其强大的交互式提示，不仅用于一些一次性计算，还用于大量实际编程和调试。我特别将它用于一些探索性的编程，比如对一些不熟悉的 API，或者想知道程序在代码中特定位置的运行状态。

我不确定这种IPython调试的方法有多普遍，但我很少听到其他人谈论它，所以我认为它值得分享。

安装

使用前，需要将 IPython 安装到您当前的 virtualenv 中：

pip install ipython

使用方法

基本上有两种方法可以打开 IPython 提示符。

第一种是直接从终端运行它：

$ ipython
Python 3.9.5 (default, Jul  1 2021, 11:45:58)
Type 'copyright', 'credits' or 'license' for more information
IPython 8.3.0 -- An enhanced Interactive Python. Type '?' for help.

In [1]:

在 Django 项目中，如果您安装了 IPython，也可以使用 ./manage.py shell，好处是它会为帮您正确初始化 Django。

如果您想探索编写一些“顶级”代码，例如，在尚未创建入口点的情况下，编写一个新的功能，那么这种方法很管用。然而，我写的大部分代码都不是这样的。大多数时候，我发现自己需要写代码时，已经想好10层的函数调用了——比如：

  • 我正在一个Django应用程序中编写一些视图代码，其中有一个请求对象--如果你在IPython提示符下从头开始，你不可能轻易重新创建这个对象。
  • 或者，模型层代码，比如 save（） 方法内部的代码，该方法本身正在被您尚未编写的其他代码调用，比如Django admin或某个信号。
  • 或者，在一个测试中，设置代码已经创建了一大堆在打开IPython时不可用的东西。

对于这些情况，我使用第二种方法：

  • 找到我想要修改、探索或调试的代码。这通常是我自己的代码，但也可能是第三方库。我一直习惯在 virtualenv 中工作，所以即使使用第三方库，在我的编辑器中“go to definition”也会直接将我带到代码的可写副本的定义区（除了不是用 Python 编写的代码）。
  • 插入 IPython 提示的代码并保存文件：
import IPython; IPython.embed()

我将此绑定到编辑器中的一个功能键。
因此，如果它是Django视图，那么代码最终可能会是这样：

def contact_us(request):
    if request.method == "POST":
        form = ContactUsForm_class(request.POST)
        if form.is_valid():
            import IPython; IPython.embed()

        # …
  • 以适当的方式触发代码。对于上述情况，首先需要在终端中运行 Django 服务器，然后打开网页，填写表单并按下提交。对于测试，它将从终端运行特定的测试。对于命令行应用程序，它将直接运行应用程序。
  • 在终端中，我会发现自己现在已经在 IPython REPL 中，我可以继续：
  • 想出我需要写什么代码
  • 或者调试我感到困惑的代码

请注意，您可以在此 REPL 中编写和编辑多行代码——它不像编辑器那么舒服，但没关系，并且具有良好的历史记录支持。关于 IPython 及其更多特性，你可以在官方 文档 中了解它。

对于那些有其他语言背景的人来说，可能还值得指出的是，Python REPL 与普通 Python 并没有什么不同。你可以在普通 Python 中做的所有事情，比如定义函数和类，都可以在 REPL 中进行。

调试结束后，我可以将任何有用的片段从 REPL 复制回我的真实代码中，使用历史记录来查看我曾经输入的内容。

优点

这种方法的优点是：

  1. 当您实际拥有一个对象时，您可以更轻松地探索API和对象(APIs and objects)，而不是阅读关于对象的文档，或者编辑器的自动完成工具推断对象应该具有的内容。例如，Django的HttpRequest上有哪些属性和方法？你不必确保你有正确的类型注释，并且希望它们是完整的，或者假设值是什么——你已经有了对象，你可以检查它，用广泛的合适的制表符自动补全完成。你可以调用函数，看看它们是怎么做的。
    例如，Django的请求对象通常有一个用户(user)属性，该属性不属于HttpRequest定义的一部分，因为它是在以后添加的。但它在REPL中是可见的。
  2. 您可以直接探索程序的整体状态。这对于探索性编程和调试来说都是一个巨大的优势。
    对于调试，pdb 和类似的调试工具和环境通常会为您提供“the state of the system”，并且它们更擅长单步执行多层代码。但我经常发现 IPython 提示的功能和舒适性对于探索和寻找解决方案要好得多。

这种环境的感觉并不像Lisp中REPL驱动的编程那样流畅，但我仍然觉得它非常有趣和高效。与许多其他方法相比，比如迭代代码，然后进行手动或自动测试，它将反馈循环的延迟从几秒或几分钟减少到几毫秒，这是巨大的效率提升。

提示和不足

  • IPython 有很多很酷的特性可以在 REPL 环境中帮助你，比如 %autoreload 和许多其他很酷的魔法。你应该花时间去了解他们！
  • 在多线程（或多进程）环境中，IPython 提示表现不是很好。如果可能的话，关闭多线程，或者确保你没有遇到那个问题。
  • 如果您确实在终端中搞砸了，您可能需要手动找到要杀死的进程并在终端中进行重置。
  • 使用 Django 开发服务器：
  • 它默认是多线程的，所以要么确保你不会多次点击视图代码，要么使用 --nothreading。
  • 当心自动重新加载，如果你在启动时仍然处于 IPython 提示符中，它会搞砸你。要么使用 --noreload 要么确保在执行任何会触发重新加载的操作之前干净地退出 IPython。
  • 当心捕获标准输入/输出的环境，这会破坏这种功能。
  • pytest 默认捕获标准输入并破坏一些事物。您可以使用 -s 将其关闭。此外，如果您使用的是 pytest-xdist，您应该记得使用 -n0 来关闭多个进程。
  • 使用 IPython.embed() 时，由于 Python 的限制，存在一个烦人的错误，涉及闭包和未定义的名称。它经常在使用生成器表达式时出现，但在其他时候也是如此。它通常可以通过以下方式解决：
globals().update(locals())

参考链接

作者：皎然CEO