从当前工作目录上方的目录导入模块 情况1：您不想打包您的库案例2：您想打包您的库

编程问答 2022-06-11

问题描述

首先，有很多关于stackoverflow的解决方案，但是从我尝试过的解决方案中，没有一个起作用。我正在远程计算机（Linux）上工作。我正在使用ipython解释器在dir-2/module_2.py文件中进行原型设计。另外，我试图避免使用绝对路径，因为此远程计算机中的绝对路径又长又丑陋，我希望我的代码在下载时可以在其他计算机上运行。

我的目录结构如下：

/project-dir/
            -/dir-1/
                  -/__ init__.py
                  -/module_1.py
            -/dir-2/
                  -/__ init__.py
                  -/module_2.py
                  -/module_3.py

现在，我想从module_1导入module_2。但是，此stackoverflow帖子中提到的解决方案是：link使用

sys.path.append('../..')
import module_2

不起作用。我收到错误消息：ModuleNotFoundError: No module named 'module_1'

此外，在ipython解释器中，import .module_3之内的module_2之类的错误引发：

import .module_3
       ^ SyntaxError: invalid Syntax

点运算符也不应该在同一目录中工作。总的来说，我对导入机制感到很困惑。非常感谢您对最初问题的任何帮助！非常感谢！

解决方法

为什么不起作用？

如果您运行module1.py文件并要导入module2，则需要类似

sys.path.append("../dir-2")

如果您在其中使用sys.path.append("../..") then the folder you added to the path is the folder containing project-dir and there is not module2.py`文件。

语法import .module_3用于相对导入。如果您尝试执行module2.py并且它包含import .module_3，则该命令将不起作用，因为您使用module2.py作为脚本。要使用相对导入，您需要将module2.py和module_3.py都视为模块。也就是说，其他一些文件导入module2和module2使用此语法从module3导入一些东西。

关于如何进行的建议

解决这两个问题的一种可能的解决方案是组织项目的属性和（可选地，一个好主意）打包库（即，使代码“可安装”）。然后，在安装库（在虚拟环境中工作）后，您就不需要 hacky sys.path解决方案。您将可以从任何文件夹导入库。

此外，请勿将您的模块视为脚本（请勿运行您的模块）。使用一个单独的python文件作为您的“可执行文件”（或入口点），并从那里导入您需要的所有内容。这样，您的module*.py文件中的相对导入将可以正常工作，并且您不会感到困惑。

可能是可能的目录结构

/project-dir/
            - apps/
                  - main.py
            - yourlib/
                  -/__ init__.py
                  -/dir-1/
                        -/__ init__.py
                        -/module_1.py
                  -/dir-2/
                        -/__ init__.py
                        -/module_2.py
                        -/module_3.py

请注意，yourlib文件夹以及子文件夹包含一个__init__.py文件。使用这种结构，您只需运行main.py（名称不必为main.py）。

情况1：您不想打包您的库

如果您不想打包库，则可以在sys.path.append("../")中添加main.py，以将“ project-dir/文件夹添加到路径。 }库在yourlib中是“可导入的”。您可以进行类似main.py的操作，并且它可以正常工作（并且from yourlib import module_2可以使用相对导入）。或者，您也可以直接将{ module_2文件夹中的{1}}，您根本不需要更改main.py，因为在这种情况下，project-dir/将成为“工作目录”。

请注意，您还可以在sys.path内有一个project-dir/文件夹，并且要运行测试文件，可以执行与运行tests相同的操作。

案例2：您想打包您的库

先前的解决方案已经解决了您的问题，但是加倍努力会带来一些好处，例如依赖管理，无论您身在何处都无需更改project-dir。打包您的库有多种选择，由于其简单性，我将使用poetry显示一个选择。

安装诗歌后，您可以在终端中运行以下命令来创建新项目

main.py

这将创建以下文件夹结构

sys.path

然后，您可以根据需要添加poetry new mylib 文件夹，以及mylib/ - README.rst - mylib/ - __init__.py - pyproject.toml - tests 内的子文件夹（每个文件夹都有一个apps文件）。

pyproject.toml文件指定依赖项和项目元数据。您可以手动编辑和/或使用诗歌来添加新的依赖项，例如

mylib/
例如，

将__init__.py添加为依赖项，并将poetry add pandas poetry add --dev mypy 添加为开发依赖项。之后，您可以运行

pandas

创建虚拟环境并在其中安装您的库。您可以使用mypy激活虚拟环境，并且可以从任何地方导入库。请注意，您可以更改库文件，而无需再次运行poetry build 。

最后，如果您想在PyPi中发布您的库，以供所有人查看，您可以使用

poetry shell

TL; DR

使用有组织的项目结构，在清晰的位置显示您执行的脚本。特别是，如果您执行的脚本位于模块所在文件夹的外部，则更好。另外，请勿将模块作为脚本运行（否则您不能使用相对导入）。

importpythonpython-import