[Python-checkins] Docs: group sqlite3.Connection attributes and methods (GH-96090)
miss-islington
webhook-mailer at python.org
Fri Aug 19 03:38:25 EDT 2022
https://github.com/python/cpython/commit/8a6e651e20cc57a0cf35b6eeae26ad50907c1baa
commit: 8a6e651e20cc57a0cf35b6eeae26ad50907c1baa
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: miss-islington <31488909+miss-islington at users.noreply.github.com>
date: 2022-08-19T00:38:21-07:00
summary:
Docs: group sqlite3.Connection attributes and methods (GH-96090)
(cherry picked from commit 1a140af40b7204faf7896b67b8ef5af200427565)
Co-authored-by: Erlend E. Aasland <erlend.aasland at protonmail.com>
files:
M Doc/library/sqlite3.rst
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 7f9c737660a..d11fb18add6 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -495,6 +495,43 @@ Connection objects
.. versionadded:: 3.2
+ .. attribute:: row_factory
+
+ A callable that accepts two arguments,
+ a :class:`Cursor` object and the raw row results as a :class:`tuple`,
+ and returns a custom object representing an SQLite row.
+
+ Example:
+
+ .. literalinclude:: ../includes/sqlite3/row_factory.py
+
+ If returning a tuple doesn't suffice and you want name-based access to
+ columns, you should consider setting :attr:`row_factory` to the
+ highly optimized :class:`sqlite3.Row` type. :class:`Row` provides both
+ index-based and case-insensitive name-based access to columns with almost no
+ memory overhead. It will probably be better than your own custom
+ dictionary-based approach or even a db_row based solution.
+
+ .. XXX what's a db_row-based solution?
+
+ .. attribute:: text_factory
+
+ A callable that accepts a :class:`bytes` parameter and returns a text
+ representation of it.
+ The callable is invoked for SQLite values with the ``TEXT`` data type.
+ By default, this attribute is set to :class:`str`.
+ If you want to return ``bytes`` instead, set *text_factory* to ``bytes``.
+
+ Example:
+
+ .. literalinclude:: ../includes/sqlite3/text_factory.py
+
+ .. attribute:: total_changes
+
+ Return the total number of database rows that have been modified, inserted, or
+ deleted since the database connection was opened.
+
+
.. method:: cursor(factory=Cursor)
Create and return a :class:`Cursor` object.
@@ -724,45 +761,6 @@ Connection objects
.. versionchanged:: 3.10
Added the ``sqlite3.load_extension`` auditing event.
- .. attribute:: row_factory
-
- A callable that accepts two arguments,
- a :class:`Cursor` object and the raw row results as a :class:`tuple`,
- and returns a custom object representing an SQLite row.
-
- Example:
-
- .. literalinclude:: ../includes/sqlite3/row_factory.py
-
- If returning a tuple doesn't suffice and you want name-based access to
- columns, you should consider setting :attr:`row_factory` to the
- highly optimized :class:`sqlite3.Row` type. :class:`Row` provides both
- index-based and case-insensitive name-based access to columns with almost no
- memory overhead. It will probably be better than your own custom
- dictionary-based approach or even a db_row based solution.
-
- .. XXX what's a db_row-based solution?
-
-
- .. attribute:: text_factory
-
- A callable that accepts a :class:`bytes` parameter and returns a text
- representation of it.
- The callable is invoked for SQLite values with the ``TEXT`` data type.
- By default, this attribute is set to :class:`str`.
- If you want to return ``bytes`` instead, set *text_factory* to ``bytes``.
-
- Example:
-
- .. literalinclude:: ../includes/sqlite3/text_factory.py
-
-
- .. attribute:: total_changes
-
- Return the total number of database rows that have been modified, inserted, or
- deleted since the database connection was opened.
-
-
.. method:: iterdump
Return an :term:`iterator` to dump the database as SQL source code.
More information about the Python-checkins
mailing list