[Python-checkins] bpo-45089: Improve sqlite3 trace callback docs (GH-28238)
ambv
webhook-mailer at python.org
Wed Sep 15 14:39:11 EDT 2021
https://github.com/python/cpython/commit/51056b40e711d84692d099ac8970077b33c7fafd
commit: 51056b40e711d84692d099ac8970077b33c7fafd
branch: main
author: Erlend Egeberg Aasland <erlend.aasland at innova.no>
committer: ambv <lukasz at langa.pl>
date: 2021-09-15T20:39:05+02:00
summary:
bpo-45089: Improve sqlite3 trace callback docs (GH-28238)
- Add link to str object and sqlite3 transaction control
- Mention that exceptions are not propagated
files:
M Doc/library/sqlite3.rst
diff --git a/Doc/library/sqlite3.rst b/Doc/library/sqlite3.rst
index 7c60188bc70b5..9c9c7f1eb5257 100644
--- a/Doc/library/sqlite3.rst
+++ b/Doc/library/sqlite3.rst
@@ -460,14 +460,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
More information about the Python-checkins
mailing list