Mailing List Archive

https://github.com/python/cpython/commit/7a843e8390f284fb6aa7c6fdebf88052a5b0be46
commit: 7a843e8390f284fb6aa7c6fdebf88052a5b0be46
branch: 3.12
author: Erlend E. Aasland <erlend@python.org>
committer: erlend-aasland <erlend.aasland@protonmail.com>
date: 2024-04-25T08:33:35Z
summary:

[3.12] gh-118221: Always use the default row factory in sqlite3.iterdump() (#118223) (#118270)

sqlite3.iterdump() depends on the row factory returning resulting rows
as tuples; it will fail with custom row factories like for example a
dict factory.

With this commit, we explicitly reset the row factory of the cursor used
by iterdump(), so we always get predictable results. This does not
affect the row factory of the parent connection.

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>

files:
A Misc/NEWS.d/next/Library/2024-04-24-12-29-33.gh-issue-118221.2k_bac.rst
M Lib/sqlite3/dump.py
M Lib/test/test_sqlite3/test_dump.py

diff --git a/Lib/sqlite3/dump.py b/Lib/sqlite3/dump.py
index 1cf8759f8970f1..cf417f2193ae82 100644
--- a/Lib/sqlite3/dump.py
+++ b/Lib/sqlite3/dump.py
@@ -18,6 +18,7 @@ def _iterdump(connection):

writeable_schema = False
cu = connection.cursor()
+ cu.row_factory = None # Make sure we get predictable results.
yield('BEGIN TRANSACTION;')

# sqlite_master table contains the SQL CREATE statements for the database.
diff --git a/Lib/test/test_sqlite3/test_dump.py b/Lib/test/test_sqlite3/test_dump.py
index c3ed3aefef0445..1dcce87c5e7858 100644
--- a/Lib/test/test_sqlite3/test_dump.py
+++ b/Lib/test/test_sqlite3/test_dump.py
@@ -117,6 +117,21 @@ def __getitem__(self, index):
got = list(self.cx.iterdump())
self.assertEqual(expected, got)

+ def test_dump_custom_row_factory(self):
+ # gh-118221: iterdump should be able to cope with custom row factories.
+ def dict_factory(cu, row):
+ fields = [col[0] for col in cu.description]
+ return dict(zip(fields, row))
+
+ self.cx.row_factory = dict_factory
+ CREATE_TABLE = "CREATE TABLE test(t);"
+ expected = ["BEGIN TRANSACTION;", CREATE_TABLE, "COMMIT;"]
+
+ self.cu.execute(CREATE_TABLE)
+ actual = list(self.cx.iterdump())
+ self.assertEqual(expected, actual)
+ self.assertEqual(self.cx.row_factory, dict_factory)
+
def test_dump_virtual_tables(self):
# gh-64662
expected = [
diff --git a/Misc/NEWS.d/next/Library/2024-04-24-12-29-33.gh-issue-118221.2k_bac.rst b/Misc/NEWS.d/next/Library/2024-04-24-12-29-33.gh-issue-118221.2k_bac.rst
new file mode 100644
index 00000000000000..9b0ea9978a195e
--- /dev/null
+++ b/Misc/NEWS.d/next/Library/2024-04-24-12-29-33.gh-issue-118221.2k_bac.rst
@@ -0,0 +1,2 @@
+Fix a bug where :func:`sqlite3.iterdump` could fail if a custom :attr:`row
+factory <sqlite3.Connection.row_factory>` was used. Patch by Erlend Aasland.

_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-leave@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: list-python-checkins@lists.gossamer-threads.com