python - 为什么我的具有函数作用域的 pytest 夹具返回的对象在新测试中没有重置它的类变量？

Question

我有一个名为 Person() 的类。它有一个 CURRENT_YEAR 类变量，旨在在类的所有实例之间共享。

我希望我在单个模块中的每个测试都会获得一个新的（新的）对象，因为我将夹具定义为“功能”。但是，当我在一个测试函数中更改 CURRENT_YEAR（使用更改 Person.CURRENT_YEAR 值的类方法发生这种情况）时，它会持续到下一个测试函数中。很明显，该对象并没有在每次测试中被清除和重新创建。

夹具在 conftest.py 中创建，所有测试都可以访问。

最后，我打破了一切，并移动了一些东西，但一直看到同样的东西。正如我所料，Person() 类不会多次实例化。应该如何创建一个夹具，以便每个 test_ 函数都有自己的 Class 范围？

我尝试将测试移动到单独的模块，但没有帮助。

我尝试制作第二个夹具，它返回一个 Person() 对象。没有不同。

我已经在下面的代码中真正剥离了它，所以希望能清楚我正在尝试什么以及我为什么感到困惑。

project_root/tests/test_temp.py

import os,sys
tests = os.path.dirname(__file__)
project = os.path.dirname(tests)
sys.path.insert(0,project)
import pytest
from app.person import *

def test_current_year_changes(person_fixture):
    import pytest
    p = person_fixture
    print(f"CY is {p.CURRENT_YEAR} and age is {p.get_age()}")
    p.add_years_to_age(20)
    print(f"CY is {p.CURRENT_YEAR} and age is {p.get_age()}")
    assert p.CURRENT_YEAR == 20

def test_current_year_changes2(person_fixture2):
    import pytest
    p = person_fixture2
    print(f"CY is {p.CURRENT_YEAR} and age is {p.get_age()}")
    p.add_years_to_age(20)
    print(f"CY is {p.CURRENT_YEAR} and age is {p.get_age()}")
    assert p.CURRENT_YEAR == 20


@pytest.fixture(scope='function')
def person_fixture():
    p = Person()
    return p

@pytest.fixture(scope='function')
def person_fixture2():
    p = Person()
    return p

project_root/app/person.py

class Person(object):

    CURRENT_YEAR = 0

    def __init__(self, name=""):
        self.name = name
        self.birth_year = Person.CURRENT_YEAR

    def add_years_to_age(self, years=1):
        Person.CURRENT_YEAR += years

    def get_age(self):
        return Person.CURRENT_YEAR - self.birth_year

代码看起来两个测试应该是相当独立的。但是第二个测试函数显示 CURRENT_YEAR 不是以新的类变量开始的。

断言失败，表明Person.CURRENT_YEAR是 40，而不是 20

标签： pythonpython-3.xunit-testingpytestfixtures

Answer 1

夹具范围只定义了装饰的函数何时@pytest.fixture运行。这只是将通用测试代码分解为单独函数的一种方法。

因此，在您的情况下，"function"夹具将为每个测试函数（使用夹具）执行该函数并创建一个Person实例。同样，如果范围是"module".

这完全按预期工作。它不仅按照 pytest 的预期工作，而且按照您自己的预期工作 - 请记住，您实际上想CURRENT_YEAR在不同的实例之间共享！

应该如何创建一个夹具，以便每个 test_ 函数都有自己的 Class 范围？

您真的不应该使用全局或静态变量（类变量只是隐藏在类后面的全局变量），因为它使测试变得非常困难（并使程序非线程安全）。还要记住，如果您不提供，pytest 将无法提供重置程序的基础设施！想一想：究竟应该发生什么？它应该为每个测试功能创建一个新的解释器会话吗？它应该重新加载模块吗？它应该重新加载类定义吗？是否应该将 Person.CURRENT_YEAR 设置为零？

解决这个问题的一种方法是抽象类变量，例如使用环境类（无论如何，今年似乎也不适合 Person 类）：

class Environment(object):
    def __init__(self):
        self.CURRENT_YEAR = 0

class Person(object):
    def __init__(self, environment, name=""):
        self.environment = environment
        self.name = name
        self.birth_year = self.environment.CURRENT_YEAR

    def add_years_to_age(self, years=1):
        self.environment.CURRENT_YEAR += years

    def get_age(self):
        return self.environment.CURRENT_YEAR - self.birth_year

然后让fixture创建一个新的环境和person实例：

@pytest.fixture(scope='function')
def person_fixture():
    e = Environment()
    p = Person(e)
    return p

那时，您可能需要Environment在代码中使用全局实例，以便不同的Person实例可以共享它。

请注意，如果它只是一个变量，那么这没有多大意义，并且可能您最终会为不同的环境变量使用不同的类。如果您的应用程序变得更加复杂，您可能需要考虑依赖注入来管理这种复杂性。

---

但是，如果您只想CURRENT_YEAR重置使用您的每个功能，您person_fixture也可以在夹具中将其设置为 0：

@pytest.fixture(scope='function')
def person_fixture_with_current_year_reset():
    Person.CURRENT_YEAR = 0
    p = Person()
    return p

现在应该可以了，但是在您并行运行测试时，您可能会看到随机失败，因为全局变量（和类变量）本质上是非线程安全的。