将pycharm项目导入jupyter notebook

Question

我正在使用 Pycharm 开发一个 python 包，并希望使用 Jupyter notebooks 与模块进行交互。

我的项目结构如下：

project/notebooks/my_notebook.ipynb
project/module/__init__.py
project/module/core.py
project/tests/...

我在浏览器中运行my_notebook.ipynb但不知道如何导入 python 模块的内容。 像from module import foo这样的东西不能开箱即用。 我遇到了这篇博文，其中涉及将源代码安装为可编辑的 Pip 包，但我想知道是否有另一种方法可以使其工作而不涉及安装包？

Answer 1

您只需要将该目录放入笔记本内的路径中：

例如：

import sys

# make sure to use position 1
sys.path.insert(1, "/Users/foo/bar/project/")
from module.core import foo

使用位置 1 很重要，因为使用位置 0 可能会破坏 sys.path: docs

另请注意，您应该确保为您的 pycharm 项目正在使用的笔记本使用相同的virtualenv（或 conda env），否则您可能会遇到意外冲突

Answer 2

在我看来，将特定路径硬编码到笔记本代码中是不好的做法。 相反，我会在启动 Jupyter 笔记本服务器时将根项目文件夹添加到 PYTHONPATH，或者直接从项目文件夹中添加

env PYTHONPATH=`pwd` jupyter notebook

或者如果你是从其他地方启动它，就像这样

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