Merge pull request #1855 from PurityLake/error-key-get-pressed

pgScancodeWrapper now raises exception when trying to use __iter__

Author: oddbookworm

docs/reST/ref/key.rst

@@ -266,6 +266,11 @@ for ``KMOD_NONE``, which should be compared using equals ``==``). For example:
       translate these pushed keys into a fully translated character value. See
       the ``pygame.KEYDOWN`` events on the :mod:`pygame.event` queue for this
       functionality.
+   
+   .. versionchanged:: 2.1.4
+      The collection of bools returned by ``get_pressed`` can not be iterated
+      over because the indexes of the internal tuple does not correspond to the 
+      keycodes.
 
    .. ## pygame.key.get_pressed ##
 

src_c/key.c

@@ -88,6 +88,50 @@ pg_scancodewrapper_subscript(pgScancodeWrapper *self, PyObject *item)
     return ret;
 }
 
+static PyObject *
+pg_iter_raise(PyObject *self)
+{
+    PyErr_SetString(PyExc_TypeError,
+                    "Iterating over key states is not supported");
+    return NULL;
+}
+
+/**
+ * There is an issue in PyPy that causes __iter__ to be called
+ * on creation of a ScancodeWrapper. This stops this from
+ * happening.
+ */
+#ifdef PYPY_VERSION
+static PyObject *
+pg_scancodewrapper_new(PyTypeObject *subtype, PyObject *args, PyObject *kwds)
+{
+    PyObject *tuple = NULL;
+    Py_ssize_t size = PyTuple_Size(args);
+    if (size == 1) {
+        tuple = PyTuple_GET_ITEM(args, 0);
+        if (PyTuple_Check(tuple)) {
+            size = PyTuple_Size(tuple);
+        }
+        else {
+            tuple = NULL;
+        }
+    }
+
+    pgScancodeWrapper *obj =
+        (pgScancodeWrapper *)(subtype->tp_alloc(subtype, size));
+
+    if (obj && tuple) {
+        for (Py_ssize_t i = 0; i < size; ++i) {
+            PyObject *item = PyTuple_GET_ITEM((PyObject *)tuple, i);
+            PyTuple_SET_ITEM((PyObject *)obj, i, item);
+        }
+        Py_DECREF(tuple);
+    }
+
+    return (PyObject *)obj;
+}
+#endif /* PYPY_VERSION */
+
 static PyMappingMethods pg_scancodewrapper_mapping = {
     .mp_subscript = (binaryfunc)pg_scancodewrapper_subscript,
 };
@@ -106,6 +150,11 @@ static PyTypeObject pgScancodeWrapper_Type = {
     PyVarObject_HEAD_INIT(NULL, 0).tp_name = "pygame.key.ScancodeWrapper",
     .tp_repr = (reprfunc)pg_scancodewrapper_repr,
     .tp_as_mapping = &pg_scancodewrapper_mapping,
+    .tp_iter = (getiterfunc)pg_iter_raise,
+    .tp_iternext = (iternextfunc)pg_iter_raise,
+#ifdef PYPY_VERSION
+    .tp_new = pg_scancodewrapper_new,
+#endif
     .tp_flags =
         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_TUPLE_SUBCLASS | Py_TPFLAGS_BASETYPE,
 };

test/key_test.py

@@ -234,6 +234,14 @@ def test_get_pressed(self):
         states = pygame.key.get_pressed()
         self.assertEqual(states[pygame.K_RIGHT], 0)
 
+    def test_get_pressed_not_iter(self):
+        states = pygame.key.get_pressed()
+        with self.assertRaises(TypeError):
+            next(states)
+        with self.assertRaises(TypeError):
+            for k in states:
+                pass
+
     def test_name_and_key_code(self):
         for const_name in dir(pygame):
             if not const_name.startswith("K_") or const_name in SKIPPED_KEYS: