Skip to content
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

Jump to bottom

Add PyMapping_HasKeyWithError() function #73

Merged
merged 2 commits into from
Sep 19, 2023
Merged

Add PyMapping_HasKeyWithError() function #73

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e77bbaf
Add PyMapping_HasKeyWithError() function
vstinner Sep 18, 2023
d8ce583
Fix UNINITIALIZED_OBJ
vstinner Sep 19, 2023
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
8 changes: 8 additions & 0 deletions docs/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,14 @@ Python 3.13

See `PyMapping_GetOptionalItemString() documentation <https://docs.python.org/dev/c-api/mapping.html#c.PyMapping_GetOptionalItemString>`__.

.. c:function:: int PyMapping_HasKeyWithError(PyObject *obj, PyObject *key)

See `PyMapping_HasKeyWithError() documentation <https://docs.python.org/dev/c-api/mapping.html#c.PyMapping_HasKeyWithError>`__.

.. c:function:: int PyMapping_HasKeyStringWithError(PyObject *obj, const char *key)

See `PyMapping_HasKeyStringWithError() documentation <https://docs.python.org/dev/c-api/mapping.html#c.PyMapping_HasKeyStringWithError>`__.

.. c:function:: int PyModule_Add(PyObject *module, const char *name, PyObject *value)

See `PyModule_Add() documentation <https://docs.python.org/dev/c-api/module.html#c.PyModule_Add>`__.
Expand Down
26 changes: 25 additions & 1 deletion pythoncapi_compat.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,8 @@ PyObject_GetOptionalAttrString(PyObject *obj, const char *name, PyObject **resul
#endif


// gh-106307 added PyObject_GetOptionalAttr() to Python 3.13.0a1
// gh-106307 added PyObject_GetOptionalAttr() and
// PyMapping_GetOptionalItemString() to Python 3.13.0a1
#if PY_VERSION_HEX < 0x030D00A1
static inline int
PyMapping_GetOptionalItem(PyObject *obj, PyObject *key, PyObject **result)
Expand All @@ -738,6 +739,7 @@ PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **resul
key_obj = PyString_FromString(key);
#endif
if (key_obj == NULL) {
*result = NULL;
return -1;
}
rc = PyMapping_GetOptionalItem(obj, key_obj, result);
Expand All @@ -746,6 +748,28 @@ PyMapping_GetOptionalItemString(PyObject *obj, const char *key, PyObject **resul
}
#endif

// gh-108511 added PyMapping_HasKeyWithError() and
// PyMapping_HasKeyStringWithError() to Python 3.13.0a1
#if PY_VERSION_HEX < 0x030D00A1
static inline int
PyMapping_HasKeyWithError(PyObject *obj, PyObject *key)
{
PyObject *res;
int rc = PyMapping_GetOptionalItem(obj, key, &res);
Py_XDECREF(res);
return rc;
}

static inline int
PyMapping_HasKeyStringWithError(PyObject *obj, const char *key)
{
PyObject *res;
int rc = PyMapping_GetOptionalItemString(obj, key, &res);
Py_XDECREF(res);
return rc;
}
#endif


// gh-106004 added PyDict_GetItemRef() and PyDict_GetItemStringRef()
// to Python 3.13.0a1
Expand Down
69 changes: 46 additions & 23 deletions tests/test_pythoncapi_compat_cext.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@
# define ASSERT_REFCNT(expr)
#endif

// Marker to check that pointer value was set
static const char uninitialized[] = "uninitialized";
#define UNINITIALIZED_OBJ ((PyObject *)uninitialized)


static PyObject*
create_string(const char *str)
Expand Down Expand Up @@ -806,7 +810,7 @@ test_weakref(PyObject *Py_UNUSED(module), PyObject *Py_UNUSED(args))
}

// test PyWeakref_GetRef(), reference is alive
PyObject *ref = Py_True; // marker to check that value was set
PyObject *ref = UNINITIALIZED_OBJ;
assert(PyWeakref_GetRef(weakref, &ref) == 1);
assert(ref == obj);
assert(Py_REFCNT(obj) == (refcnt + 1));
Expand Down Expand Up @@ -1016,28 +1020,28 @@ test_getattr(PyObject *Py_UNUSED(module), PyObject *Py_UNUSED(args))

// test PyObject_GetOptionalAttr(): attribute exists
attr_name = create_string("version");
value = Py_True; // marker value
value = UNINITIALIZED_OBJ;
assert(PyObject_GetOptionalAttr(obj, attr_name, &value) == 1);
assert(value != _Py_NULL);
Py_DECREF(value);
Py_DECREF(attr_name);

// test PyObject_GetOptionalAttrString(): attribute exists
value = Py_True; // marker value
value = UNINITIALIZED_OBJ;
assert(PyObject_GetOptionalAttrString(obj, "version", &value) == 1);
assert(value != _Py_NULL);
Py_DECREF(value);

// test PyObject_GetOptionalAttr(): attribute doesn't exist
attr_name = create_string("nonexistant_attr_name");
value = Py_True; // marker value
value = UNINITIALIZED_OBJ;
assert(PyObject_GetOptionalAttr(obj, attr_name, &value) == 0);
assert(value == _Py_NULL);
Py_DECREF(attr_name);
assert(!PyErr_Occurred());

// test PyObject_GetOptionalAttrString(): attribute doesn't exist
value = Py_True; // marker value
value = UNINITIALIZED_OBJ;
assert(PyObject_GetOptionalAttrString(obj, "nonexistant_attr_name", &value) == 0);
assert(value == _Py_NULL);
assert(!PyErr_Occurred());
Expand All @@ -1056,37 +1060,56 @@ test_getitem(PyObject *Py_UNUSED(module), PyObject *Py_UNUSED(args))
assert(value != _Py_NULL);
PyObject *obj = Py_BuildValue("{sO}", "key", value);
assert(obj != _Py_NULL);
PyObject *key;
PyObject *present_key, *missing_key;
PyObject *item;

present_key = create_string("key");
missing_key = create_string("dontexist");

// test PyMapping_GetOptionalItem(): key is present
key = create_string("key");
item = Py_True; // marker value
assert(PyMapping_GetOptionalItem(obj, key, &item) == 1);
item = UNINITIALIZED_OBJ;
assert(PyMapping_GetOptionalItem(obj, present_key, &item) == 1);
assert(item == value);
Py_DECREF(item);
Py_DECREF(key);
assert(!PyErr_Occurred());

// test PyMapping_HasKeyWithError(): key is present
assert(PyMapping_HasKeyWithError(obj, present_key) == 1);
assert(!PyErr_Occurred());

// test PyMapping_GetOptionalItemString(): key is present
item = Py_True; // marker value
item = UNINITIALIZED_OBJ;
assert(PyMapping_GetOptionalItemString(obj, "key", &item) == 1);
assert(item == value);
Py_DECREF(item);

// test PyMapping_HasKeyStringWithError(): key is present
assert(PyMapping_HasKeyStringWithError(obj, "key") == 1);
assert(!PyErr_Occurred());

// test PyMapping_GetOptionalItem(): missing key
key = create_string("dontexist");
item = Py_True; // marker value
assert(PyMapping_GetOptionalItem(obj, key, &item) == 0);
item = UNINITIALIZED_OBJ;
assert(PyMapping_GetOptionalItem(obj, missing_key, &item) == 0);
assert(item == _Py_NULL);
Py_DECREF(key);
assert(!PyErr_Occurred());

// test PyMapping_HasKeyWithError(): missing key
assert(PyMapping_HasKeyWithError(obj, missing_key) == 0);
assert(!PyErr_Occurred());

// test PyMapping_GetOptionalItemString(): missing key
item = Py_True; // marker value
item = UNINITIALIZED_OBJ;
assert(PyMapping_GetOptionalItemString(obj, "dontexist", &item) == 0);
assert(item == _Py_NULL);

// test PyMapping_HasKeyStringWithError(): missing key
assert(PyMapping_HasKeyStringWithError(obj, "dontexist") == 0);
assert(!PyErr_Occurred());

Py_DECREF(obj);
Py_DECREF(value);
Py_DECREF(present_key);
Py_DECREF(missing_key);
Py_RETURN_NONE;
}

Expand Down Expand Up @@ -1147,45 +1170,45 @@ test_dict_api(PyObject *Py_UNUSED(module), PyObject *Py_UNUSED(args))
PyErr_Clear();

// test PyDict_GetItemRef(), key is present
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemRef(dict, key, &get_value) == 1);
assert(get_value == value);
Py_DECREF(get_value);

// test PyDict_GetItemStringRef(), key is present
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemStringRef(dict, "key", &get_value) == 1);
assert(get_value == value);
Py_DECREF(get_value);

// test PyDict_GetItemRef(), missing key
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemRef(dict, missing_key, &get_value) == 0);
assert(!PyErr_Occurred());
assert(get_value == NULL);

// test PyDict_GetItemStringRef(), missing key
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemStringRef(dict, "missing_key", &get_value) == 0);
assert(!PyErr_Occurred());
assert(get_value == NULL);

// test PyDict_GetItemRef(), invalid dict
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemRef(invalid_dict, key, &get_value) == -1);
assert(PyErr_ExceptionMatches(PyExc_SystemError));
PyErr_Clear();
assert(get_value == NULL);

// test PyDict_GetItemStringRef(), invalid dict
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemStringRef(invalid_dict, "key", &get_value) == -1);
assert(PyErr_ExceptionMatches(PyExc_SystemError));
PyErr_Clear();
assert(get_value == NULL);

// test PyDict_GetItemRef(), invalid key
get_value = Py_Ellipsis; // marker value
get_value = UNINITIALIZED_OBJ;
assert(PyDict_GetItemRef(dict, invalid_key, &get_value) == -1);
assert(PyErr_ExceptionMatches(PyExc_TypeError));
PyErr_Clear();
Expand Down
Loading