如何在Jupyter Notebook中打开并运行.py文件？

Question

如何在Jupyter Notebook中直接打开并运行 `.py` 文件？许多用户习惯于在Jupyter中编写和运行 `.ipynb` 文件，但面对已有的 `.py` 脚本时，不清楚如何高效导入和执行。常见问题包括：是否需要转换文件格式？能否在Notebook单元格中直接运行 `.py` 文件内容？如何保留变量状态和函数定义？此外，使用 `%run` 魔法命令时路径错误或编码问题也常导致执行失败。本文将详解多种方法，如通过 `%%writefile` 写入、`%load` 加载代码、`%run` 执行脚本等，帮助用户无缝集成Python脚本与Jupyter环境。

Answer 1

1. Jupyter Notebook 与 .py 文件的集成背景

Jupyter Notebook 是数据科学、机器学习和工程开发中广泛使用的交互式计算环境。尽管其原生格式为 .ipynb，但开发者在日常工作中常需处理已有的 .py 脚本文件。这些脚本可能来自团队共享库、遗留系统或自动化任务。直接在 Notebook 中运行这些脚本，既能保留上下文状态，又能利用交互式调试优势。

2. 是否需要转换 .py 文件为 .ipynb？

• 无需强制转换：Jupyter 支持直接读取和执行 .py 文件内容，无需手动转为 .ipynb 格式。
• 转换工具存在（如 jupytext），可用于双向同步，但非必要步骤。
• 保持 .py 原始格式有助于版本控制与 CI/CD 集成。

3. 方法一：%load 魔法命令加载代码到单元格

使用 %load 可将外部 .py 文件内容载入当前单元格，便于查看、修改和分步执行。

%load my_script.py

执行后，该单元格将填充 my_script.py 的全部源码，用户可编辑并逐行运行。适合用于学习或重构已有脚本。

4. 方法二：%run 执行外部脚本并保留命名空间

%run 是最核心的执行机制，支持跨文件运行且默认共享全局变量空间。

语法	说明
%run script.py	执行同目录下的脚本
%run ./subdir/script.py	相对路径执行
%run -i script.py	以当前 IPython 命名空间运行（增强变量共享）
%run -t script.py	带时间统计执行

5. 常见问题与调试策略

1. 路径错误：确保使用正确路径，推荐通过 os.getcwd() 和 !ls 检查当前位置。
2. 编码问题：若脚本含中文注释，应保存为 UTF-8 编码，避免 UnicodeDecodeError。
3. 模块导入失败：检查 sys.path 是否包含目标模块路径，必要时添加：
   import sys; sys.path.append('../modules')
4. 变量隔离：%run 默认共享命名空间，但每次运行会重新定义变量，注意副作用。

6. 方法三：%%writefile 写入并创建 .py 文件

反向操作场景下，可在 Notebook 中编写代码并通过 %%writefile 导出为 .py 文件：

%%writefile utils.py
def greet(name):
    return f"Hello, {name}!"

print(greet("World"))

此方法适用于构建可复用模块，并在后续通过 %run utils.py 调用。

7. 方法四：结合 import 动态导入模块

将 .py 文件视为模块导入，实现函数级调用：

import importlib.util

def load_module_from_path(module_name, file_path):
    spec = importlib.util.spec_from_file_location(module_name, file_path)
    module = importlib.util.module_from_spec(spec)
    spec.loader.exec_module(module)
    return module

# 使用示例
helper = load_module_from_path("helper", "./helper.py")
result = helper.some_function()

该方式更灵活，适合大型项目中的模块化集成。

8. 流程图：.py 文件集成流程

graph TD
    A[开始] --> B{是否有 .py 文件?}
    B -- 是 --> C[选择加载方式]
    B -- 否 --> D[使用 %%writefile 创建]
    C --> E[%load 查看代码]
    C --> F[%run 直接执行]
    C --> G[import 动态导入]
    F --> H[共享变量状态]
    G --> I[按需调用函数]
    H --> J[继续交互分析]
    I --> J

9. 最佳实践建议

• 对调试型任务优先使用 %load 或 %run。
• 生产级脚本建议封装为模块并通过 import 引入。
• 统一编码为 UTF-8，避免跨平台兼容问题。
• 使用 jupytext 实现 .py 与 .ipynb 双向同步，提升协作效率。
• 在 Docker 或 CI 环境中预置依赖路径，减少运行时异常。
• 利用 %timeit 与 %prun 对 %run 脚本进行性能剖析。
• 设置自动重载机制：%load_ext autoreload + %autoreload 2，提升开发迭代速度。