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

Question

我有一个这样的文件结构：

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

在中。ipynb笔记本中的文件我想从module01导入类和函数。py，module02。py和模块03。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)

有没有更好的办法？如果我有很多，该怎么办。ipynb笔记本中的文件文件夹，我是否必须将这些代码行粘贴到每一行的开头？有更好、更简约或更干净的方法吗？

Answer 1

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

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

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

• __初始化。py可以只是一个空文件，并告诉Python“此文件夹中的所有内容都是包的一部分”
• 有关设置中的内容的说明。请看这里

基本设置。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，这意味着将创建一个符号链接到它们所在的文件，而不是将文件复制到虚拟环境中。

现在，在任何笔记本中，您都可以执行以下操作：

导入我的\u包

或

我的_包中的。模块01导入

Answer 2

尝试将project\u文件夹添加到PYTHONPATH环境变量中。这将允许您告诉python在该目录中搜索导入。

您可以在用户配置文件设置中或在启动脚本中执行此操作，而不是在python中。在python运行之前，必须对其进行设置。