Skip to content

Clean up capture code #14160

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Liam-DeVoe wants to merge 2 commits into
base: main
Choose a base branch
from
+29 −46
Open

Clean up capture code #14160

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6174cb9
Remove unused SysCaptureBase.repr (already has __repr__)
Liam-DeVoe Feb 3, 2026
428d8a3
Reduce code duplication in defining capture fixtures
Liam-DeVoe Feb 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
75 changes: 29 additions & 46 deletions src/_pytest/capture.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -374,15 +374,6 @@ def __init__(
self.tmpfile = tmpfile
self._state = "initialized"

def repr(self, class_name: str) -> str:
return "<{} {} _old={} _state={!r} tmpfile={!r}>".format(
class_name,
self.name,
(hasattr(self, "_old") and repr(self._old)) or "<UNSET>",
self._state,
self.tmpfile,
)

def __repr__(self) -> str:
Comment on lines -377 to 386
Copy link
Contributor Author

@Liam-DeVoe Liam-DeVoe Feb 3, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Introduced in 97bcf5a. Duplicates __repr__ and seems unused?

return "<{} {} _old={} _state={!r} tmpfile={!r}>".format(
self.__class__.__name__,
Expand Down Expand Up @@ -996,6 +987,25 @@ def disabled(self) -> Generator[None]:
# The fixtures.


@contextlib.contextmanager
def _capture_fixture(
request: SubRequest,
captureclass: type[CaptureBase[AnyStr]],
config: dict[str, Any] | None = None,
) -> Generator[CaptureFixture[AnyStr]]:
capman: CaptureManager = request.config.pluginmanager.getplugin("capturemanager")
capture_fixture = CaptureFixture(
captureclass, request, config=config, _ispytest=True
)
capman.set_fixture(capture_fixture)
capture_fixture._start()
try:
yield capture_fixture
finally:
capture_fixture.close()
capman.unset_fixture()


@fixture
def capsys(request: SubRequest) -> Generator[CaptureFixture[str]]:
r"""Enable text capturing of writes to ``sys.stdout`` and ``sys.stderr``.
Expand All @@ -1015,13 +1025,8 @@ def test_output(capsys):
captured = capsys.readouterr()
assert captured.out == "hello\n"
"""
capman: CaptureManager = request.config.pluginmanager.getplugin("capturemanager")
capture_fixture = CaptureFixture(SysCapture, request, _ispytest=True)
capman.set_fixture(capture_fixture)
capture_fixture._start()
yield capture_fixture
capture_fixture.close()
capman.unset_fixture()
with _capture_fixture(request, SysCapture) as fixture:
yield fixture


@fixture
Expand All @@ -1048,15 +1053,8 @@ def test_output(capteesys):
captured = capteesys.readouterr()
assert captured.out == "hello\n"
"""
capman: CaptureManager = request.config.pluginmanager.getplugin("capturemanager")
capture_fixture = CaptureFixture(
SysCapture, request, config=dict(tee=True), _ispytest=True
)
capman.set_fixture(capture_fixture)
capture_fixture._start()
yield capture_fixture
capture_fixture.close()
capman.unset_fixture()
with _capture_fixture(request, SysCapture, config={"tee": True}) as fixture:
yield fixture


@fixture
Expand All @@ -1078,13 +1076,8 @@ def test_output(capsysbinary):
captured = capsysbinary.readouterr()
assert captured.out == b"hello\n"
"""
capman: CaptureManager = request.config.pluginmanager.getplugin("capturemanager")
capture_fixture = CaptureFixture(SysCaptureBinary, request, _ispytest=True)
capman.set_fixture(capture_fixture)
capture_fixture._start()
yield capture_fixture
capture_fixture.close()
capman.unset_fixture()
with _capture_fixture(request, SysCaptureBinary) as fixture:
yield fixture


@fixture
Expand All @@ -1106,13 +1099,8 @@ def test_system_echo(capfd):
captured = capfd.readouterr()
assert captured.out == "hello\n"
"""
capman: CaptureManager = request.config.pluginmanager.getplugin("capturemanager")
capture_fixture = CaptureFixture(FDCapture, request, _ispytest=True)
capman.set_fixture(capture_fixture)
capture_fixture._start()
yield capture_fixture
capture_fixture.close()
capman.unset_fixture()
with _capture_fixture(request, FDCapture) as fixture:
yield fixture


@fixture
Expand All @@ -1135,10 +1123,5 @@ def test_system_echo(capfdbinary):
assert captured.out == b"hello\n"

"""
capman: CaptureManager = request.config.pluginmanager.getplugin("capturemanager")
capture_fixture = CaptureFixture(FDCaptureBinary, request, _ispytest=True)
capman.set_fixture(capture_fixture)
capture_fixture._start()
yield capture_fixture
capture_fixture.close()
capman.unset_fixture()
with _capture_fixture(request, FDCaptureBinary) as fixture:
yield fixture