Skip to content

[WIP] bpo-35199: PyTuple_GET_ITEM() becomes a function in debug mode #10435

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

Closed
vstinner wants to merge 1 commit into from
Closed

[WIP] bpo-35199: PyTuple_GET_ITEM() becomes a function in debug mode #10435

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 additions & 2 deletions Include/tupleobject.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,17 @@ PyAPI_FUNC(void) _PyTuple_MaybeUntrack(PyObject *);

/* Macro, trading safety for speed */
#ifndef Py_LIMITED_API
#define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i])
#define PyTuple_GET_SIZE(op) (assert(PyTuple_Check(op)),Py_SIZE(op))

#ifdef Py_DEBUG
PyAPI_FUNC(PyObject*) _PyTuple_GET_ITEM_impl(const PyObject *op, Py_ssize_t i);
PyAPI_FUNC(Py_ssize_t) _PyTuple_GET_SIZE_impl(const PyObject *op);

# define PyTuple_GET_ITEM(op, i) _PyTuple_GET_ITEM_impl((PyObject *)(op), i)
# define PyTuple_GET_SIZE(op) _PyTuple_GET_SIZE_impl((PyObject *)(op))
#else
# define PyTuple_GET_ITEM(op, i) (((PyTupleObject *)(op))->ob_item[i])
# define PyTuple_GET_SIZE(op) (assert(PyTuple_Check(op)),Py_SIZE(op))
#endif

#ifdef Py_BUILD_CORE
# define _PyTuple_ITEMS(op) ((((PyTupleObject *)(op))->ob_item))
Expand Down
4 changes: 4 additions & 0 deletions Misc/NEWS.d/next/C API/2018-11-09-17-00-12.bpo-35199.9LxO8j.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
When Python is compiled in debug mode (Py_DEBUG), PyTuple_GET_ITEM() macro
becomes a function which implements sanity checks using assertions. It
should help to detect misusage of the C API. "&PyTuple_GET_ITEM(op, i)" is
now invalid in debug mode.
20 changes: 20 additions & 0 deletions Objects/tupleobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,16 @@ PyTuple_New(Py_ssize_t size)
return (PyObject *) op;
}

#ifdef Py_DEBUG
Py_ssize_t
_PyTuple_GET_SIZE_impl(const PyObject *op)
{
_PyObject_ASSERT((PyObject *)op, PyTuple_Check(op));
return Py_SIZE(op);

}
#endif

Py_ssize_t
PyTuple_Size(PyObject *op)
{
Expand All @@ -145,6 +155,16 @@ PyTuple_Size(PyObject *op)
return Py_SIZE(op);
}

#ifdef Py_DEBUG
PyObject*
_PyTuple_GET_ITEM_impl(const PyObject *op, Py_ssize_t i)
{
_PyObject_ASSERT((PyObject *)op, PyTuple_Check(op));
assert(0 <= i && i < Py_SIZE(op));
return ((PyTupleObject *)op) -> ob_item[i];
}
#endif

PyObject *
PyTuple_GetItem(PyObject *op, Py_ssize_t i)
{
Expand Down