在测试和核心之间共享一个模块 - 适当的项目结构

Question

我正在尝试在添加到代码库的同时改进项目结构。我找到了一个示例结构here，它看起来像这样：

README.rst
LICENSE
setup.py
requirements.txt
sample/__init__.py
sample/core.py
sample/helpers.py
docs/conf.py
docs/index.rst
tests/test_basic.py
tests/test_advanced.py

我特别注意到requirements.txt 和setup.py 的级别高于tests/ 和sample/

如果我添加sample/classes.py，您只需在sample/core.py 中写入from classes import MyClass 即可获得它。然而，它不能那么容易地导入tests/test_basic.py，在导入时看起来不像 python '看起来在拐角处'。

在我的例子中，还有一个 MANIFEST.in 与 requirements.txt 和一些不是真正的 python 文件在同一级别上，但只是为运行它的平台设置了一些东西。

如果classes.py 与requirements.txt 处于同一级别，我认为tests/ 和sample/ 及其子目录中的所有内容都可以轻松导入它，但它可能需要__init__.py感觉不错。

如果tests/ 和sample/ 都需要使用它，那么它应该去哪里呢？

Answer 1

让我们让它变得简单。

如果我理解正确，问题是How to import simple module in test。这意味着你想使用from simple.classes import MyClass之类的东西。

这很简单，只需在执行python test/test_basic.py 之前将根路径添加到PYTHONPATH。

这也是 IDE 在您通过它执行测试时为您做的事情。

Answer 2

假设您使用 Python >= 3.3，您只需在包中添加 __init__.py 模块即可将测试文件夹转换为包。然后在那个__init__.py（并且只有在那里）中，将父包的路径添加到sys.path。如果足以让 unittest 发现将其用于tests 中的所有模块。

我的只是：

import os
import sys

sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))

如果您需要从其中一个测试模块访问classes.py，您可以使用：

from sample import classes

或者直接导入MyClass:

from sample.classes import MyClass

之所以能正常工作，是因为 sample 已经是一个包，并且当 python unittest 加载了 test 包时，它的父文件夹已添加到 sys.path。

---

当然，这仅适用于您可以将测试放在一个包中。如果由于任何原因它不是一个选项，例如因为您需要单独运行测试模块，那么您应该将 sys.path 修改直接放在所有测试文件中。

在tests文件夹中写一个path_helper.py文件：

import os
import sys

core_path = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
if core_path not in sys.path:  # don't add it if it is already here
    sys.path.append(core_path)

然后您可以将其导入所有测试文件中：

import path_helper
...