Skip to content

gh-140025: Fix queue.SimpleQueue.__sizeof__() #143137

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
kumaraditya303 merged 11 commits into from
Jan 8, 2026
Merged

gh-140025: Fix queue.SimpleQueue.__sizeof__() #143137

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
4d03baf
implement __sizeof__ for SimpleQueue to account for ring-buffer storage
Aniketsy Dec 24, 2025
b2b05ea
implement __sizeof__ for SimpleQueue to account for ring-buffer storage
Aniketsy Dec 24, 2025
205fd00
implement __sizeof__ for SimpleQueue to account for ring-buffer storage
Aniketsy Dec 24, 2025
21014aa
implement __sizeof__ for SimpleQueue to account for ring-buffer storage
Aniketsy Jan 2, 2026
de68f62
📜🤖 Added by blurb_it.
blurb-it[bot] Jan 2, 2026
654673a
Update Lib/test/test_queue.py
Aniketsy Jan 3, 2026
de5b4c7
Update Misc/NEWS.d/next/Library/2026-01-02-09-32-43.gh-issue-140025.z…
Aniketsy Jan 3, 2026
9e67b66
Update Modules/_queuemodule.c
Aniketsy Jan 3, 2026
034a9cd
implement __sizeof__ for SimpleQueue to account for ring-buffer storage
Aniketsy Jan 3, 2026
887af43
Update Misc/NEWS.d/next/Library/2026-01-02-09-32-43.gh-issue-140025.z…
Aniketsy Jan 4, 2026
7ba914f
Merge branch 'main' into fix-140025
kumaraditya303 Jan 8, 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
11 changes: 11 additions & 0 deletions Lib/test/test_queue.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
from test.support import gc_collect, bigmemtest
from test.support import import_helper
from test.support import threading_helper
import ctypes

# queue module depends on threading primitives
threading_helper.requires_working_threading(module=True)
Expand Down Expand Up @@ -1031,6 +1032,16 @@ def test_is_default(self):
self.assertIs(self.type2test, self.queue.SimpleQueue)
self.assertIs(self.type2test, self.queue.SimpleQueue)

def test_simplequeue_sizeof_reflects_buffer_growth(self):
q = self.type2test()
before = q.__sizeof__()
Copy link
Copy Markdown
Contributor

@colesbury colesbury Dec 24, 2025

Choose a reason for hiding this comment

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

A few changes:

  1. Don't use ctypes (no support for that in wasi)
  2. Use support.calcobjsize
  3. Use sys.getsizeof() instead of calling __sizeof__ directly

for _ in range(1000):
q.put(object())
after = q.__sizeof__()
self.assertGreater(after, before)
ptr = ctypes.sizeof(ctypes.c_void_p)
self.assertEqual((after - before) % ptr, 0)

def test_reentrancy(self):
# bpo-14976: put() may be called reentrantly in an asynchronous
# callback.
Expand Down
13 changes: 13 additions & 0 deletions Modules/_queuemodule.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,18 @@ simplequeue_traverse(PyObject *op, visitproc visit, void *arg)
Py_VISIT(Py_TYPE(self));
return 0;
}
static PyObject *
simplequeue_sizeof(PyObject *op, PyObject *Py_UNUSED(ignored))
{
Copy link
Copy Markdown
Contributor

@colesbury colesbury Dec 24, 2025

Choose a reason for hiding this comment

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

This needs a critical section (a lock for the queue). The simplest way is to use "Argument Clinic" like the other functions.

Something like:

/*[clinic input]
@critical_section
_queue.SimpleQueue.__sizeof__ -> Py_ssize_t

Returns size in memory, in bytes.
[clinic start generated code]*/

static Py_ssize_t
simplequeue_sizeof_impl(simplequeueobject *self)
/*[clinic end generated code: output=3303f008eaa6a0a5 input=9b51620c76fc4507]*/

Then run make clinic to regenerate the bindings.

simplequeueobject *self = simplequeueobject_CAST(op);
Py_ssize_t size = Py_TYPE(self)->tp_basicsize;

if (self->buf.items != NULL) {
size += (Py_ssize_t)self->buf.items_cap * (Py_ssize_t)sizeof(PyObject *);
}

return PyLong_FromSsize_t(size);
}

/*[clinic input]
@classmethod
Expand Down Expand Up @@ -534,6 +546,7 @@ static PyMethodDef simplequeue_methods[] = {
_QUEUE_SIMPLEQUEUE_PUT_METHODDEF
_QUEUE_SIMPLEQUEUE_PUT_NOWAIT_METHODDEF
_QUEUE_SIMPLEQUEUE_QSIZE_METHODDEF
{"__sizeof__", (PyCFunction)simplequeue_sizeof, METH_NOARGS, NULL},
Copy link
Copy Markdown
Contributor

@colesbury colesbury Dec 24, 2025

Choose a reason for hiding this comment

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

You'll also need to change this to use the Argument Clinic methoddef (like above).

{"__class_getitem__", Py_GenericAlias,
METH_O|METH_CLASS, PyDoc_STR("See PEP 585")},
{NULL, NULL} /* sentinel */
Expand Down
Loading