Skip to content

bpo-42064: Pass module state to trace, progress, and authorizer callbacks #27940

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
encukou merged 17 commits into from
Sep 7, 2021
Merged

bpo-42064: Pass module state to trace, progress, and authorizer callbacks #27940

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
e4fe706
Adapt trace callback
Jul 29, 2021
8a9f9ab
Adapt progress handler
Jul 29, 2021
44c85b7
Adapt authoriser callback
Jul 29, 2021
7f3c64b
Add set context helper
Jul 29, 2021
4880b73
Free callback contexts after closing connection
Aug 25, 2021
3f5c0f4
Add print-or-clear-traceback helper
Aug 25, 2021
71f66ca
Ajdust comment
Aug 25, 2021
b8be981
Use SET_CALLBACK_CONTEXT in __init__
Aug 25, 2021
943ad79
Merge branch 'main' into sqlite-callback-state/part2
Aug 31, 2021
6f6bf1d
Include minor PEP 7 adjustment
Aug 31, 2021
3b97195
Address review: explicitly initialise authoriser callback return code
Aug 31, 2021
83ab097
Address review: implement CLEAR_CALLBACK_CONTEXT as a regular function
Sep 1, 2021
d0a422b
Merge branch 'main' into sqlite-callback-state/part2
Sep 7, 2021
32c2073
Fix merge
Sep 7, 2021
cb4063a
Make SET_CALLBACK_CONTEXT a regular function
Sep 7, 2021
e0df824
Let set_callback_context live with the other context functions
Sep 7, 2021
5ff1951
Remove spurious line break
Sep 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Adapt progress handler
  • Loading branch information
Erlend E. Aasland committed Aug 25, 2021
commit 8a9f9ab6b65f9828d5d864ba5162b15faa7ab3ba
30 changes: 20 additions & 10 deletions Modules/_sqlite/connection.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ pysqlite_connection_init_impl(pysqlite_Connection *self,
self->check_same_thread = check_same_thread;

self->trace_ctx = NULL;
self->function_pinboard_progress_handler = NULL;
self->progress_ctx = NULL;
self->function_pinboard_authorizer_cb = NULL;

self->Warning = state->Warning;
Expand Down Expand Up @@ -232,7 +232,7 @@ connection_traverse(pysqlite_Connection *self, visitproc visit, void *arg)
Py_VISIT(self->row_factory);
Py_VISIT(self->text_factory);
VISIT_CALLBACK_CONTEXT(self->trace_ctx);
Py_VISIT(self->function_pinboard_progress_handler);
VISIT_CALLBACK_CONTEXT(self->progress_ctx);
Py_VISIT(self->function_pinboard_authorizer_cb);
#undef VISIT_CALLBACK_CONTEXT
return 0;
Expand All @@ -254,7 +254,7 @@ connection_clear(pysqlite_Connection *self)
Py_CLEAR(self->row_factory);
Py_CLEAR(self->text_factory);
CLEAR_CALLBACK_CONTEXT(self->trace_ctx);
Py_CLEAR(self->function_pinboard_progress_handler);
CLEAR_CALLBACK_CONTEXT(self->progress_ctx);
Py_CLEAR(self->function_pinboard_authorizer_cb);
#undef CLEAR_CALLBACK_CONTEXT
return 0;
Expand All @@ -274,6 +274,7 @@ static void
free_callback_contexts(pysqlite_Connection *self)
{
free_callback_context(self->trace_ctx);
free_callback_context(self->progress_ctx);
}

static void
Expand Down Expand Up @@ -988,7 +989,10 @@ static int _progress_handler(void* user_arg)
PyGILState_STATE gilstate;

gilstate = PyGILState_Ensure();
ret = _PyObject_CallNoArg((PyObject*)user_arg);

callback_context *ctx = (callback_context *)user_arg;
assert(ctx != NULL);
ret = _PyObject_CallNoArg(ctx->callable);

if (!ret) {
/* abort query if error occurred */
Expand All @@ -999,8 +1003,8 @@ static int _progress_handler(void* user_arg)
Py_DECREF(ret);
}
if (rc < 0) {
pysqlite_state *state = pysqlite_get_state(NULL);
if (state->enable_callback_tracebacks) {
assert(ctx->state != NULL);
if (ctx->state->enable_callback_tracebacks) {
PyErr_Print();
}
else {
Expand Down Expand Up @@ -1121,11 +1125,17 @@ pysqlite_connection_set_progress_handler_impl(pysqlite_Connection *self,
if (progress_handler == Py_None) {
/* None clears the progress handler previously set */
sqlite3_progress_handler(self->db, 0, 0, (void*)0);
Py_XSETREF(self->function_pinboard_progress_handler, NULL);
free_callback_context(self->progress_ctx);
self->progress_ctx = NULL;
} else {
sqlite3_progress_handler(self->db, n, _progress_handler, progress_handler);
Py_INCREF(progress_handler);
Py_XSETREF(self->function_pinboard_progress_handler, progress_handler);
callback_context *ctx = create_callback_context(self->state,
progress_handler);
if (ctx == NULL) {
return NULL;
}
sqlite3_progress_handler(self->db, n, _progress_handler, ctx);
free_callback_context(self->progress_ctx);
self->progress_ctx = ctx;
}
Py_RETURN_NONE;
}
Expand Down
2 changes: 1 addition & 1 deletion Modules/_sqlite/connection.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ typedef struct

/* remember references to object used in trace_callback/progress_handler/authorizer_cb */
callback_context *trace_ctx;
PyObject* function_pinboard_progress_handler;
callback_context *progress_ctx;
PyObject* function_pinboard_authorizer_cb;

/* Exception objects: borrowed refs. */
Expand Down