BUG#27359063: Support for dictionary, named_tuple, and raw to prepared statements cursor

oscpache · oscpache · commit c8474cec2428 · 2023-01-05T13:23:31.000-06:00
This bug report is an enhancement request regarding the available
prepared cursor flavors.

With this patch, two more options are added to the set of available
cursor types:
- `prepared + named_tuple`
- `prepared + raw`

The option `prepared + dictionary` was not added given it was
implemented while fixing BUG#23339387.

The three cursor types mentioned are available for both implementations;
pure python and cext.

Change-Id: Idd6276c1ac021ba759be6d5c5e93f18f1f41ed05
diff --git a/CHANGES.txt b/CHANGES.txt
@@ -12,6 +12,7 @@ v8.0.33
 =======
 
 - WL#15401: Support for type hints in module mysqlx
+- BUG#27359063: Support for dictionary, named_tuple, and raw to prepared statements cursor
 
 v8.0.32
 =======
diff --git a/lib/mysql/connector/connection.py b/lib/mysql/connector/connection.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2009, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2009, 2023, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -79,6 +79,8 @@
     MySQLCursorNamedTuple,
     MySQLCursorPrepared,
     MySQLCursorPreparedDict,
+    MySQLCursorPreparedNamedTuple,
+    MySQLCursorPreparedRaw,
     MySQLCursorRaw,
 )
 from .errors import (
@@ -1436,7 +1438,9 @@ def cursor(
             8: MySQLCursorNamedTuple,
             9: MySQLCursorBufferedNamedTuple,
             16: MySQLCursorPrepared,
+            18: MySQLCursorPreparedRaw,
             20: MySQLCursorPreparedDict,
+            24: MySQLCursorPreparedNamedTuple,
         }
         try:
             return (types[cursor_type])(self)
diff --git a/lib/mysql/connector/connection_cext.py b/lib/mysql/connector/connection_cext.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2023, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -75,6 +75,8 @@
         CMySQLCursorNamedTuple,
         CMySQLCursorPrepared,
         CMySQLCursorPreparedDict,
+        CMySQLCursorPreparedNamedTuple,
+        CMySQLCursorPreparedRaw,
         CMySQLCursorRaw,
     )
 except ImportError as exc:
@@ -705,7 +707,9 @@ def cursor(
             8: CMySQLCursorNamedTuple,
             9: CMySQLCursorBufferedNamedTuple,
             16: CMySQLCursorPrepared,
+            18: CMySQLCursorPreparedRaw,
             20: CMySQLCursorPreparedDict,
+            24: CMySQLCursorPreparedNamedTuple,
         }
         try:
             return (types[cursor_type])(self)
diff --git a/lib/mysql/connector/cursor.py b/lib/mysql/connector/cursor.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2009, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2009, 2023, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -1549,35 +1549,26 @@ def fetchone(self) -> Optional[RowType]:
         Returns:
             tuple or None: A row from query result set.
         """
-        self._check_executed()
-        row = self._fetch_row()
-        if row:
-            if hasattr(self._connection, "converter"):
-                return self._row_to_python(row, self.description)
-            return row
-        return None
+        row = super().fetchone()
+        if not row:
+            return None
+        return (
+            self._row_to_python(row, self.description)
+            if hasattr(self._connection, "converter")
+            else row
+        )
 
     def fetchall(self) -> List[Optional[RowType]]:
         """Return all rows of a query result set.
 
         Returns:
             list: A list of tuples with all rows of a query result set.
         """
-        self._check_executed()
-        if not self._have_unread_result():
-            return []
-
-        (rows, eof) = self._connection.get_rows()
-        if self._nextrow[0]:
-            rows.insert(0, self._nextrow[0])
-        res = [self._row_to_python(row, self.description) for row in rows]
-
-        self._handle_eof(eof)
-        rowcount = len(rows)
-        if rowcount >= 0 and self._rowcount == -1:
-            self._rowcount = 0
-        self._rowcount += rowcount
-        return res
+        return [
+            self._row_to_python(row, self.description)
+            for row in super().fetchall()
+            if row
+        ]
 
 
 class MySQLCursorBufferedDict(MySQLCursorDict, MySQLCursorBuffered):
@@ -1680,3 +1671,88 @@ def fetchmany(
             for row in super().fetchmany(size=size)
             if row
         ]
+
+
+class MySQLCursorPreparedNamedTuple(MySQLCursorNamedTuple, MySQLCursorPrepared):
+    """
+    This class is a blend of features from MySQLCursorNamedTuple and MySQLCursorPrepared
+    """
+
+    def fetchmany(self, size: Optional[int] = None) -> List[RowType]:
+        """Return the next set of rows of a query result set.
+
+        When no more rows are available, it returns an empty list.
+        The number of rows returned can be specified using the size argument,
+        which defaults to one.
+
+        Returns:
+            list: The next set of rows of a query result set represented
+                  as a list of named tuples where column names are used as names.
+        """
+        return [
+            self._row_to_python(row, self.description)
+            for row in super().fetchmany(size=size)
+            if row
+        ]
+
+
+class MySQLCursorPreparedRaw(MySQLCursorPrepared):
+    """
+    This class is a blend of features from MySQLCursorRaw and MySQLCursorPrepared
+    """
+
+    _raw: bool = True
+
+    def fetchone(self) -> Optional[RowType]:
+        """Return next row of a query result set.
+
+        Returns:
+            tuple or None: A row from query result set.
+        """
+        self._check_executed()
+        if self._cursor_exists:
+            self._connection.cmd_stmt_fetch(self._prepared["statement_id"])
+        return self._fetch_row(raw=self._raw) or None
+
+    def fetchmany(self, size: Optional[int] = None) -> List[RowType]:
+        """Return the next set of rows of a query result set.
+
+        When no more rows are available, it returns an empty list.
+        The number of rows returned can be specified using the size argument,
+        which defaults to one.
+
+        Returns:
+            list: The next set of rows of a query result set.
+        """
+        self._check_executed()
+        res = []
+        cnt = size or self.arraysize
+        while cnt > 0 and self._have_unread_result():
+            cnt -= 1
+            row = self._fetch_row(raw=self._raw)
+            if row:
+                res.append(row)
+        return res
+
+    def fetchall(self) -> List[RowType]:
+        """Return all rows of a query result set.
+
+        Returns:
+            list: A list of tuples with all rows of a query result set.
+        """
+        self._check_executed()
+        rows = []
+        if self._nextrow[0]:
+            rows.append(self._nextrow[0])
+        while self._have_unread_result():
+            if self._cursor_exists:
+                self._connection.cmd_stmt_fetch(
+                    self._prepared["statement_id"], MAX_RESULTS
+                )
+            (tmp, eof) = self._connection.get_rows(
+                raw=self._raw, binary=self._binary, columns=self.description
+            )
+            rows.extend(tmp)
+            self._handle_eof(eof)
+        self._rowcount = len(rows)
+        return rows
diff --git a/lib/mysql/connector/cursor_cext.py b/lib/mysql/connector/cursor_cext.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2014, 2022, Oracle and/or its affiliates.
+# Copyright (c) 2014, 2023, Oracle and/or its affiliates.
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License, version 2.0, as
@@ -976,7 +976,7 @@ def fetchmany(self, size: int = 1) -> List[RowType]:
         res = super().fetchmany(size=size)
         if not res:
             return []
-        return [self.named_tuple(*res[0])]
+        return [self.named_tuple(*row) for row in res]
 
     def fetchall(self) -> List[RowType]:
         """Return all rows of a query result set.
@@ -1278,3 +1278,13 @@ class is searched once.
     3. CMySQLCursorPrepared (right parent class)
     4. CMySQLCursor (base class)
     """
+
+
+class CMySQLCursorPreparedNamedTuple(CMySQLCursorNamedTuple, CMySQLCursorPrepared):
+    """This class is a blend of features from CMySQLCursorNamedTuple and CMySQLCursorPrepared"""
+
+
+class CMySQLCursorPreparedRaw(CMySQLCursorPrepared):
+    """This class is a blend of features from CMySQLCursorRaw and CMySQLCursorPrepared"""
+
+    _raw: bool = True
diff --git a/tests/cext/test_cext_cursor.py b/tests/cext/test_cext_cursor.py
diff --git a/tests/test_cursor.py b/tests/test_cursor.py
