[Python-checkins] bpo-45608: Document missing `sqlite3` DB-API attributes and methods (GH-29219) (GH-29281)
ambv
webhook-mailer at python.org
Thu Oct 28 15:57:19 EDT 2021
https://github.com/python/cpython/commit/1d88b2b0a15198843a43f34aba1abc65455d3ba7
commit: 1d88b2b0a15198843a43f34aba1abc65455d3ba7
branch: 3.10
author: Miss Islington (bot) <31488909+miss-islington at users.noreply.github.com>
committer: ambv <lukasz at langa.pl>
date: 2021-10-28T21:57:14+02:00
summary:
bpo-45608: Document missing `sqlite3` DB-API attributes and methods (GH-29219) (GH-29281)
(cherry picked from commit 88d8a1a340fb09c54d47f354f5fd7d4fbc5f0c78)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland at innova.no>
files:
M Doc/library/sqlite3.rst
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 5641a347ceda1..dc9aeb2ba3f59 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -117,6 +117,24 @@ Module functions and constants
------------------------------
+.. data:: apilevel
+
+ String constant stating the supported DB-API level. Required by the DB-API.
+ Hard-coded to ``"2.0"``.
+
+.. data:: paramstyle
+
+ String constant stating the type of parameter marker formatting expected by
+ the :mod:`sqlite3` module. Required by the DB-API. Hard-coded to
+ ``"qmark"``.
+
+ .. note::
+
+ The :mod:`sqlite3` module supports both ``qmark`` and ``numeric`` DB-API
+ parameter styles, because that is what the underlying SQLite library
+ supports. However, the DB-API does not allow multiple values for
+ the ``paramstyle`` attribute.
+
.. data:: version
The version number of this module, as a string. This is not the version of
@@ -139,6 +157,26 @@ Module functions and constants
The version number of the run-time SQLite library, as a tuple of integers.
+.. data:: threadsafety
+
+ Integer constant required by the DB-API, stating the level of thread safety
+ the :mod:`sqlite3` module supports. Currently hard-coded to ``1``, meaning
+ *"Threads may share the module, but not connections."* However, this may not
+ always be true. You can check the underlying SQLite library's compile-time
+ threaded mode using the following query::
+
+ import sqlite3
+ con = sqlite3.connect(":memory:")
+ con.execute("""
+ select * from pragma_compile_options
+ where compile_options like 'THREADSAFE=%'
+ """).fetchall()
+
+ Note that the `SQLITE_THREADSAFE levels
+ <https://sqlite.org/compile.html#threadsafe>`_ do not match the DB-API 2.0
+ ``threadsafety`` levels.
+
+
.. data:: PARSE_DECLTYPES
This constant is meant to be used with the *detect_types* parameter of the
@@ -701,6 +739,14 @@ Cursor Objects
The cursor will be unusable from this point forward; a :exc:`ProgrammingError`
exception will be raised if any operation is attempted with the cursor.
+ .. method:: setinputsizes(sizes)
+
+ Required by the DB-API. Is a no-op in :mod:`sqlite3`.
+
+ .. method:: setoutputsize(size [, column])
+
+ Required by the DB-API. Is a no-op in :mod:`sqlite3`.
+
.. attribute:: rowcount
Although the :class:`Cursor` class of the :mod:`sqlite3` module implements this
More information about the Python-checkins
mailing list