[3.12] gh-111495: Add tests for PyList C API (GH-111562)

Lib/test/test_capi/test_list.py

@@ -0,0 +1,277 @@
+import unittest
+import sys
+from test.support import import_helper
+from collections import UserList
+_testcapi = import_helper.import_module('_testcapi')
+
+NULL = None
+PY_SSIZE_T_MIN = _testcapi.PY_SSIZE_T_MIN
+PY_SSIZE_T_MAX = _testcapi.PY_SSIZE_T_MAX
+
+class ListSubclass(list):
+    pass
+
+
+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_get_size(self):
+        # Test PyList_GET_SIZE()
+        size = _testcapi.list_get_size
+        self.assertEqual(size([1, 2]), 2)
+        self.assertEqual(size(ListSubclass([1, 2])), 2)
+        # CRASHES size(object())
+        # CRASHES size(23)
+        # CRASHES size({})
+        # CRASHES size(UserList())
+        # CRASHES size(NULL)
+
+
+    def test_list_getitem(self):
+        # Test PyList_GetItem()
+        getitem = _testcapi.list_getitem
+        lst = [1, 2, 3]
+        self.assertEqual(getitem(lst, 0), 1)
+        self.assertEqual(getitem(lst, 2), 3)
+        self.assertRaises(IndexError, getitem, lst, 3)
+        self.assertRaises(IndexError, getitem, lst, -1)
+        self.assertRaises(IndexError, getitem, lst, PY_SSIZE_T_MIN)
+        self.assertRaises(IndexError, getitem, lst, PY_SSIZE_T_MAX)
+        self.assertRaises(SystemError, getitem, 42, 1)
+        self.assertRaises(SystemError, getitem, (1, 2, 3), 1)
+        self.assertRaises(SystemError, getitem, {1: 2}, 1)
+
+        # CRASHES getitem(NULL, 1)
+
+    def test_list_get_item(self):
+        # Test PyList_GET_ITEM()
+        get_item = _testcapi.list_get_item
+        lst = [1, 2, [1, 2, 3]]
+        self.assertEqual(get_item(lst, 0), 1)
+        self.assertEqual(get_item(lst, 2), [1, 2, 3])
+
+        # CRASHES for out of index: get_item(lst, 3)
+        # CRASHES for get_item(lst, PY_SSIZE_T_MIN)
+        # CRASHES for get_item(lst, PY_SSIZE_T_MAX)
+        # CRASHES get_item(21, 2)
+        # CRASHES get_item(NULL, 1)
+
+
+    def test_list_setitem(self):
+        # Test PyList_SetItem()
+        setitem = _testcapi.list_setitem
+        lst = [1, 2, 3]
+        setitem(lst, 0, 10)
+        self.assertEqual(lst, [10, 2, 3])
+        setitem(lst, 2, 12)
+        self.assertEqual(lst, [10, 2, 12])
+        self.assertRaises(IndexError, setitem, lst, 3 , 5)
+        self.assertRaises(IndexError, setitem, lst, -1, 5)
+        self.assertRaises(IndexError, setitem, lst, PY_SSIZE_T_MIN, 5)
+        self.assertRaises(IndexError, setitem, lst, PY_SSIZE_T_MAX, 5)
+        self.assertRaises(SystemError, setitem, (1, 2, 3), 1, 5)
+        self.assertRaises(SystemError, setitem, {1: 2}, 1, 5)
+
+        # CRASHES setitem(NULL, 'a', 5)
+
+    def test_list_set_item(self):
+        # Test PyList_SET_ITEM()
+        set_item = _testcapi.list_set_item
+        lst = [1, 2, 3]
+        set_item(lst, 1, 10)
+        set_item(lst, 2, [1, 2, 3])
+        self.assertEqual(lst, [1, 10, [1, 2, 3]])
+
+        # CRASHES for set_item([1], -1, 5)
+        # CRASHES for set_item([1], PY_SSIZE_T_MIN, 5)
+        # CRASHES for set_item([1], PY_SSIZE_T_MAX, 5)
+        # CRASHES for set_item([], 0, 1)
+        # CRASHES for set_item(NULL, 0, 1)
+
+
+    def test_list_insert(self):
+        # Test PyList_Insert()
+        insert = _testcapi.list_insert
+        lst = [1, 2, 3]
+        insert(lst, 0, 23)
+        self.assertEqual(lst, [23, 1, 2, 3])
+        insert(lst, -1, 22)
+        self.assertEqual(lst, [23, 1, 2, 22, 3])
+        insert(lst, PY_SSIZE_T_MIN, 1)
+        self.assertEqual(lst[0], 1)
+        insert(lst, len(lst), 123)
+        self.assertEqual(lst[-1], 123)
+        insert(lst, len(lst)-1, 124)
+        self.assertEqual(lst[-2], 124)
+        insert(lst, PY_SSIZE_T_MAX, 223)
+        self.assertEqual(lst[-1], 223)
+
+        self.assertRaises(SystemError, insert, (1, 2, 3), 1, 5)
+        self.assertRaises(SystemError, insert, {1: 2}, 1, 5)
+
+        # CRASHES insert(NULL, 1, 5)
+
+    def test_list_append(self):
+        # Test PyList_Append()
+        append = _testcapi.list_append
+        lst = [1, 2, 3]
+        append(lst, 10)
+        self.assertEqual(lst, [1, 2, 3, 10])
+        append(lst, [4, 5])
+        self.assertEqual(lst, [1, 2, 3, 10, [4, 5]])
+        self.assertRaises(SystemError, append, lst, NULL)
+        self.assertRaises(SystemError, append, (), 0)
+        self.assertRaises(SystemError, append, 42, 0)
+        # CRASHES append(NULL, 0)
+
+    def test_list_getslice(self):
+        # Test PyList_GetSlice()
+        getslice = _testcapi.list_getslice
+        lst = [1, 2, 3]
+
+        # empty
+        self.assertEqual(getslice(lst, PY_SSIZE_T_MIN, 0), [])
+        self.assertEqual(getslice(lst, -1, 0), [])
+        self.assertEqual(getslice(lst, 3, PY_SSIZE_T_MAX), [])
+
+        # slice
+        self.assertEqual(getslice(lst, 1, 3), [2, 3])
+
+        # whole
+        self.assertEqual(getslice(lst, 0, len(lst)), lst)
+        self.assertEqual(getslice(lst, 0, 100), lst)
+        self.assertEqual(getslice(lst, -100, 100), lst)
+
+        self.assertRaises(SystemError, getslice, (1, 2, 3), 0, 0)
+        self.assertRaises(SystemError, getslice, 'abc', 0, 0)
+        self.assertRaises(SystemError, getslice, 42, 0, 0)
+
+        # CRASHES getslice(NULL, 0, 0)
+
+    def test_list_setslice(self):
+        # Test PyList_SetSlice()
+        setslice = _testcapi.list_setslice
+        def set_slice(lst, low, high, value):
+            lst = lst.copy()
+            self.assertEqual(setslice(lst, low, high, value), 0)
+            return lst
+
+        # insert items
+        self.assertEqual(set_slice([], 0, 0, list("abc")), list("abc"))
+        self.assertEqual(set_slice([], PY_SSIZE_T_MIN, PY_SSIZE_T_MIN, list("abc")), list("abc"))
+        self.assertEqual(set_slice([], PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, list("abc")), list("abc"))
+        lst = list("abc")
+        self.assertEqual(set_slice(lst, 0, 0, ["X"]), list("Xabc"))
+        self.assertEqual(set_slice(lst, 1, 1, list("XY")), list("aXYbc"))
+        self.assertEqual(set_slice(lst, len(lst), len(lst), ["X"]), list("abcX"))
+        # self.assertEqual(set_slice(lst, PY_SSIZE_T_MAX, PY_SSIZE_T_MAX, ["X"]), list("abcX"))
+
+        # replace items
+        lst = list("abc")
+        self.assertEqual(set_slice(lst, -100, 1, list("X")), list("Xbc"))
+        self.assertEqual(set_slice(lst, 1, 2, list("X")), list("aXc"))
+        self.assertEqual(set_slice(lst, 1, 3, list("XY")), list("aXY"))
+        self.assertEqual(set_slice(lst, 0, 3, list("XYZ")), list("XYZ"))
+
+        # delete items
+        lst = list("abcdef")
+        self.assertEqual(set_slice(lst, 0, len(lst), []), [])
+        self.assertEqual(set_slice(lst, -100, 100, []), [])
+        self.assertEqual(set_slice(lst, 1, 5, []), list("af"))
+        self.assertEqual(set_slice(lst, 3, len(lst), []), list("abc"))
+
+        # delete items with NULL
+        lst = list("abcdef")
+        self.assertEqual(set_slice(lst, 0, len(lst), NULL), [])
+        self.assertEqual(set_slice(lst, 3, len(lst), NULL), list("abc"))
+
+        self.assertRaises(SystemError, setslice, (), 0, 0, [])
+        self.assertRaises(SystemError, setslice, 42, 0, 0, [])
+
+        # CRASHES setslice(NULL, 0, 0, [])
+
+    def test_list_sort(self):
+        # Test PyList_Sort()
+        sort = _testcapi.list_sort
+        lst = [4, 6, 7, 3, 1, 5, 9, 2, 0, 8]
+        sort(lst)
+        self.assertEqual(lst, list(range(10)))
+
+        lst2 = ListSubclass([4, 6, 7, 3, 1, 5, 9, 2, 0, 8])
+        sort(lst2)
+        self.assertEqual(lst2, list(range(10)))
+
+        self.assertRaises(SystemError, sort, ())
+        self.assertRaises(SystemError, sort, object())
+        self.assertRaises(SystemError, sort, NULL)
+
+
+    def test_list_reverse(self):
+        # Test PyList_Reverse()
+        reverse = _testcapi.list_reverse
+        def list_reverse(lst):
+            self.assertEqual(reverse(lst), 0)
+            return lst
+
+        self.assertEqual(list_reverse([]), [])
+        self.assertEqual(list_reverse([2, 5, 10]), [10, 5, 2])
+
+        self.assertRaises(SystemError, reverse, ())
+        self.assertRaises(SystemError, reverse, object())
+        self.assertRaises(SystemError, reverse, NULL)
+
+    def test_list_astuple(self):
+        # Test PyList_AsTuple()
+        astuple = _testcapi.list_astuple
+        self.assertEqual(astuple([]), ())
+        self.assertEqual(astuple([2, 5, 10]), (2, 5, 10))
+
+        self.assertRaises(SystemError, astuple, ())
+        self.assertRaises(SystemError, astuple, object())
+        self.assertRaises(SystemError, astuple, NULL)