Skip to content

gh-96168: Add sqlite3 row factory how-to #99507

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.

Sign up for GitHub

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
erlend-aasland merged 17 commits into from
Nov 25, 2022
+119 −41
Merged

gh-96168: Add sqlite3 row factory how-to #99507

Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e985bab
gh-96168: Add sqlite3 row factory how-to
erlend-aasland Nov 15, 2022
15d4b4e
Suggest reading the row factory how-to at the end of the tutorial
erlend-aasland Nov 15, 2022
f5f24b4
Fix named tuple example usage
erlend-aasland Nov 15, 2022
85c34bc
Fix _fields helper
erlend-aasland Nov 15, 2022
0e7ea3b
Fix expected output in namedtuple row factory doctest
erlend-aasland Nov 15, 2022
413dc24
Address reviews
erlend-aasland Nov 16, 2022
ab98877
Document Cursor.row_factory; tweak some sentences
erlend-aasland Nov 16, 2022
53d4ce4
Sync with main
erlend-aasland Nov 17, 2022
1aca9df
Address reviews
erlend-aasland Nov 17, 2022
1719d0d
Address parts of latest review
erlend-aasland Nov 17, 2022
e1dd69a
Adjust row equality sentence and remove the premature optimisation ex…
erlend-aasland Nov 22, 2022
d12f559
Reword reference and remove example from ab98877
erlend-aasland Nov 22, 2022
a277467
Address most of CAM's latest review
erlend-aasland Nov 23, 2022
cd12c6b
Address review
erlend-aasland Nov 23, 2022
86a2c43
Address reviews
erlend-aasland Nov 24, 2022
f9fa2ee
Split dict row factory example in two
erlend-aasland Nov 25, 2022
6f50503
Missed one
erlend-aasland Nov 25, 2022
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
Prev Previous commit
Next Next commit
Split dict row factory example in two
  • Loading branch information
@erlend-aasland
erlend-aasland committed Nov 25, 2022
commit f9fa2ee1fbf9879f9e4c1f94cc071f7c665af2e8
16 changes: 10 additions & 6 deletions Doc/library/sqlite3.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2386,14 +2386,18 @@ Queries now return :class:`!Row` objects:
>>> row["RADIUS"] # Column names are case-insensitive.
6378

To create and use a custom :attr:`~Cursor.row_factory`,
in this case returning a :class:`dict` mapping column names to values:
You can create a custom :attr:`~Cursor.row_factory`
that returns each row as a :class:`dict`, mapping column names to values:

.. doctest::
.. testcode::

def dict_factory(cursor, row):
fields = [column[0] for column in cursor.description]
return {key: value for key, value in zip(fields, row)}

Using it, queries now return a :class:`!dict` instead of a :class:`!tuple`:

>>> def dict_factory(cursor, row):
... col_names = [column[0] for column in cursor.description]
... return {key: value for key, value in zip(col_names, row)}
.. doctest::

>>> con = sqlite3.connect(":memory:")
>>> con.row_factory = dict_factory
Expand Down