如何使 py.test 或鼻子在所有 python 文件中查找测试？

Question

我确实有几个小模块，其中的测试位于其中，并且 py.test 或 nose 不会查找它们，因为它们不包含 test在他们的文件名中。

我怎样才能说服py.test或nose在所有python文件中递归地寻找测试 - '''包括那些没有test 在他们的文件名'''？

在源文件中，我确实保留了标准命名约定：class testSomeName 和方法def test_some_name。

如果这是不可能的，我可以使用什么其他解决方案来获得相同的结果。

我不想手动创建包含测试的所有文件的列表，我想要一个支持发现的解决方案。

Answer 1

对于 pytest-6，我必须更改 @hpk42 答案以直接返回给定源/测试代码布局的模块实例。最初的答案对这个主要版本的 pytest 提出了例外，因为 API 同时发生了变化。

def pytest_collect_file(path, parent):
    """Look in all Python files for test cases."""
    from _pytest.python import Module

    if path.ext == ".py":
        return Module.from_parent(parent, fspath=path)

Answer 2

文档 说

默认情况下，所有不以点开头的目录都会被遍历，寻找 test_*.py 和 *_test.py 文件。这些 Python 文件将以其包名称导入。

您能确保您的代码就是这种情况吗？

更新

（买者自负：我还没有尝试/测试过这个）如何使用hooks 提供用于收集目录和文件吗？

py.test 调用以下两个基本钩子来收集文件和目录：

def pytest_collect_directory(path, parent):
    """ return Collection node or None for the given path. """

def pytest_collect_file(path, parent):
    """ return Collection node or None for the given path. """

两者都返回给定路径的集合节点 。所有钩子实现返回的所有节点都将参与收集和运行协议。 parent 对象是父节点，可用于通过 parent.config 对象访问命令行选项。

Answer 3

使用 py.test 就很简单了。创建一个包含以下内容的 conftest.py 文件：

# content of conftest.py file at root of your project
def pytest_collect_file(path, parent):
    if path.ext == ".py":
        return parent.Module(path, parent)

这将扩展收集过程，为每个“.py”文件创建一个测试“模块”节点。将其放入 conftest.py 文件中使其成为特定于项目的扩展，如果您键入以下内容，则会自动加载该扩展：

py.test 

出于信息目的，您还可以键入：

py.test --collectonly

以查看收集了哪些测试和文件，示例输出：

<Directory 'morecollect'>
   <Module 'conftest.py'>
   <Directory 'pkg'>
     <Module 'test_x.py'>
        <Function 'test_hello2'>
   <Module 'x.py'>   # this is collected because of our conftest.py extension
     <Function 'test_hello'>

如果需要，您还可以将上述 conftest.py 文件打包为 可安装插件 并通过安装插件使扩展可用。在这种情况下，您根本不需要任何 conftest.py 文件。

Answer 4

您还可以查看 Nose ，它会发现测试，而无需使用固定的文件名约定。

您可以使用以下代码绕过鼻子中用于过滤文件的正则表达式。
创建一个 python 模块（即 my_nosetests.py

import nose
from nose.plugins.base import Plugin

class ExtensionPlugin(Plugin):

    name = "ExtensionPlugin"

    def options(self, parser, env):
        Plugin.options(self,parser,env)

    def configure(self, options, config):
        Plugin.configure(self, options, config)
        self.enabled = True

    def wantFile(self, file):
        return file.endswith('.py')

    def wantDirectory(self,directory):
        return True

    def wantModule(self,file):
        return True


if __name__ == '__main__':
    includeDirs = ["-w", ".", ".."]
    nose.main(addplugins=[ExtensionPlugin()], argv=sys.argv.extend(includeDirs))

）请注意，您实际上正在加载所有模块并在其中搜索测试。注意模块加载的任何副作用。

Answer 5

将文件“setup.cfg”放在项目的根目录下，其中包含以下两行：

[pytest]
python_files=*.py

然后 py.test 从所有 *.py 文件中选择测试。这里有解释：pytest docs

with Nose：

nosetests --all-modules