[Python-checkins] Docs: alphabetically order sqlite3.Cursor attrs (GH-96565)
miss-islington
webhook-mailer at python.org
Sun Sep 4 17:43:28 EDT 2022
https://github.com/python/cpython/commit/0c81909a7a59ea5a6d3af74ac5d2adafe9c8c163
commit: 0c81909a7a59ea5a6d3af74ac5d2adafe9c8c163
branch: 3.11
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-09-04T14:43:23-07:00
summary:
Docs: alphabetically order sqlite3.Cursor attrs (GH-96565)
(cherry picked from commit 9e5568578234f0ecd003247c8a2deaeb69976b4b)
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 aace339e3a4..a9d20a1a455 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -1455,13 +1455,32 @@ Cursor objects
Required by the DB-API. Does nothing in :mod:`!sqlite3`.
- .. attribute:: rowcount
+ .. attribute:: arraysize
- Read-only attribute that provides the number of modified rows for
- ``INSERT``, ``UPDATE``, ``DELETE``, and ``REPLACE`` statements;
- is ``-1`` for other statements,
- including :abbr:`CTE (Common Table Expression)` queries.
- It is only updated by the :meth:`execute` and :meth:`executemany` methods.
+ Read/write attribute that controls the number of rows returned by :meth:`fetchmany`.
+ The default value is 1 which means a single row would be fetched per call.
+
+ .. attribute:: connection
+
+ Read-only attribute that provides the SQLite database :class:`Connection`
+ belonging to the cursor. A :class:`Cursor` object created by
+ calling :meth:`con.cursor() <Connection.cursor>` will have a
+ :attr:`connection` attribute that refers to *con*:
+
+ .. doctest::
+
+ >>> con = sqlite3.connect(":memory:")
+ >>> cur = con.cursor()
+ >>> cur.connection == con
+ True
+
+ .. attribute:: description
+
+ Read-only attribute that provides the column names of the last query. To
+ remain compatible with the Python DB API, it returns a 7-tuple for each
+ column where the last six items of each tuple are ``None``.
+
+ It is set for ``SELECT`` statements without any matching rows as well.
.. attribute:: lastrowid
@@ -1478,32 +1497,14 @@ Cursor objects
.. versionchanged:: 3.6
Added support for the ``REPLACE`` statement.
- .. attribute:: arraysize
-
- Read/write attribute that controls the number of rows returned by :meth:`fetchmany`.
- The default value is 1 which means a single row would be fetched per call.
-
- .. attribute:: description
-
- Read-only attribute that provides the column names of the last query. To
- remain compatible with the Python DB API, it returns a 7-tuple for each
- column where the last six items of each tuple are ``None``.
-
- It is set for ``SELECT`` statements without any matching rows as well.
-
- .. attribute:: connection
-
- Read-only attribute that provides the SQLite database :class:`Connection`
- belonging to the cursor. A :class:`Cursor` object created by
- calling :meth:`con.cursor() <Connection.cursor>` will have a
- :attr:`connection` attribute that refers to *con*:
+ .. attribute:: rowcount
- .. doctest::
+ Read-only attribute that provides the number of modified rows for
+ ``INSERT``, ``UPDATE``, ``DELETE``, and ``REPLACE`` statements;
+ is ``-1`` for other statements,
+ including :abbr:`CTE (Common Table Expression)` queries.
+ It is only updated by the :meth:`execute` and :meth:`executemany` methods.
- >>> con = sqlite3.connect(":memory:")
- >>> cur = con.cursor()
- >>> cur.connection == con
- True
.. The sqlite3.Row example used to be a how-to. It has now been incorporated
into the Row reference. We keep the anchor here in order not to break
More information about the Python-checkins
mailing list