mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-27 10:50:04 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 13

bpo-40318: Migrate to SQLite3 trace v2 API (GH-19581)

Browse source 
Ref. https://sqlite.org/c3ref/trace_v2.html

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
This commit is contained in:
Erlend Egeberg Aasland 2020-09-05 22:43:31 +02:00 • committed by GitHub
parent 8c0be6fd91
commit 7f331c898a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 37 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
Misc/NEWS.d/next/Library/2020-04-18-14-16-02.bpo-40318.K2UdRx.rst Normal file
View file

@ -0,0 +1 @@
Use SQLite3 trace v2 API, if it is available.

36
Modules/_sqlite/connection.c
View file

@ -43,6 +43,10 @@
#define HAVE_BACKUP_API #define HAVE_BACKUP_API
#endif #endif
#if SQLITE_VERSION_NUMBER >= 3014000
#define HAVE_TRACE_V2
#endif
_Py_IDENTIFIER(cursor); _Py_IDENTIFIER(cursor);
static const char * const begin_statements[] = { static const char * const begin_statements[] = {
@ -962,13 +966,29 @@ static int _progress_handler(void* user_arg)
return rc; return rc;
} }
#ifdef HAVE_TRACE_V2
/*
* From https://sqlite.org/c3ref/trace_v2.html:
* The integer return value from the callback is currently ignored, though this
* may change in future releases. Callback implementations should return zero
* to ensure future compatibility.
*/
static int _trace_callback(unsigned int type, void* user_arg, void* prepared_statement, void* statement_string)
#else
static void _trace_callback(void* user_arg, const char* statement_string) static void _trace_callback(void* user_arg, const char* statement_string)
#endif
{ {
PyObject *py_statement = NULL; PyObject *py_statement = NULL;
PyObject *ret = NULL; PyObject *ret = NULL;
PyGILState_STATE gilstate; PyGILState_STATE gilstate;
#ifdef HAVE_TRACE_V2
if (type != SQLITE_TRACE_STMT) {
return 0;
}
#endif
gilstate = PyGILState_Ensure(); gilstate = PyGILState_Ensure();
py_statement = PyUnicode_DecodeUTF8(statement_string, py_statement = PyUnicode_DecodeUTF8(statement_string,
strlen(statement_string), "replace"); strlen(statement_string), "replace");
@ -988,6 +1008,9 @@ static void _trace_callback(void* user_arg, const char* statement_string)
} }
PyGILState_Release(gilstate); PyGILState_Release(gilstate);
#ifdef HAVE_TRACE_V2
return 0;
#endif
} }
static PyObject* pysqlite_connection_set_authorizer(pysqlite_Connection* self, PyObject* args, PyObject* kwargs) static PyObject* pysqlite_connection_set_authorizer(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)
@ -1046,6 +1069,11 @@ static PyObject* pysqlite_connection_set_progress_handler(pysqlite_Connection* s
Py_RETURN_NONE; Py_RETURN_NONE;
} }
/*
* Ref.
* - https://sqlite.org/c3ref/c_trace.html
* - https://sqlite.org/c3ref/trace_v2.html
*/
static PyObject* pysqlite_connection_set_trace_callback(pysqlite_Connection* self, PyObject* args, PyObject* kwargs) static PyObject* pysqlite_connection_set_trace_callback(pysqlite_Connection* self, PyObject* args, PyObject* kwargs)
{ {
PyObject* trace_callback; PyObject* trace_callback;
@ -1063,10 +1091,18 @@ static PyObject* pysqlite_connection_set_trace_callback(pysqlite_Connection* sel
if (trace_callback == Py_None) { if (trace_callback == Py_None) {
/* None clears the trace callback previously set */ /* None clears the trace callback previously set */
#ifdef HAVE_TRACE_V2
sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, 0, 0);
#else
sqlite3_trace(self->db, 0, (void*)0); sqlite3_trace(self->db, 0, (void*)0);
#endif
Py_XSETREF(self->function_pinboard_trace_callback, NULL); Py_XSETREF(self->function_pinboard_trace_callback, NULL);
} else { } else {
#ifdef HAVE_TRACE_V2
sqlite3_trace_v2(self->db, SQLITE_TRACE_STMT, _trace_callback, trace_callback);
#else
sqlite3_trace(self->db, _trace_callback, trace_callback); sqlite3_trace(self->db, _trace_callback, trace_callback);
#endif
Py_INCREF(trace_callback); Py_INCREF(trace_callback);
Py_XSETREF(self->function_pinboard_trace_callback, trace_callback); Py_XSETREF(self->function_pinboard_trace_callback, trace_callback);
} }