197

我有一个类似于以下的目录结构

meta_project
    project1
        __init__.py
        lib
            module.py
            __init__.py
    notebook_folder
        notebook.jpynb

在工作时，notebook.jpynb如果我尝试使用相对导入来访问以下function()函数module.py：

from ..project1.lib.module import function

我收到以下错误：

SystemError                               Traceback (most recent call last)
<ipython-input-7-6393744d93ab> in <module>()
----> 1 from ..project1.lib.module import function

SystemError: Parent module '' not loaded, cannot perform relative import

有没有办法使用相对进口来让它工作？

请注意，笔记本服务器是在meta_project目录级别实例化的，因此它应该可以访问这些文件中的信息。

另请注意，至少按照最初的预期project1，它没有被认为是一个模块，因此没有__init__.py文件，它只是作为一个文件系统目录。如果问题的解决方案需要将其视为一个模块并包含一个__init__.py文件（甚至是空白文件），那很好，但这样做不足以解决问题。

我在机器之间共享这个目录，相对导入允许我在任何地方使用相同的代码，并且我经常使用笔记本进行快速原型设计，因此涉及将绝对路径组合在一起的建议不太可能有帮助。

编辑：这与Python 3 中的相对导入不同，后者通常讨论 Python 3 中的相对导入，尤其是从包目录中运行脚本。这与在 jupyter notebook 中工作有关，试图在另一个目录中调用本地模块中的函数，该目录具有不同的一般和特定方面。

4

10 回答 10

240

我在这个笔记本中有几乎和你一样的例子，我想以 DRY 的方式说明相邻模块功能的用法。

我的解决方案是通过在笔记本中添加一个像这样的片段来告诉 Python 那个额外的模块导入路径：

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

这允许您从模块层次结构中导入所需的功能：

from project1.lib.module import function
# use the function normally
function(...)

请注意，如果您还没有空文件，则必须将空__init__.py文件添加到project1/和lib/文件夹。

于 2016-02-08T15:48:01.637 回答
38

来到这里寻找在笔记本中工作时将代码抽象为子模块的最佳实践。我不确定是否有最佳做法。我一直在提议这个。

项目层次结构如下：

├── ipynb
│   ├── 20170609-Examine_Database_Requirements.ipynb
│   └── 20170609-Initial_Database_Connection.ipynb
└── lib
    ├── __init__.py
    └── postgres.py

从20170609-Initial_Database_Connection.ipynb：

    In [1]: cd ..

    In [2]: from lib.postgres import database_connection

这是因为默认情况下 Jupyter Notebook 可以解析cd命令。请注意，这并没有使用 Python Notebook 魔法。它只是在没有前置的情况下工作%bash。

考虑到 100 次中有 99 次我使用Project Jupyter Docker 映像之一在 Docker 中工作，以下修改是幂等的

    In [1]: cd /home/jovyan

    In [2]: from lib.postgres import database_connection
于 2017-06-11T17:29:47.720 回答
18

到目前为止，接受的答案对我来说效果最好。但是，我一直担心有一种可能的情况，即我可能会将notebooks目录重构为子目录，需要module_path在每个笔记本中更改。我决定在每个笔记本目录中添加一个 python 文件来导入所需的模块。

因此，具有以下项目结构：

project
|__notebooks
   |__explore
      |__ notebook1.ipynb
      |__ notebook2.ipynb
      |__ project_path.py
   |__ explain
       |__notebook1.ipynb
       |__project_path.py
|__lib
   |__ __init__.py
   |__ module.py

project_path.py我在每个笔记本子目录（notebooks/explore和notebooks/explain）中添加了文件。该文件包含相对导入的代码（来自@metakermit）：

import sys
import os

module_path = os.path.abspath(os.path.join(os.pardir, os.pardir))
if module_path not in sys.path:
    sys.path.append(module_path)

这样，我只需要在project_path.py文件中进行相对导入，而不是在笔记本中。笔记本文件只需要在导入project_path之前导入lib。例如在0.0-notebook.ipynb：

import project_path
import lib

这里需要注意的是，逆转进口是行不通的。这不起作用：

import lib
import project_path

因此，在进口时必须小心。

于 2018-06-25T17:29:33.370 回答
12

这里的所有其他答案都取决于在笔记本中添加代码（！）

在我看来，将特定路径硬编码到笔记本代码中是不好的做法，或者取决于位置，因为这使得以后很难重构代码。相反，我建议您在启动 Jupyter 笔记本服务器时将根项目文件夹添加到 PYTHONPATH，或者直接从项目文件夹中添加，如下所示

env PYTHONPATH=`pwd` jupyter notebook

或者如果您从其他地方启动它，请像这样使用绝对路径

env PYTHONPATH=/Users/foo/bar/project/ jupyter notebook

于 2020-12-07T13:12:06.457 回答
10

我刚刚找到了这个漂亮的解决方案：

import sys; sys.path.insert(0, '..') # add parent folder path where lib folder is
import lib.store_load # store_load is a file on my library folder

你只想要那个文件的一些功能

from lib.store_load import your_function_name

如果 python 版本 >= 3.3，则不需要文件夹中的 init.py 文件

于 2020-03-01T18:11:57.100 回答
4

我自己研究这个主题并阅读了我推荐使用path.py 库的答案，因为它提供了一个用于更改当前工作目录的上下文管理器。

然后你有类似的东西

import path
if path.Path('../lib').isdir():
    with path.Path('..'):
        import lib

虽然，您可能只是省略了该isdir声明。

在这里，我将添加打印语句以便于了解正在发生的事情

import path
import pandas

print(path.Path.getcwd())
print(path.Path('../lib').isdir())
if path.Path('../lib').isdir():
    with path.Path('..'):
        print(path.Path.getcwd())
        import lib
        print('Success!')
print(path.Path.getcwd())

在此示例中输出（其中 lib 位于/home/jovyan/shared/notebooks/by-team/data-vis/demos/lib）：

/home/jovyan/shared/notebooks/by-team/data-vis/demos/custom-chart
/home/jovyan/shared/notebooks/by-team/data-vis/demos
/home/jovyan/shared/notebooks/by-team/data-vis/demos/custom-chart

由于该解决方案使用上下文管理器，因此无论您的内核在单元之前处于什么状态，也无论导入库代码引发什么异常，您都可以保证返回到以前的工作目录。

于 2019-10-16T17:16:37.873 回答
2

我发现python-dotenv可以非常有效地解决这个问题。您的项目结构最终会略有变化，但笔记本中的代码更简单一些，并且在不同笔记本中保持一致。

对于您的项目，请进行一些安装。

pipenv install python-dotenv

然后，项目更改为：

├── .env (this can be empty)
├── ipynb
│   ├── 20170609-Examine_Database_Requirements.ipynb
│   └── 20170609-Initial_Database_Connection.ipynb
└── lib
    ├── __init__.py
    └── postgres.py

最后，您的导入更改为：

import os
import sys

from dotenv import find_dotenv


sys.path.append(os.path.dirname(find_dotenv()))

此软件包的 +1 是您的笔记本可以有多个目录。python-dotenv 将在父目录中找到最近的一个并使用它。这种方法的 +2 是 jupyter 将在启动时从 .env 文件加载环境变量。双重打击。

于 2020-04-10T16:34:10.970 回答
0

这是我的 2 美分：

导入系统

映射模块文件所在的路径。就我而言，它是桌面

sys.path.append('/Users/John/Desktop')

要么导入整个映射模块，但你必须使用 .notation 来映射类，如 mapping.Shipping()

import mapping #mapping.py 是我的模块文件的名称

shipit = mapping.Shipment() #Shipment 是我需要在映射模块中使用的类的名称

或者从映射模块导入特定的类

从映射导入映射

shipit = Shipment() #现在你不必使用 .notation

于 2020-04-01T10:16:35.700 回答
0

对于那些像我一样不理解解决方案的人，您必须根据具体问题的需要深入到目录中。此错误的解决方案：

没有名为“your_folder”的模块

我使用的笔记本位于：

C:\Users\vojte\projects\predicta\EDA\apartments\EDA.ipynb

我想导入这个笔记本：

C:\Users\vojte\projects\functions\functions.ipynb

我不得不通过@metakermit 将上面的解决方案修改为这个解决方案：

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

from functions import functions as f

您可以检查sys.path附加目录。在此示例中，附加了这一行：

C:\\Users\\vojte\\projects

于 2021-07-13T00:07:18.273 回答
0

在 using 中改进@joshua-cook 的答案cd..，以确保您没有重新运行单元格并在 using run allwithout中弄乱您的目录restart，请改用以下代码：

if 'NOTEBOOK_INITIATED_FLAG' not in globals():
    NOTEBOOK_INITIATED_FLAG = True
    %cd ..
%pwd

NOTEBOOK_INITIATED_FLAG用作标记内核已经在运行的占位符，因此不需要更改目录。

如果您想使用并从父文件夹jupytext运行文件，这是超级复杂的样板：.py

import os
import sys

if 'NOTEBOOK_INITIATED_FLAG' not in globals():
    NOTEBOOK_INITIATED_FLAG = True
    
    try:
        # not in notebook
        module_path = os.path.join(os.path.dirname(__file__), os.pardir)
    except:
        # in notebook
        module_path = os.path.abspath(os.path.join('..'))
        %cd ..
        %pwd

    if module_path not in sys.path:
        sys.path.append(module_path)
于 2021-09-13T02:40:29.243 回答