Skip to content

gh-116946: fully implement GC protocol for _curses_panel.panel #138333

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
merged 8 commits into from
Sep 3, 2025
Merged

gh-116946: fully implement GC protocol for _curses_panel.panel #138333

Changes from 4 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
93694c8
fully implement GC protocol for `_curses_panel.panel`
picnixz Sep 1, 2025
c05db69
address review comment
picnixz Sep 2, 2025
23a9664
explicitly raise PyErr_FormatUnraisable in `tp_clear`
picnixz Sep 2, 2025
13933a9
explicitly raise PyErr_FormatUnraisable in `tp_clear`
picnixz Sep 2, 2025
bfadf5b
fixup
picnixz Sep 2, 2025
49cf9ea
address review
picnixz Sep 2, 2025
3221127
use Py_DECREF when possible
picnixz Sep 2, 2025
39de85b
handle errors from `tp_clear` in `tp_dealloc`
picnixz Sep 2, 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
27 changes: 19 additions & 8 deletions Modules/_curses_panel.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -429,21 +429,30 @@ PyCursesPanel_New(_curses_panel_state *state, PANEL *pan,
return (PyObject *)po;
}

static int
PyCursesPanel_Clear(PyObject *op)
{
PyCursesPanelObject *self = _PyCursesPanelObject_CAST(op);
PyObject *extra = (PyObject *)panel_userptr(self->pan);
if (extra != NULL) {
Py_CLEAR(extra);
if (set_panel_userptr(self->pan, NULL) == ERR) {
curses_panel_panel_set_error(self, "set_panel_userptr", NULL);
PyErr_FormatUnraisable("Exception ignored in tp_clear of %T", op);
}
}
// do NOT clear self->wo yet as there is no cycle to break with it
return 0;
}

static void
PyCursesPanel_Dealloc(PyObject *self)
{
PyTypeObject *tp = Py_TYPE(self);
PyObject_GC_UnTrack(self);

PyCursesPanelObject *po = _PyCursesPanelObject_CAST(self);
PyObject *obj = (PyObject *)panel_userptr(po->pan);
if (obj) {
Py_DECREF(obj);
if (set_panel_userptr(po->pan, NULL) == ERR) {
curses_panel_panel_set_error(po, "set_panel_userptr", "__del__");
PyErr_FormatUnraisable("Exception ignored in PyCursesPanel_Dealloc()");
}
}
(void)PyCursesPanel_Clear(self);
if (del_panel(po->pan) == ERR && !PyErr_Occurred()) {
curses_panel_panel_set_error(po, "del_panel", "__del__");
PyErr_FormatUnraisable("Exception ignored in PyCursesPanel_Dealloc()");
Expand All @@ -464,6 +473,7 @@ PyCursesPanel_Traverse(PyObject *op, visitproc visit, void *arg)
{
PyCursesPanelObject *self = _PyCursesPanelObject_CAST(op);
Py_VISIT(Py_TYPE(op));
Py_VISIT(panel_userptr(self->pan));
Py_VISIT(self->wo);
return 0;
}
Expand Down Expand Up @@ -659,6 +669,7 @@ static PyMethodDef PyCursesPanel_Methods[] = {
/* -------------------------------------------------------*/

static PyType_Slot PyCursesPanel_Type_slots[] = {
{Py_tp_clear, PyCursesPanel_Clear},
{Py_tp_dealloc, PyCursesPanel_Dealloc},
{Py_tp_traverse, PyCursesPanel_Traverse},
{Py_tp_methods, PyCursesPanel_Methods},
Expand Down
Loading