### 如何在 Jupyter Notebooks 中调试 Python 代码的最佳实践 #### 使用内置的 IPython 调试功能 Jupyter Notebook 基于 IPython 内核构建，因此可以直接利用 IPython 提供的强大调试工具。可以通过 `%debug` Magic 命令启动交互式调试器，在程序抛出异常时进入调试模式[^2]。 ```python def divide(a, b): return a / b divide(10, 0) %debug ``` 上述代码会在 `ZeroDivisionError` 发生时自动打开调试环境，允许用户检查变量状态、回溯调用栈等操作。 --- #### 利用断点调试 (Breakpoints) 现代版本的 JupyterLab 提供了一个专门的调试扩展，支持设置断点、单步执行等功能。此功能通过与内核通信实现完整的调试流程，包括但不限于断点管理、堆栈跟踪和变量监控[^4]。 以下是具体的操作方法： 1. 安装并启用 JupyterLab 的调试插件。 ```bash pip install jupyterlab-debugger jupyter serverextension enable --py jupyterlab_debugger ``` 2. 在目标代码行左侧点击以设置断点。 3. 启动调试会话后，代码将在指定位置暂停，允许实时查看变量值和调用堆栈。 --- #### 编写可测试的代码结构 尽管 Jupyter Notebook 主要用于快速原型设计和数据探索，但在实际工作中，往往需要将其中的部分逻辑转化为更正式化的脚本或模块化组件。为了提高代码质量，建议引入单元测试机制来验证 notebook 中的关键部分[^3]。 一种常见做法是将核心业务逻辑提取至独立函数或类定义中，并借助第三方库（如 pytest）对其进行自动化测试： ```python # 将计算逻辑封装为函数 def calculate_area(radius): import math return math.pi * radius ** 2 # 测试该函数的行为是否符合预期 import unittest class TestCalculateArea(unittest.TestCase): def test_positive_radius(self): self.assertAlmostEqual(calculate_area(1), 3.14159) unittest.main(argv=[''], exit=False) ``` 这样不仅能够增强代码复用性和可靠性，还方便后续维护工作。 --- #### 结合日志记录优化排查过程 除了传统的调试手段外，适当增加日志输出也是一种有效的辅助方式。特别是在处理大规模数据集或长时间运行的任务时，适时打印中间结果有助于及时发现问题所在。 推荐使用标准库 logging 模块替代简单的 print() 函数完成这一目的： ```python import logging logging.basicConfig(level=logging.INFO) def process_data(data): logging.info(f"Processing {len(data)} items...") processed = [item.upper() for item in data] logging.info("Data processing completed.") return processed process_data(['apple', 'banana']) ``` 以上片段展示了如何配置基本的日志级别以及向控制台发送消息的方法。 ---