Skip to content

Commit

Permalink
[8.2.x] unittest: fix class instances no longer released on test tear…
Browse files Browse the repository at this point in the history
…down since pytest 8.2.0
  • Loading branch information
bluetech authored and pytestbot committed May 26, 2024
1 parent 558e4fa commit f7358ae
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 17 deletions.
1 change: 1 addition & 0 deletions changelog/12367.bugfix.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Fix a regression in pytest 8.2.0 where unittest class instances (a fresh one is created for each test) were not released promptly on test teardown but only on session teardown.
3 changes: 2 additions & 1 deletion src/_pytest/unittest.py
Original file line number Diff line number Diff line change
Expand Up @@ -212,11 +212,12 @@ def setup(self) -> None:
super().setup()

def teardown(self) -> None:
super().teardown()
if self._explicit_tearDown is not None:
self._explicit_tearDown()
self._explicit_tearDown = None
self._obj = None
self._instance = None
super().teardown()

def startTest(self, testcase: "unittest.TestCase") -> None:
pass
Expand Down
36 changes: 20 additions & 16 deletions testing/test_unittest.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
# mypy: allow-untyped-defs
import gc
import sys
from typing import List

Expand Down Expand Up @@ -192,30 +191,35 @@ def test_check(self):
def test_teardown_issue1649(pytester: Pytester) -> None:
"""
Are TestCase objects cleaned up? Often unittest TestCase objects set
attributes that are large and expensive during setUp.
attributes that are large and expensive during test run or setUp.
The TestCase will not be cleaned up if the test fails, because it
would then exist in the stackframe.
Regression test for #1649 (see also #12367).
"""
testpath = pytester.makepyfile(
pytester.makepyfile(
"""
import unittest
class TestCaseObjectsShouldBeCleanedUp(unittest.TestCase):
def setUp(self):
self.an_expensive_object = 1
def test_demo(self):
pass
import gc
"""
class TestCaseObjectsShouldBeCleanedUp(unittest.TestCase):
def test_expensive(self):
self.an_expensive_obj = object()
def test_is_it_still_alive(self):
gc.collect()
for obj in gc.get_objects():
if type(obj).__name__ == "TestCaseObjectsShouldBeCleanedUp":
assert not hasattr(obj, "an_expensive_obj")
break
else:
assert False, "Could not find TestCaseObjectsShouldBeCleanedUp instance"
"""
)

pytester.inline_run("-s", testpath)
gc.collect()

# Either already destroyed, or didn't run setUp.
for obj in gc.get_objects():
if type(obj).__name__ == "TestCaseObjectsShouldBeCleanedUp":
assert not hasattr(obj, "an_expensive_obj")
result = pytester.runpytest()
assert result.ret == ExitCode.OK


def test_unittest_skip_issue148(pytester: Pytester) -> None:
Expand Down

0 comments on commit f7358ae

Please sign in to comment.