]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
bpo-45089: Improve sqlite3 trace callback docs (GH-28238) (GH-28372)
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Wed, 15 Sep 2021 19:09:27 +0000 (12:09 -0700)
committerGitHub <noreply@github.com>
Wed, 15 Sep 2021 19:09:27 +0000 (21:09 +0200)
- Add link to str object and sqlite3 transaction control
- Mention that exceptions are not propagated
(cherry picked from commit 51056b40e711d84692d099ac8970077b33c7fafd)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
Doc/library/sqlite3.rst

index c0b6ab079588d85f3cadf789dc410e28b80aca1c..2600a3db17e0caebf75ab52c34ba4819f0899acc 100644 (file)
@@ -446,14 +446,22 @@ Connection Objects
       Registers *trace_callback* to be called for each SQL statement that is
       actually executed by the SQLite backend.
 
-      The only argument passed to the callback is the statement (as string) that
-      is being executed. The return value of the callback is ignored. Note that
-      the backend does not only run statements passed to the :meth:`Cursor.execute`
-      methods.  Other sources include the transaction management of the Python
-      module and the execution of triggers defined in the current database.
+      The only argument passed to the callback is the statement (as
+      :class:`str`) that is being executed. The return value of the callback is
+      ignored. Note that the backend does not only run statements passed to the
+      :meth:`Cursor.execute` methods.  Other sources include the
+      :ref:`transaction management <sqlite3-controlling-transactions>` of the
+      sqlite3 module and the execution of triggers defined in the current
+      database.
 
       Passing :const:`None` as *trace_callback* will disable the trace callback.
 
+      .. note::
+         Exceptions raised in the trace callback are not propagated. As a
+         development and debugging aid, use
+         :meth:`~sqlite3.enable_callback_tracebacks` to enable printing
+         tracebacks from exceptions raised in the trace callback.
+
       .. versionadded:: 3.3