Skip to content

Commit f5a7847

Browse files
Docs: alphabetically order sqlite3.Cursor attrs (GH-96565)
(cherry picked from commit 9e55685) Co-authored-by: Erlend E. Aasland <[email protected]>
1 parent eace09e commit f5a7847

File tree

1 file changed

+31
-30
lines changed

1 file changed

+31
-30
lines changed

Doc/library/sqlite3.rst

Lines changed: 31 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1165,13 +1165,32 @@ Cursor objects
11651165

11661166
Required by the DB-API. Does nothing in :mod:`!sqlite3`.
11671167

1168-
.. attribute:: rowcount
1168+
.. attribute:: arraysize
11691169

1170-
Read-only attribute that provides the number of modified rows for
1171-
``INSERT``, ``UPDATE``, ``DELETE``, and ``REPLACE`` statements;
1172-
is ``-1`` for other statements,
1173-
including :abbr:`CTE (Common Table Expression)` queries.
1174-
It is only updated by the :meth:`execute` and :meth:`executemany` methods.
1170+
Read/write attribute that controls the number of rows returned by :meth:`fetchmany`.
1171+
The default value is 1 which means a single row would be fetched per call.
1172+
1173+
.. attribute:: connection
1174+
1175+
Read-only attribute that provides the SQLite database :class:`Connection`
1176+
belonging to the cursor. A :class:`Cursor` object created by
1177+
calling :meth:`con.cursor() <Connection.cursor>` will have a
1178+
:attr:`connection` attribute that refers to *con*:
1179+
1180+
.. doctest::
1181+
1182+
>>> con = sqlite3.connect(":memory:")
1183+
>>> cur = con.cursor()
1184+
>>> cur.connection == con
1185+
True
1186+
1187+
.. attribute:: description
1188+
1189+
Read-only attribute that provides the column names of the last query. To
1190+
remain compatible with the Python DB API, it returns a 7-tuple for each
1191+
column where the last six items of each tuple are ``None``.
1192+
1193+
It is set for ``SELECT`` statements without any matching rows as well.
11751194

11761195
.. attribute:: lastrowid
11771196

@@ -1188,32 +1207,14 @@ Cursor objects
11881207
.. versionchanged:: 3.6
11891208
Added support for the ``REPLACE`` statement.
11901209

1191-
.. attribute:: arraysize
1192-
1193-
Read/write attribute that controls the number of rows returned by :meth:`fetchmany`.
1194-
The default value is 1 which means a single row would be fetched per call.
1195-
1196-
.. attribute:: description
1197-
1198-
Read-only attribute that provides the column names of the last query. To
1199-
remain compatible with the Python DB API, it returns a 7-tuple for each
1200-
column where the last six items of each tuple are ``None``.
1201-
1202-
It is set for ``SELECT`` statements without any matching rows as well.
1203-
1204-
.. attribute:: connection
1205-
1206-
Read-only attribute that provides the SQLite database :class:`Connection`
1207-
belonging to the cursor. A :class:`Cursor` object created by
1208-
calling :meth:`con.cursor() <Connection.cursor>` will have a
1209-
:attr:`connection` attribute that refers to *con*:
1210+
.. attribute:: rowcount
12101211

1211-
.. doctest::
1212+
Read-only attribute that provides the number of modified rows for
1213+
``INSERT``, ``UPDATE``, ``DELETE``, and ``REPLACE`` statements;
1214+
is ``-1`` for other statements,
1215+
including :abbr:`CTE (Common Table Expression)` queries.
1216+
It is only updated by the :meth:`execute` and :meth:`executemany` methods.
12121217

1213-
>>> con = sqlite3.connect(":memory:")
1214-
>>> cur = con.cursor()
1215-
>>> cur.connection == con
1216-
True
12171218

12181219
.. The sqlite3.Row example used to be a how-to. It has now been incorporated
12191220
into the Row reference. We keep the anchor here in order not to break

0 commit comments

Comments
 (0)