From f85412e255098a8ff1084edfc9621ad4b5988856 Mon Sep 17 00:00:00 2001 From: Kirill Podoprigora Date: Sat, 7 Nov 2026 14:02:14 +0000 Subject: [PATCH 1/3] Fix leak of file descriptors --- Lib/_pyrepl/readline.py | 18 ++++++--- Lib/test/test_pyrepl/test_pyrepl.py | 40 ++++++++++++++++++- ...-11-07-16-01-33.gh-issue-161549.rKq8Lw.rst | 2 + 3 files changed, 54 insertions(+), 6 deletions(-) create mode 100644 Misc/NEWS.d/next/Library/2026-11-07-16-01-33.gh-issue-161549.rKq8Lw.rst diff --git a/Lib/_pyrepl/readline.py b/Lib/_pyrepl/readline.py index 4232a868a34e9a..8cee0ec833ad17 100644 --- a/Lib/_pyrepl/readline.py +++ b/Lib/_pyrepl/readline.py @@ -355,15 +355,23 @@ class _ReadlineWrapper: saved_history_length: int = -1 startup_hook: Callback | None = None config: ReadlineConfig = field(default_factory=ReadlineConfig, repr=False) + owned_fds: list[int] = field(default_factory=list, init=False, repr=False) - def __post_init__(self) -> None: - if self.f_in == -1: - self.f_in = os.dup(0) - if self.f_out == -1: - self.f_out = os.dup(1) + def __del__(self, _close=os.close) -> None: + for fd in self.owned_fds: + try: + _close(fd) + except OSError: + pass def get_reader(self) -> ReadlineAlikeReader: if self.reader is None: + if self.f_in == -1: + self.f_in = os.dup(0) + self.owned_fds.append(self.f_in) + if self.f_out == -1: + self.f_out = os.dup(1) + self.owned_fds.append(self.f_out) console = Console(self.f_in, self.f_out, encoding=ENCODING) self.reader = ReadlineAlikeReader(console=console, config=self.config) return self.reader diff --git a/Lib/test/test_pyrepl/test_pyrepl.py b/Lib/test/test_pyrepl/test_pyrepl.py index 1828fd735669d5..a2636deb76e0c5 100644 --- a/Lib/test/test_pyrepl/test_pyrepl.py +++ b/Lib/test/test_pyrepl/test_pyrepl.py @@ -20,12 +20,13 @@ captured_stdout, captured_stderr, force_not_colorized, + gc_collect, make_clean_env, Py_DEBUG, ) from test.support import has_subprocess_support, SHORT_TIMEOUT, STDLIB_DIR from test.support.import_helper import import_module -from test.support.os_helper import EnvironmentVarGuard, unlink +from test.support.os_helper import EnvironmentVarGuard, fd_count, unlink from .support import ( FakeConsole, @@ -2723,3 +2724,40 @@ def test_exact_width_line_does_not_wrap(self): console, wc = self._make_mock_console(width=width) self._apply_changed_line(console, wc, y, "", "a" * width) self.assertEqual(console.posxy, (width - 1, y)) + + +@skipUnless(pty, "requires pty") +class TestReadlineWrapperFileDescriptors(TestCase): + def setUp(self): + controller, self.worker = pty.openpty() + self.addCleanup(os.close, controller) + self.addCleanup(os.close, self.worker) + env = self.enterContext(EnvironmentVarGuard()) + env["TERM"] = "ansi" + + def redirect_stdio_to_pty(self): + sys.stdout.flush() + for fd in (0, 1): + saved = os.dup(fd) + self.addCleanup(os.close, saved) + self.addCleanup(os.dup2, saved, fd) + os.dup2(self.worker, fd) + + def test_dupped_fds_are_closed_with_wrapper(self): + self.redirect_stdio_to_pty() + before = fd_count() + wrapper = _ReadlineWrapper() + self.assertEqual(fd_count(), before) + wrapper.get_reader() + self.assertEqual(fd_count(), before + 2) + del wrapper + gc_collect() + self.assertEqual(fd_count(), before) + + def test_given_fds_are_not_closed_with_wrapper(self): + before = fd_count() + wrapper = _ReadlineWrapper(f_in=self.worker, f_out=self.worker) + wrapper.get_reader() + del wrapper + gc_collect() + self.assertEqual(fd_count(), before) diff --git a/Misc/NEWS.d/next/Library/2026-11-07-16-01-33.gh-issue-161549.rKq8Lw.rst b/Misc/NEWS.d/next/Library/2026-11-07-16-01-33.gh-issue-161549.rKq8Lw.rst new file mode 100644 index 00000000000000..e2927404fb2530 --- /dev/null +++ b/Misc/NEWS.d/next/Library/2026-11-07-16-01-33.gh-issue-161549.rKq8Lw.rst @@ -0,0 +1,2 @@ +Fix a file descriptor leak when :mod:`!_pyrepl.readline` is re-imported in +a terminal. From 3c79c75540397ee188183c6ff82240c9df2fd88a Mon Sep 17 00:00:00 2001 From: Kirill Podoprigora Date: Sat, 7 Nov 2026 14:11:38 +0000 Subject: [PATCH 2/3] No dup at all --- Lib/_pyrepl/readline.py | 18 ++---------------- Lib/test/test_pyrepl/test_pyrepl.py | 25 ++++--------------------- 2 files changed, 6 insertions(+), 37 deletions(-) diff --git a/Lib/_pyrepl/readline.py b/Lib/_pyrepl/readline.py index 8cee0ec833ad17..751be254c73aa8 100644 --- a/Lib/_pyrepl/readline.py +++ b/Lib/_pyrepl/readline.py @@ -349,29 +349,15 @@ def do(self) -> None: @dataclass(slots=True) class _ReadlineWrapper: - f_in: int = -1 - f_out: int = -1 + f_in: int = 0 + f_out: int = 1 reader: ReadlineAlikeReader | None = field(default=None, repr=False) saved_history_length: int = -1 startup_hook: Callback | None = None config: ReadlineConfig = field(default_factory=ReadlineConfig, repr=False) - owned_fds: list[int] = field(default_factory=list, init=False, repr=False) - - def __del__(self, _close=os.close) -> None: - for fd in self.owned_fds: - try: - _close(fd) - except OSError: - pass def get_reader(self) -> ReadlineAlikeReader: if self.reader is None: - if self.f_in == -1: - self.f_in = os.dup(0) - self.owned_fds.append(self.f_in) - if self.f_out == -1: - self.f_out = os.dup(1) - self.owned_fds.append(self.f_out) console = Console(self.f_in, self.f_out, encoding=ENCODING) self.reader = ReadlineAlikeReader(console=console, config=self.config) return self.reader diff --git a/Lib/test/test_pyrepl/test_pyrepl.py b/Lib/test/test_pyrepl/test_pyrepl.py index a2636deb76e0c5..2db0c6a19b08ed 100644 --- a/Lib/test/test_pyrepl/test_pyrepl.py +++ b/Lib/test/test_pyrepl/test_pyrepl.py @@ -20,7 +20,6 @@ captured_stdout, captured_stderr, force_not_colorized, - gc_collect, make_clean_env, Py_DEBUG, ) @@ -2728,36 +2727,20 @@ def test_exact_width_line_does_not_wrap(self): @skipUnless(pty, "requires pty") class TestReadlineWrapperFileDescriptors(TestCase): - def setUp(self): - controller, self.worker = pty.openpty() + def test_reader_does_not_open_file_descriptors(self): + controller, worker = pty.openpty() self.addCleanup(os.close, controller) - self.addCleanup(os.close, self.worker) + self.addCleanup(os.close, worker) env = self.enterContext(EnvironmentVarGuard()) env["TERM"] = "ansi" - - def redirect_stdio_to_pty(self): sys.stdout.flush() for fd in (0, 1): saved = os.dup(fd) self.addCleanup(os.close, saved) self.addCleanup(os.dup2, saved, fd) - os.dup2(self.worker, fd) + os.dup2(worker, fd) - def test_dupped_fds_are_closed_with_wrapper(self): - self.redirect_stdio_to_pty() before = fd_count() wrapper = _ReadlineWrapper() - self.assertEqual(fd_count(), before) - wrapper.get_reader() - self.assertEqual(fd_count(), before + 2) - del wrapper - gc_collect() - self.assertEqual(fd_count(), before) - - def test_given_fds_are_not_closed_with_wrapper(self): - before = fd_count() - wrapper = _ReadlineWrapper(f_in=self.worker, f_out=self.worker) wrapper.get_reader() - del wrapper - gc_collect() self.assertEqual(fd_count(), before) From 675df8a1cc4ed050648b7cb0f044b13dbe5fdfe4 Mon Sep 17 00:00:00 2001 From: Kirill Podoprigora Date: Sat, 7 Nov 2026 15:43:34 +0000 Subject: [PATCH 3/3] Skip unless os.openpty is available --- Lib/test/test_pyrepl/test_pyrepl.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Lib/test/test_pyrepl/test_pyrepl.py b/Lib/test/test_pyrepl/test_pyrepl.py index 2db0c6a19b08ed..d5dd960b40f6a2 100644 --- a/Lib/test/test_pyrepl/test_pyrepl.py +++ b/Lib/test/test_pyrepl/test_pyrepl.py @@ -2725,10 +2725,10 @@ def test_exact_width_line_does_not_wrap(self): self.assertEqual(console.posxy, (width - 1, y)) -@skipUnless(pty, "requires pty") +@skipUnless(hasattr(os, "openpty"), "need os.openpty()") class TestReadlineWrapperFileDescriptors(TestCase): def test_reader_does_not_open_file_descriptors(self): - controller, worker = pty.openpty() + controller, worker = os.openpty() self.addCleanup(os.close, controller) self.addCleanup(os.close, worker) env = self.enterContext(EnvironmentVarGuard())