Scrapy, a fast high-level web crawling & scraping framework for Python.
from __future__ import annotations
import gc
from io import StringIO
from unittest import mock
import pytest
from scrapy.utils import trackref
class Foo(trackref.object_ref):
pass
class Bar(trackref.object_ref):
pass
@pytest.fixture(autouse=True)
def clear_refs() -> None:
trackref.live_refs.clear()
def test_format_live_refs():
o1 = Foo() # noqa: F841
o2 = Bar() # noqa: F841
o3 = Foo() # noqa: F841
assert (
trackref.format_live_refs()
== """\
Live References
Bar 1 oldest: 0s ago
Foo 2 oldest: 0s ago
"""
)
assert (
trackref.format_live_refs(ignore=Foo)
== """\
Live References
Bar 1 oldest: 0s ago
"""
)
@mock.patch("sys.stdout", new_callable=StringIO)
def test_print_live_refs_empty(stdout: StringIO) -> None:
trackref.print_live_refs()
assert stdout.getvalue() == "Live References\n\n\n"
@mock.patch("sys.stdout", new_callable=StringIO)
def test_print_live_refs_with_objects(stdout: StringIO) -> None:
o1 = Foo() # noqa: F841
trackref.print_live_refs()
assert (
stdout.getvalue()
== """\
Live References
Foo 1 oldest: 0s ago\n\n"""
)
def test_get_oldest():
"""Verify that `get_oldest` returns the oldest live instance of a class."""
o1, o2, o3 = Foo(), Bar(), Foo()
assert trackref.get_oldest("Foo") is o1
assert trackref.get_oldest("Bar") is o2
assert trackref.get_oldest("XXX") is None
del o1
assert trackref.get_oldest("Foo") is o3
def test_get_oldest_all_dead():
o1 = Foo()
del o1
# Foo is still a key of live_refs, but it no longer tracks any instance.
assert trackref.get_oldest("Foo") is None
def test_iter_all():
o1 = Foo()
o2 = Bar() # noqa: F841
o3 = Foo()
assert set(trackref.iter_all("Foo")) == {o1, o3}
assert list(trackref.iter_all("XXX")) == []
def test_run_time_classes() -> None:
for _ in range(10):
base = type("Baz", (trackref.object_ref,), {})
base()
del base
gc.collect()
assert not list(trackref.iter_all("Baz"))
assert sum(1 for cls in trackref.live_refs if cls.__name__ == "Baz") == 0