为什么我的Python代码在IPYNB中运行时会报IndentationError？

Question

在IPYNB（Jupyter Notebook）中运行Python代码时，如果遇到`IndentationError`，通常是由于代码块的缩进不一致或格式错误导致的。以下是一些常见原因：1) 混合使用空格和Tab键作为缩进，Python对两者区分严格；2) 复制粘贴代码时引入了不可见字符或格式错乱；3) 在不同单元格中定义和调用函数时，可能遗漏了必要的缩进部分；4) 使用自动格式化工具后破坏了原有的缩进结构。为避免此类问题，请确保在整个项目中统一使用空格（推荐4个空格为一级缩进）或Tab，并检查代码完整性，特别是在跨单元格操作时。此外，利用Jupyter内置的格式化功能或外部编辑器预览代码，有助于发现隐藏的缩进错误。

Answer 1

1. 问题概述：IndentationError的常见原因

在Jupyter Notebook中运行Python代码时，遇到`IndentationError`通常是因为代码块的缩进不一致或格式错误。以下是几个常见的原因：

• 混合使用空格和Tab键作为缩进，Python对两者区分严格。
• 复制粘贴代码时引入了不可见字符或格式错乱。
• 在不同单元格中定义和调用函数时，可能遗漏了必要的缩进部分。
• 使用自动格式化工具后破坏了原有的缩进结构。

为避免此类问题，请确保在整个项目中统一使用空格（推荐4个空格为一级缩进）或Tab，并检查代码完整性。

2. 解决方案：逐步排查与修复

以下是针对上述问题的具体解决方案：

1. 检查缩进一致性：确保代码中只使用空格或Tab键进行缩进，避免混用。可以通过IDE设置显示空白字符来检查。
2. 清理不可见字符：如果通过复制粘贴引入了特殊字符，可以尝试重新手动输入代码或使用文本编辑器的“清除格式”功能。
3. 跨单元格调试：在Jupyter Notebook中，确保函数定义和调用在逻辑上是完整的。例如，以下代码展示了如何正确定义和调用一个函数：

def example_function():
    print("Hello, World!")

example_function()
    

如果将函数定义和调用拆分到不同单元格中，需确保定义部分已成功执行。

3. 工具与技巧：优化代码格式

为了进一步减少`IndentationError`的发生，可以利用以下工具和技巧：

工具/技巧	描述
Jupyter内置格式化功能	使用快捷键如`Shift+Tab`查看代码提示，或通过扩展插件如`jupyter_contrib_nbextensions`启用格式化工具。
外部编辑器预览	将代码复制到支持语法高亮的编辑器（如VS Code、PyCharm）中，便于发现隐藏的缩进错误。
代码审查	定期对代码进行同行评审，尤其是多人协作项目中，确保团队成员遵循一致的代码风格。

4. 流程图：解决IndentationError的步骤

以下是解决`IndentationError`的流程图，帮助用户系统性地排查问题：

graph TD;
            A[遇到IndentationError] --> B{是否混用空格和Tab};
            B --是--> C[统一缩进方式];
            B --否--> D{是否有不可见字符};
            D --是--> E[清理特殊字符];
            D --否--> F{跨单元格逻辑是否完整};
            F --否--> G[检查函数定义与调用];
            F --是--> H[检查自动格式化工具影响];