8000 gh-111495: Add tests for PyList C API by rawwar · Pull Request #111562 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-111495: Add tests for PyList C API #111562

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.

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 33 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from 15 commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
d43d9b2
init test c file
rawwar Oct 31, 2023
119cd0e
single test added
rawwar Oct 31, 2023
ccf1bff
fix lint
rawwar Oct 31, 2023
8d17ca6
fix list check tests
rawwar Oct 31, 2023
bd9415d
lint
rawwar Oct 31, 2023
17d60d1
add 2 tests
rawwar Oct 31, 2023
322eab9
add test
rawwar Oct 31, 2023
5c58022
add getitem test
rawwar Oct 31, 2023
6b12f1f
test list_get_item
rawwar Oct 31, 2023
70e385f
add test for setitem
rawwar Oct 31, 2023
3166ba4
add test for setitem
rawwar Oct 31, 2023
2a50fb8
Merge branch 'kalyan/test-capi-list' of github.com:rawwar/cpython int…
rawwar Oct 31, 2023
1c30f3b
Merge branch 'main' of github.com:rawwar/cpython into kalyan/test-cap…
rawwar Nov 1, 2023
392b3c6
add tests
rawwar Nov 1, 2023
eac8c67
lint fix
rawwar Nov 1, 2023
0f40f6d
add tests
rawwar Nov 1, 2023
40e4022
Update Lib/test/test_capi/test_list.py
rawwar Nov 1, 2023
d31fa57
Update Modules/_testcapi/list.c
rawwar Nov 1, 2023
433351d
Update Lib/test/test_capi/test_list.py
rawwar Nov 1, 2023
34e915b
Update Lib/test/test_capi/test_list.py
rawwar Nov 1, 2023
0e340a1
pr feedback fixes
rawwar Nov 1, 2023
8de9cf8
fixes for the feedback
rawwar Nov 1, 2023
44dcf85
add tests from vstinner PR
rawwar Nov 1, 2023
1000126
Merge branch 'main' into kalyan/test-capi-list
rawwar Nov 1, 2023
2c6a41c
remove unused import
rawwar Nov 1, 2023
e486451
Update list.c
rawwar Nov 1, 2023
633951b
Merge branch 'main' into kalyan/test-capi-list
rawwar Nov 1, 2023
9afa50c
Merge branch 'main' into kalyan/test-capi-list
rawwar Nov 2, 2023
361b045
Merge branch 'main' into kalyan/test-capi-list
rawwar Nov 2, 2023
ca07ac9
Update Modules/_testcapi/list.c
vstinner Nov 8, 2023
dc039f1
Update Modules/_testcapi/list.c
vstinner Nov 8, 2023
5ecfa40
Merge branch 'main' into kalyan/test-capi-list
serhiy-storchaka Nov 8, 2023
42a2a54
Minor fixes.
serhiy-storchaka Nov 8, 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
134 changes: 134 additions & 0 deletions Lib/test/test_capi/test_list.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
import unittest
import sys
from test.support import import_helper
from collections import UserList

_testcapi = import_helper.import_module('_testcapi')

NULL = None

class ListSubclass(list):
...


class CAPITest(unittest.TestCase):
def test_check(self):
# Test PyList_Check()
check = _testcapi.list_check
self.assertTrue(check([1, 2]))
self.assertTrue(check([]))
self.assertTrue(check(ListSubclass([1, 2])))
self.assertFalse(check({1: 2}))
self.assertFalse(check((1, 2)))
self.assertFalse(check(42))
self.assertFalse(check(object()))

# CRASHES check(NULL)


def test_list_check_exact(self):
# Test PyList_CheckExact()
check = _testcapi.list_check_exact
self.assertTrue(check([1]))
self.assertTrue(check([]))
self.assertFalse(check(ListSubclass([1])))
self.assertFalse(check(UserList([1, 2])))
self.assertFalse(check({1: 2}))
self.assertFalse(check(object()))

# CRASHES check(NULL)

def test_list_new(self):
# Test PyList_New()
list_new = _testcapi.list_new
lst = list_new(0)
self.assertEqual(lst, [])
self.assertIs(type(lst), list)
lst2 = list_new(0)
self.assertIsNot(lst2, lst)
self.assertRaises(SystemError, list_new, NULL)
self.assertRaises(SystemError, list_new, -1)

def test_list_size(self):
# Test PyList_Size()
size = _testcapi.list_size
self.assertEqual(size([1, 2]), 2)
self.assertEqual(size(ListSubclass([1, 2])), 2)
self.assertRaises(SystemError, size, UserList())
self.assertRaises(SystemError, size, {})
self.assertRaises(SystemError, size, 23)
self.assertRaises(SystemError, size, object())
# CRASHES size(NULL)


def test_list_getitem(self):
# Test PyList_GetItem()
getitem = _testcapi.list_getitem
lst = [1, 2, NULL]
self.assertEqual(getitem(lst, 0), 1)
self.assertRaises(IndexError, getitem, lst, -1)
self.assertRaises(IndexError, getitem, lst, 10)
Copy link
Member

Choose a reason for hiding this comment

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

Add tests for index equal to the size of the list, PY_SSIZE_T_MIN, PY_SSIZE_T_MAX (imported from _testcapi).

All functions that have Py_ssize_t parameter should be tested with the following values: 0, size-1, -1, size, PY_SSIZE_T_MIN, PY_SSIZE_T_MAX.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For methods like slice, they accept multiple Py_ssize_t parameters. Should each of these parameters be tested with the values you mentioned?

self.assertRaises(SystemError, getitem, 42, 1)

# CRASHES getitem(NULL, 1)

def test_list_get_item(self):
# Test PyList_GET_ITEM()
get_item = _testcapi.list_get_item
lst = [1, 2, NULL]
self.assertEqual(get_item(lst, 0), 1)
self.assertNotEqual(get_item(lst, 1), 12)
# CRASHES for out of index: get_item(lst, 3)
# CRASHES get_item(21, 2)
# CRASHES get_item(Null,1)


def test_list_setitem(self):
# Test PyList_SET_ITEM()
setitem = _testcapi.list_setitem
lst = [1, 2, 3]
setitem(lst, 1, 10)
self.assertEqual(lst[1], 10)
self.assertRaises(IndexError, setitem, [1], -1, 5)
self.assertRaises(TypeError, setitem, lst, 1.5, 10)
self.assertRaises(TypeError, setitem, 23, 'a', 5)
Copy link
Member

Choose a reason for hiding this comment

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

It only tests the wrapper, not the C API function.

self.assertRaises(SystemError, setitem, {}, 0, 5)

# CRASHES setitem(NULL, 'a', 5)

def test_list_insert(self):
# Test PyList_Insert()
insert = _testcapi.list_insert
lst = [1, 2, 3]
insert(lst, 1, 23)
self.assertEqual(lst[1], 23)
insert(lst, -1, 22)
self.assertEqual(lst[-2], 22)
self.assertRaises(TypeError, insert, lst, 1.5, 10)
self.assertRaises(TypeError, insert, 23, 'a', 5)
self.assertRaises(SystemError, insert, {}, 0, 5)
# CRASHES insert(NULL, 'a', 5)

def test_list_append(self):
# Test PyList_Append()
append = _testcapi.list_append
lst = [1, 2, 3]
append(lst, 1)
self.assertEqual(lst[-1], 1)
append(lst, [4,5,6])
self.assertEqual(lst[-1], [4,5,6])
self.assertRaises(SystemError, append, lst, NULL)
# CRASHES append(NULL, 0)

def test_list_getslice(self):
# Test PyList_GetSlice()
getslice = _testcapi.list_getslice
lst = [1,2,3,4,5,6,7,8,9,10]
self.assertEqual(getslice(lst, 0, 3), [1, 2, 3])
self.assertEqual(getslice(lst, 4, 6), [5,6])
self.assertEqual(getslice(lst, 6, 10), [7,8,9,10])
self.assertEqual(getslice(lst, 6, 100), [7,8,9,10])
self.assertNotEqual(getslice(lst, -2, -1), [9])
self.assertRaises(TypeError, lst, 'a', '2')

# CRASHES getslice(NULL, 1, 2)
125 changes: 125 additions & 0 deletions Modules/_testcapi/list.c
Original file line number Diff line number Diff line change
@@ -1,9 +1,134 @@
#include "parts.h"
#include "util.h"

static PyObject *
list_check(PyObject* Py_UNUSED(module), PyObject *obj)
{
NULLABLE(obj);
return PyLong_FromLong(PyList_Check(obj));
}

static PyObject *
list_check_exact(PyObject* Py_UNUSED(module), PyObject *obj)
{
NULLABLE(obj);
return PyLong_FromLong(PyList_CheckExact(obj));
}

static PyObject *
list_new(PyObject* Py_UNUSED(module), PyObject *obj)
{
return PyList_New(PyLong_AsSsize_t(obj));
}

static PyObject *
list_size(PyObject *Py_UNUSED(module), PyObject *obj)
{
NULLABLE(obj);
RETURN_SIZE(PyList_Size(obj));
}

static PyObject *
list_getitem(PyObject *Py_UNUSED(module), PyObject *args)
{
PyObject *obj;
Py_ssize_t i;
if (!PyArg_ParseTuple(args, "On", &obj, &i)){
return NULL;
}
NULLABLE(obj);
return Py_XNewRef(PyList_GetItem(obj, i));
}

static PyObject *
list_get_item(PyObject *Py_UNUSED(module), PyObject *args)
{
PyObject *obj;
Py_ssize_t i;
if (!PyArg_ParseTuple(args, "On", &obj, &i)){
return NULL;
}
NULLABLE(obj);
return Py_XNewRef(PyList_GET_ITEM(obj, i));
}

static PyObject *
list_setitem(PyObject *Py_UNUSED(module), PyObject *args)
{
PyObject *obj, *value;
Py_ssize_t i;
if ( !PyArg_ParseTuple(args, "OnO", &obj, &i, &value)){
return NULL;
}
NULLABLE(obj);
NULLABLE(value);
value = Py_XNewRef(value);
RETURN_INT(PyList_SetItem(obj, i, value));

}

static PyObject *
list_insert(PyObject *Py_UNUSED(module), PyObject *args)
{
PyObject *obj, *value;
Py_ssize_t where;
if ( !PyArg_ParseTuple(args, "OnO", &obj, &where, &value)){
return NULL;
}
NULLABLE(obj);
NULLABLE(value);
value = Py_XNewRef(value);
RETURN_INT(PyList_Insert(obj, where, value));

}

static PyObject *
list_append(PyObject *Py_UNUSED(module), PyObject *args)
{
PyObject *obj, *value;
if ( !PyArg_ParseTuple(args, "OO", &obj, &value)){
return NULL;
}
NULLABLE(obj);
NULLABLE(value);
value = Py_XNewRef(value);
RETURN_INT(PyList_Append(obj, value));
}

static PyObject *
list_getslice(PyObject *Py_UNUSED(module), PyObject *args)
{
PyObject *obj;
Py_ssize_t ilow, ihigh;
if ( !PyArg_ParseTuple(args, "Onn", &obj, &ilow, &ihigh)){
return NULL;
}
NULLABLE(obj);
return PyList_GetSlice(obj, ilow, ihigh);

}




static PyMethodDef test_methods[] = {
{"list_check", list_check, METH_O},
{"list_check_exact", list_check_exact, METH_O},
{"list_new", list_new, METH_O},
{"list_size", list_size, METH_O},
{"list_getitem", list_getitem, METH_VARARGS},
{"list_get_item", list_get_item, METH_VARARGS},
{"list_setitem", list_setitem, METH_VARARGS},
{"list_insert", list_insert, METH_VARARGS},
{"list_append", list_append, METH_VARARGS},
{"list_getslice", list_getslice, METH_VARARGS},
// {"list_set_slice"},
// {"list_sort"},
// {"list_reverse"},
// {"list_as_tuple"},
{NULL},


};

int
Expand Down
0