Skip to content

Commit f85412e

Browse files
committed
Fix leak of file descriptors
1 parent cbaba02 commit f85412e

3 files changed

Lines changed: 54 additions & 6 deletions

File tree

‎Lib/_pyrepl/readline.py‎

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -355,15 +355,23 @@ class _ReadlineWrapper:
355355
saved_history_length: int = -1
356356
startup_hook: Callback | None = None
357357
config: ReadlineConfig = field(default_factory=ReadlineConfig, repr=False)
358+
owned_fds: list[int] = field(default_factory=list, init=False, repr=False)
358359

359-
def __post_init__(self) -> None:
360-
if self.f_in == -1:
361-
self.f_in = os.dup(0)
362-
if self.f_out == -1:
363-
self.f_out = os.dup(1)
360+
def __del__(self, _close=os.close) -> None:
361+
for fd in self.owned_fds:
362+
try:
363+
_close(fd)
364+
except OSError:
365+
pass
364366

365367
def get_reader(self) -> ReadlineAlikeReader:
366368
if self.reader is None:
369+
if self.f_in == -1:
370+
self.f_in = os.dup(0)
371+
self.owned_fds.append(self.f_in)
372+
if self.f_out == -1:
373+
self.f_out = os.dup(1)
374+
self.owned_fds.append(self.f_out)
367375
console = Console(self.f_in, self.f_out, encoding=ENCODING)
368376
self.reader = ReadlineAlikeReader(console=console, config=self.config)
369377
return self.reader

‎Lib/test/test_pyrepl/test_pyrepl.py‎

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,13 @@
2020
captured_stdout,
2121
captured_stderr,
2222
force_not_colorized,
23+
gc_collect,
2324
make_clean_env,
2425
Py_DEBUG,
2526
)
2627
from test.support import has_subprocess_support, SHORT_TIMEOUT, STDLIB_DIR
2728
from test.support.import_helper import import_module
28-
from test.support.os_helper import EnvironmentVarGuard, unlink
29+
from test.support.os_helper import EnvironmentVarGuard, fd_count, unlink
2930

3031
from .support import (
3132
FakeConsole,
@@ -2723,3 +2724,40 @@ def test_exact_width_line_does_not_wrap(self):
27232724
console, wc = self._make_mock_console(width=width)
27242725
self._apply_changed_line(console, wc, y, "", "a" * width)
27252726
self.assertEqual(console.posxy, (width - 1, y))
2727+
2728+
2729+
@skipUnless(pty, "requires pty")
2730+
class TestReadlineWrapperFileDescriptors(TestCase):
2731+
def setUp(self):
2732+
controller, self.worker = pty.openpty()
2733+
self.addCleanup(os.close, controller)
2734+
self.addCleanup(os.close, self.worker)
2735+
env = self.enterContext(EnvironmentVarGuard())
2736+
env["TERM"] = "ansi"
2737+
2738+
def redirect_stdio_to_pty(self):
2739+
sys.stdout.flush()
2740+
for fd in (0, 1):
2741+
saved = os.dup(fd)
2742+
self.addCleanup(os.close, saved)
2743+
self.addCleanup(os.dup2, saved, fd)
2744+
os.dup2(self.worker, fd)
2745+
2746+
def test_dupped_fds_are_closed_with_wrapper(self):
2747+
self.redirect_stdio_to_pty()
2748+
before = fd_count()
2749+
wrapper = _ReadlineWrapper()
2750+
self.assertEqual(fd_count(), before)
2751+
wrapper.get_reader()
2752+
self.assertEqual(fd_count(), before + 2)
2753+
del wrapper
2754+
gc_collect()
2755+
self.assertEqual(fd_count(), before)
2756+
2757+
def test_given_fds_are_not_closed_with_wrapper(self):
2758+
before = fd_count()
2759+
wrapper = _ReadlineWrapper(f_in=self.worker, f_out=self.worker)
2760+
wrapper.get_reader()
2761+
del wrapper
2762+
gc_collect()
2763+
self.assertEqual(fd_count(), before)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Fix a file descriptor leak when :mod:`!_pyrepl.readline` is re-imported in
2+
a terminal.

0 commit comments

Comments
 (0)