从父目录内的python模块导入到子目录内的jupyter笔记本文件

Question

我有这样的文件结构：

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

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

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

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环境变量中。 这将允许您告诉 python 在该目录中搜索导入。

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

Answer 2

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

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

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中内容的说明，请参见此处。

一个基本的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>