如何从父目录/不同的包导入模块？

Question

在我从GitHub克隆的一个项目中，我遇到了一个问题：import关于父目录或不同包中的模块的语句ImportError无法识别。我发布了关于我的具体场合的问题，并继续研究

最后，我得出了一个结论，我想与大家分享一些类似未来问题的资源

---

问题:

• 如何import从父目录或从不同包创建模块
• 什么是正确的方法

Answer 1

答复

（或者只是关于这个问题的一些信息）

根据python docs，导入模块的工作方式如下：

When a module named spam is imported, the interpreter first searches for a built-in module with that name. If not found, it then searches for a file named spam.py in a list of directories given by the variable sys.path. sys.path is initialized from these locations:

• The directory containing the input script (or the current directory when no file is specified).
• PYTHONPATH (a list of directory names, with the same syntax as the shell variable PATH).
• The installation-dependent default.

因此，如果您只是想import一个模块，例如my_pkg.my_module.py，它位于与导入它的模块不同的位置，那么my_pkg应该在{}返回的列表中。要实现这一点，有三种方法（据我所知）：

1. 修改PYTHONPATH变量。（正如所指出的，here）-不首选
2. 在运行时修改sys.path。（正如所指出的，here）-不首选
3. 拥有一个setup.py文件，用于解析模块的导入依赖项（并执行许多其他重要操作）-正确的方式

因此，上面的前两种方法通常被认为不是一种好的实践，而是一种暂时的坏的解决方案，在开发过程中会导致进一步的问题。然而，第三种方法是构建一个易于被其他人使用的、组织良好的、可分发的项目的最佳方法。setup.py文件的一些好处以及它的全部功能都在here中进行了说明

使用setup.py文件，您可以清楚地配置，这些包包含要导入以解决ImportError问题的模块，并对您的项目执行许多其他有用的操作

下面引用了两个非常具有说明性的教程，介绍了如何使用导入语句和如何创建setup.py文件，我强烈建议看看：

• https://chrisyeh96.github.io/2017/08/08/definitive-guide-python-imports.html
• https://www.pythonforthelab.com/blog/how-create-setup-file-your-project/

---

编辑：此外，您可以在此处找到有关如何配置、打包和分发项目的大量信息：

• https://packaging.python.org/guides/distributing-packages-using-setuptools/

就我个人而言，为了构建一个非常好的第一个setup.py文件，我发现它非常有用