pytest>=7的推荐方法:使用pythonpath设置

最近，pytest增加了一个新的核心插件，该插件支持sys。通过pythonpath配置值修改路径。因此，现在的解决方案要简单得多，不再需要任何变通:

pyproject。toml例子:

[tool.pytest.ini_options]
pythonpath = [
  "."
]

pytest.ini例子:

[pytest]
pythonpath = .

路径条目是相对于根目录计算的，因此。将repo目录添加到sys。路径。

多个路径条目也被允许:对于一个布局

repo/
├── src/
|   └── lib.py
├── app.py
└── tests
     ├── test_app.py
     └── test_lib.py

配置

[tool.pytest.ini_options]
pythonpath = [
  ".", "src",
]

or

[pytest]
pythonpath = . src

将app和lib模块都添加到sys。路径,所以

import app
import lib

都可以。

原始答案(不建议用于最新的pytest版本;仅用于pytest<7): conftest解决方案

侵入性最小的解决方案是在repo/目录中添加一个名为conftest.py的空文件:

$ touch repo/conftest.py

就是这样。不需要编写自定义代码来破坏系统。path，或者记得拖拽PYTHONPATH，或者把__init__.py放到不属于它的dirs中(在Apteryx的回答中建议使用python -m pytest是一个很好的解决方案!)

之后的项目目录:

repo
├── conftest.py
├── app.py
├── settings.py
├── models.py
└── tests
     └── test_app.py

解释

Pytest在测试集合中寻找conftest模块来收集自定义钩子和fixture，为了从它们导入自定义对象，Pytest将conftest.py的父目录添加到sys. py目录中。路径(在本例中为repo目录)。

其他项目结构

如果你有其他的项目结构，将conftest.py放在包的根目录下(包含包但本身不是包，所以不包含__init__.py)，例如:

repo
├── conftest.py
├── spam
│   ├── __init__.py
│   ├── bacon.py
│   └── egg.py
├── eggs
│   ├── __init__.py
│   └── sausage.py
└── tests
     ├── test_bacon.py
     └── test_egg.py

src布局

虽然这种方法可以用于src布局(将conftest.py放在src dir中):

repo
├── src
│   ├── conftest.py
│   ├── spam
│   │   ├── __init__.py
│   │   ├── bacon.py
│   │   └── egg.py
│   └── eggs 
│       ├── __init__.py
│       └── sausage.py
└── tests
     ├── test_bacon.py
     └── test_egg.py

注意，将src添加到PYTHONPATH会降低src布局的意义和好处!您最终将测试来自存储库的代码，而不是安装的包。如果你需要这样做，也许你根本不需要src目录。

从这里往哪里走

当然，conftest模块不仅仅是一些帮助发现源代码的文件;pytest框架的所有特定于项目的增强和测试套件的定制都发生在这里。Pytest有很多关于conftest模块的信息，分散在它们的文档中;从conftest.py开始:本地每个目录的插件

另外，SO有一个关于conftest模块的很好的问题:在py中。测试，conftest。py文件有什么用?

由于无法导入模块，测试经常会中断。

经过研究，我发现系统在错误的地方查看文件，我们可以通过在相同的文件夹中复制包含模块的文件来轻松克服这个问题，以便正确导入。

另一个解决方案建议是更改导入的声明，并向MutPy显示单元的正确路径。然而，由于多个单元可能具有这种依赖关系，这意味着我们也需要在它们的声明中提交更改，因此我们更喜欢简单地将单元移动到文件夹中。

您可以在项目根中使用PYTHONPATH运行

PYTHONPATH=. py.test

或者使用pip install作为可编辑导入

pip install -e .   # install package using setup.py in editable mode

因为没有人建议这样做，你也可以在pytest.ini文件中传递测试的路径:

[pytest]
...
testpaths = repo/tests

参见文档:https://docs.pytest.org/en/6.2.x/customize.html#pytest-ini

Visual Studio Code的副作用:它应该在UI中拾取单元测试。

我也有同样的问题。我通过在我的测试目录中添加一个空的__init__.py文件来修复它。

根据Dirk Avery在Medium上的一篇文章(我个人经验也支持)，如果你在项目中使用虚拟环境，那么你就不能使用系统范围的pytest安装;您必须在虚拟环境中安装它并使用该安装。

特别是，如果在两个地方都安装了它，那么简单地运行pytest命令将不起作用，因为它将使用系统安装。正如其他答案所描述的，一个简单的解决方案是运行python -m pytest而不是pytest;这是因为它使用了环境版本的pytest。或者，你也可以卸载系统版本的pytest;重新激活虚拟环境后，pytest命令应该可以工作。