Skip to content

bpo-44172: Keep reference to original window in curses subwindow objects#26226

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

Merged
serhiy-storchaka merged 5 commits into from
May 4, 2025
Merged

bpo-44172: Keep reference to original window in curses subwindow objects #26226

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
90a186a
bpo-44172: Keep reference to original window in curses subwindow objects
michaelforney May 19, 2021
423bf28
Merge branch 'main' into curses-orig
serhiy-storchaka Apr 12, 2025
b04218b
Add a test.
serhiy-storchaka Apr 12, 2025
fac2acc
Add visitor in tp_traverse.
serhiy-storchaka Apr 12, 2025
0478d17
Update the NEWS entry.
serhiy-storchaka Apr 12, 2025
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
3 changes: 2 additions & 1 deletion Include/py_curses.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -75,10 +75,11 @@ extern "C"{

/* Type declarations */

typedef struct{
typedef struct PyCursesWindowObject {
PyObject_HEAD
WINDOW *win;
char *encoding;
struct PyCursesWindowObject *orig;
} PyCursesWindowObject;

#define PyCurses_CAPSULE_NAME "_curses._C_API"
Expand Down
11 changes: 10 additions & 1 deletion Lib/test/test_curses.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,7 +8,8 @@
from unittest.mock import MagicMock

from test.support import (requires, verbose, SaveSignals, cpython_only,
check_disallow_instantiation, MISSING_C_DOCSTRINGS)
check_disallow_instantiation, MISSING_C_DOCSTRINGS,
gc_collect)
from test.support.import_helper import import_module

# Optionally test curses module. This currently requires that the
Expand DownExpand Up@@ -181,6 +182,14 @@ def test_create_windows(self):
self.assertEqual(win3.getparyx(), (2, 1))
self.assertEqual(win3.getmaxyx(), (6, 11))

def test_subwindows_references(self):
win = curses.newwin(5, 10)
win2 = win.subwin(3, 7)
del win
gc_collect()
del win2
gc_collect()

def test_move_cursor(self):
stdscr = self.stdscr
win = stdscr.subwin(10, 15, 2, 5)
Expand Down
2 changes: 2 additions & 0 deletions Misc/NEWS.d/next/Library/2021-05-18-19-12-58.bpo-44172.rJ_-CI.rst
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
Keep a reference to original :mod:`curses` windows in subwindows so
that the original window does not get deleted before subwindows.
22 changes: 14 additions & 8 deletions Modules/_cursesmodule.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -787,7 +787,8 @@ Window_TwoArgNoReturnFunction(wresize, int, "ii;lines,columns")

static PyObject *
PyCursesWindow_New(cursesmodule_state *state,
WINDOW *win, const char *encoding)
WINDOW *win, const char *encoding,
PyCursesWindowObject *orig)
{
if (encoding == NULL){
#if defined(MS_WINDOWS)
Expand DownExpand Up@@ -821,6 +822,8 @@ PyCursesWindow_New(cursesmodule_state *state,
PyErr_NoMemory();
return NULL;
}
wo->orig = orig;
Py_XINCREF(orig);
PyObject_GC_Track((PyObject *)wo);
return (PyObject *)wo;
}
Expand All@@ -838,6 +841,7 @@ PyCursesWindow_dealloc(PyObject *self)
if (wo->encoding != NULL){
PyMem_Free(wo->encoding);
}
Py_XDECREF(wo->orig);
window_type->tp_free(self);
Py_DECREF(window_type);
}
Expand All@@ -846,6 +850,8 @@ static int
PyCursesWindow_traverse(PyObject *self, visitproc visit, void *arg)
{
Py_VISIT(Py_TYPE(self));
PyCursesWindowObject *wo = (PyCursesWindowObject *)self;
Py_VISIT(wo->orig);
return 0;
}

Expand DownExpand Up@@ -1453,7 +1459,7 @@ _curses_window_derwin_impl(PyCursesWindowObject *self, int group_left_1,
}

cursesmodule_state *state = get_cursesmodule_state_by_win(self);
return PyCursesWindow_New(state, win, NULL);
return PyCursesWindow_New(state, win, NULL, self);
}

/*[clinic input]
Expand DownExpand Up@@ -2493,7 +2499,7 @@ _curses_window_subwin_impl(PyCursesWindowObject *self, int group_left_1,
}

cursesmodule_state *state = get_cursesmodule_state_by_win(self);
return PyCursesWindow_New(state, win, self->encoding);
return PyCursesWindow_New(state, win, self->encoding, self);
}

/*[clinic input]
Expand DownExpand Up@@ -3237,7 +3243,7 @@ _curses_getwin(PyObject *module, PyObject *file)
goto error;
}
cursesmodule_state *state = get_cursesmodule_state(module);
res = PyCursesWindow_New(state, win, NULL);
res = PyCursesWindow_New(state, win, NULL, NULL);

error:
fclose(fp);
Expand DownExpand Up@@ -3410,7 +3416,7 @@ _curses_initscr_impl(PyObject *module)
if (curses_initscr_called){
wrefresh(stdscr);
cursesmodule_state *state = get_cursesmodule_state(module);
return PyCursesWindow_New(state, stdscr, NULL);
return PyCursesWindow_New(state, stdscr, NULL, NULL);
}

win = initscr();
Expand DownExpand Up@@ -3514,7 +3520,7 @@ _curses_initscr_impl(PyObject *module)
#undef SetDictInt

cursesmodule_state *state = get_cursesmodule_state(module);
PyObject *winobj = PyCursesWindow_New(state, win, NULL);
PyObject *winobj = PyCursesWindow_New(state, win, NULL, NULL);
if (winobj == NULL){
return NULL;
}
Expand DownExpand Up@@ -3898,7 +3904,7 @@ _curses_newpad_impl(PyObject *module, int nlines, int ncols)
}

cursesmodule_state *state = get_cursesmodule_state(module);
return PyCursesWindow_New(state, win, NULL);
return PyCursesWindow_New(state, win, NULL, NULL);
}

/*[clinic input]
Expand DownExpand Up@@ -3939,7 +3945,7 @@ _curses_newwin_impl(PyObject *module, int nlines, int ncols,
}

cursesmodule_state *state = get_cursesmodule_state(module);
return PyCursesWindow_New(state, win, NULL);
return PyCursesWindow_New(state, win, NULL, NULL);
}

/*[clinic input]
Expand Down
Loading