从父目录中的 python 模块导入到子目录中的 jupyter notebook 文件中

Question

我有这样的文件结构：

project_folder/
     notebooks/
          notebook01.ipynb
          notebook02.ipynb
          ...
          notebookXY.ipynb
     module01.py
     module02.py
     module03.py

在notebook/ 文件夹内的.ipynb 文件中，我想从module01.py, module02.py 和module03.py 导入类和函数。

我在question 中找到了答案，可以在每个笔记本中使用以下代码行，并且每次都将这些行作为第一个单元格运行：

import os
import sys
module_path = os.path.abspath(os.path.join('..'))
if module_path not in sys.path:
    sys.path.append(module_path)

请问有更好的方法吗？如果我在notebooks/ 文件夹中有很多.ipynb 文件怎么办，我是否必须在每个文件的开头粘贴这些代码行？有没有更好、更简约或更干净的方式？

Answer 1

尝试将project_folder 添加到您的PYTHONPATH environment variable. 这将允许您告诉python 在该目录中搜索导入。

您可以在您的用户配置文件设置中或在您的启动脚本中执行此操作 - 而不是在 python 中。这是在 python 运行之前必须设置的东西。

Answer 2

另一个解决方案是将所有 Python 模块（.py 文件）移动到一个文件夹中，并使其成为可安装的包。如果您pip 将其安装到您当前的环境中，那么您可以将包导入该环境中的任何笔记本中，而不管文件夹结构如何。

所以在你的情况下，你可以：

project_folder/
  notebooks/
    notebook01.ipynb
    notebook02.ipynb
    ...
    notebookXY.ipynb
  my_package/
    __init__.py
    module01.py
    module02.py
    module03.py
  setup.py

• __init__.py 可以只是一个空文件，并告诉 Python“此文件夹中的所有内容都是包的一部分”
• 如需了解 setup.py 中的内容，请参阅 here。

一个基本的setup.py可以这么简单：

import setuptools

setuptools.setup(
    name="my_package",
    version="0.0.1",
    description="A small example package",
    packages=setuptools.find_packages(),
    python_requires='>=3.7',
)

安装它：

cd project_folder
pip install [-e] .

包含可选的-e 标志将在“可编辑”模式下安装my_package，这意味着不会将文件复制到您的虚拟环境中，而是会为它们所在的文件创建符号链接。

现在你可以在任何笔记本上做：

import my_package

或者

from my_package.module01 import <some object>