languages/cpython
languages/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython synced 2024-09-06 07:03:34 +00:00
Code Issues Packages Projects Releases Wiki Activity

[3.12] gh-71592: Add ability to trace Tcl commands executed by Tkinter (GH-118291) (GH-118662)

Browse source 
This is an experimental feature, for internal use.

Setting tkinter._debug = True before creating the root window enables
printing every executed Tcl command (or a Tcl command equivalent to the
used Tcl C API).

This will help to convert a Tkinter example into Tcl script to check
whether the issue is caused by Tkinter or exists in the underlying Tcl/Tk
library.
(cherry picked from commit 1ff626ebda)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
This commit is contained in:
Serhiy Storchaka 2024-05-06 22:26:08 +03:00 committed by GitHub
parent f6c2b04d02
commit bee1c322c0
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 191 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
Lib/tkinter/__init__.py
View file

@ -41,6 +41,7 @@
import re
wantobjects = 1
_debug = False # set to True to print executed Tcl/Tk commands
TkVersion = float(_tkinter.TK_VERSION)
TclVersion = float(_tkinter.TCL_VERSION)
@ -69,7 +70,10 @@ def _stringify(value):
else:
value = '{%s}' % _join(value)
else:
value = str(value)
if isinstance(value, bytes):
value = str(value, 'latin1')
else:
value = str(value)
if not value:
value = '{}'
elif _magic_re.search(value):
@ -411,7 +415,6 @@ def __del__(self):
self._tk.globalunsetvar(self._name)
if self._tclCommands is not None:
for name in self._tclCommands:
#print '- Tkinter: deleted command', name
self._tk.deletecommand(name)
self._tclCommands = None
@ -683,7 +686,6 @@ def destroy(self):
this widget in the Tcl interpreter."""
if self._tclCommands is not None:
for name in self._tclCommands:
#print '- Tkinter: deleted command', name
self.tk.deletecommand(name)
self._tclCommands = None
@ -691,7 +693,6 @@ def deletecommand(self, name):
"""Internal function.
Delete the Tcl command provided in NAME."""
#print '- Tkinter: deleted command', name
self.tk.deletecommand(name)
try:
self._tclCommands.remove(name)
@ -2343,6 +2344,8 @@ def __init__(self, screenName=None, baseName=None, className='Tk',
baseName = baseName + ext
interactive = False
self.tk = _tkinter.create(screenName, baseName, className, interactive, wantobjects, useTk, sync, use)
if _debug:
self.tk.settrace(_print_command)
if useTk:
self._loadtk()
if not sys.flags.ignore_environment:
@ -2429,6 +2432,14 @@ def __getattr__(self, attr):
"Delegate attribute access to the interpreter object"
return getattr(self.tk, attr)
def _print_command(cmd, *, file=sys.stderr):
# Print executed Tcl/Tk commands.
assert isinstance(cmd, tuple)
cmd = _join(cmd)
print(cmd, file=file)
# Ideally, the classes Pack, Place and Grid disappear, the
# pack/place/grid methods are defined on the Widget class, and
# everybody uses w.pack_whatever(...) instead of Pack.whatever(w,

149
Modules/_tkinter.c
View file

@ -309,6 +309,7 @@ typedef struct {
int threaded; /* True if tcl_platform[threaded] */
Tcl_ThreadId thread_id;
int dispatching;
PyObject *trace;
/* We cannot include tclInt.h, as this is internal.
So we cache interesting types here. */
const Tcl_ObjType *OldBooleanType;
@ -574,6 +575,7 @@ Tkapp_New(const char *screenName, const char *className,
TCL_GLOBAL_ONLY) != NULL;
v->thread_id = Tcl_GetCurrentThread();
v->dispatching = 0;
v->trace = NULL;
#ifndef TCL_THREADS
if (v->threaded) {
@ -1316,6 +1318,29 @@ Tkapp_ObjectResult(TkappObject *self)
return res;
}
static int
Tkapp_Trace(TkappObject *self, PyObject *args)
{
if (args == NULL) {
return 0;
}
if (self->trace) {
PyObject *res = PyObject_CallObject(self->trace, args);
if (res == NULL) {
Py_DECREF(args);
return 0;
}
Py_DECREF(res);
}
Py_DECREF(args);
return 1;
}
#define TRACE(_self, ARGS) do { \
if ((_self)->trace && !Tkapp_Trace((_self), Py_BuildValue ARGS)) { \
return NULL; \
} \
} while (0)
/* Tkapp_CallProc is the event procedure that is executed in the context of
the Tcl interpreter thread. Initially, it holds the Tcl lock, and doesn't
@ -1329,7 +1354,12 @@ Tkapp_CallProc(Tkapp_CallEvent *e, int flags)
int objc;
int i;
ENTER_PYTHON
objv = Tkapp_CallArgs(e->args, objStore, &objc);
if (e->self->trace && !Tkapp_Trace(e->self, PyTuple_Pack(1, e->args))) {
objv = NULL;
}
else {
objv = Tkapp_CallArgs(e->args, objStore, &objc);
}
if (!objv) {
*(e->exc) = PyErr_GetRaisedException();
*(e->res) = NULL;
@ -1422,6 +1452,7 @@ Tkapp_Call(PyObject *selfptr, PyObject *args)
}
else
{
TRACE(self, ("(O)", args));
objv = Tkapp_CallArgs(args, objStore, &objc);
if (!objv)
@ -1464,6 +1495,8 @@ _tkinter_tkapp_eval_impl(TkappObject *self, const char *script)
CHECK_STRING_LENGTH(script);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ss))", "eval", script));
ENTER_TCL
err = Tcl_Eval(Tkapp_Interp(self), script);
ENTER_OVERLAP
@ -1493,6 +1526,8 @@ _tkinter_tkapp_evalfile_impl(TkappObject *self, const char *fileName)
CHECK_STRING_LENGTH(fileName);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ss))", "source", fileName));
ENTER_TCL
err = Tcl_EvalFile(Tkapp_Interp(self), fileName);
ENTER_OVERLAP
@ -1522,6 +1557,8 @@ _tkinter_tkapp_record_impl(TkappObject *self, const char *script)
CHECK_STRING_LENGTH(script);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ssss))", "history", "add", script, "exec"));
ENTER_TCL
err = Tcl_RecordAndEval(Tkapp_Interp(self), script, TCL_NO_EVAL);
ENTER_OVERLAP
@ -1710,6 +1747,15 @@ SetVar(TkappObject *self, PyObject *args, int flags)
newval = AsObj(newValue);
if (newval == NULL)
return NULL;
if (flags & TCL_GLOBAL_ONLY) {
TRACE((TkappObject *)self, ("((ssssO))", "uplevel", "#0", "set",
name1, newValue));
}
else {
TRACE((TkappObject *)self, ("((ssO))", "set", name1, newValue));
}
ENTER_TCL
ok = Tcl_SetVar2Ex(Tkapp_Interp(self), name1, NULL,
newval, flags);
@ -1727,8 +1773,22 @@ SetVar(TkappObject *self, PyObject *args, int flags)
return NULL;
CHECK_STRING_LENGTH(name1);
CHECK_STRING_LENGTH(name2);
/* XXX must hold tcl lock already??? */
newval = AsObj(newValue);
if (((TkappObject *)self)->trace) {
if (flags & TCL_GLOBAL_ONLY) {
TRACE((TkappObject *)self, ("((sssNO))", "uplevel", "#0", "set",
PyUnicode_FromFormat("%s(%s)", name1, name2),
newValue));
}
else {
TRACE((TkappObject *)self, ("((sNO))", "set",
PyUnicode_FromFormat("%s(%s)", name1, name2),
newValue));
}
}
ENTER_TCL
ok = Tcl_SetVar2Ex(Tkapp_Interp(self), name1, name2, newval, flags);
ENTER_OVERLAP
@ -1815,6 +1875,28 @@ UnsetVar(TkappObject *self, PyObject *args, int flags)
CHECK_STRING_LENGTH(name1);
CHECK_STRING_LENGTH(name2);
if (((TkappObject *)self)->trace) {
if (flags & TCL_GLOBAL_ONLY) {
if (name2) {
TRACE((TkappObject *)self, ("((sssN))", "uplevel", "#0", "unset",
PyUnicode_FromFormat("%s(%s)", name1, name2)));
}
else {
TRACE((TkappObject *)self, ("((ssss))", "uplevel", "#0", "unset", name1));
}
}
else {
if (name2) {
TRACE((TkappObject *)self, ("((sN))", "unset",
PyUnicode_FromFormat("%s(%s)", name1, name2)));
}
else {
TRACE((TkappObject *)self, ("((ss))", "unset", name1));
}
}
}
ENTER_TCL
code = Tcl_UnsetVar2(Tkapp_Interp(self), name1, name2, flags);
ENTER_OVERLAP
@ -1981,6 +2063,8 @@ _tkinter_tkapp_exprstring_impl(TkappObject *self, const char *s)
CHECK_STRING_LENGTH(s);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ss))", "expr", s));
ENTER_TCL
retval = Tcl_ExprString(Tkapp_Interp(self), s);
ENTER_OVERLAP
@ -2011,6 +2095,8 @@ _tkinter_tkapp_exprlong_impl(TkappObject *self, const char *s)
CHECK_STRING_LENGTH(s);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ss))", "expr", s));
ENTER_TCL
retval = Tcl_ExprLong(Tkapp_Interp(self), s, &v);
ENTER_OVERLAP
@ -2040,6 +2126,9 @@ _tkinter_tkapp_exprdouble_impl(TkappObject *self, const char *s)
CHECK_STRING_LENGTH(s);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ss))", "expr", s));
ENTER_TCL
retval = Tcl_ExprDouble(Tkapp_Interp(self), s, &v);
ENTER_OVERLAP
@ -2069,6 +2158,9 @@ _tkinter_tkapp_exprboolean_impl(TkappObject *self, const char *s)
CHECK_STRING_LENGTH(s);
CHECK_TCL_APPARTMENT;
TRACE(self, ("((ss))", "expr", s));
ENTER_TCL
retval = Tcl_ExprBoolean(Tkapp_Interp(self), s, &v);
ENTER_OVERLAP
@ -2293,6 +2385,8 @@ _tkinter_tkapp_createcommand_impl(TkappObject *self, const char *name,
!WaitForMainloop(self))
return NULL;
TRACE(self, ("((ss()O))", "proc", name, func));
data = PyMem_NEW(PythonCmd_ClientData, 1);
if (!data)
return PyErr_NoMemory();
@ -2351,6 +2445,8 @@ _tkinter_tkapp_deletecommand_impl(TkappObject *self, const char *name)
CHECK_STRING_LENGTH(name);
TRACE(self, ("((sss))", "rename", name, ""));
if (self->threaded && self->thread_id != Tcl_GetCurrentThread()) {
Tcl_Condition cond = NULL;
CommandEvent *ev;
@ -2476,6 +2572,8 @@ _tkinter_tkapp_createfilehandler_impl(TkappObject *self, PyObject *file,
return NULL;
}
TRACE(self, ("((ssiiO))", "#", "createfilehandler", tfile, mask, func));
data = NewFHCD(func, file, tfile);
if (data == NULL)
return NULL;
@ -2507,6 +2605,8 @@ _tkinter_tkapp_deletefilehandler(TkappObject *self, PyObject *file)
if (tfile < 0)
return NULL;
TRACE(self, ("((ssi))", "#", "deletefilehandler", tfile));
DeleteFHCD(tfile);
/* Ought to check for null Tcl_File object... */
@ -2541,6 +2641,7 @@ _tkinter_tktimertoken_deletetimerhandler_impl(TkttObject *self)
PyObject *func = v->func;
if (v->token != NULL) {
/* TRACE(...) */
Tcl_DeleteTimerHandler(v->token);
v->token = NULL;
}
@ -2643,6 +2744,8 @@ _tkinter_tkapp_createtimerhandler_impl(TkappObject *self, int milliseconds,
CHECK_TCL_APPARTMENT;
TRACE(self, ("((siO))", "after", milliseconds, func));
v = Tktt_New(func);
if (v) {
v->token = Tcl_CreateTimerHandler(milliseconds, TimerHandler,
@ -2810,6 +2913,47 @@ Tkapp_WantObjects(PyObject *self, PyObject *args)
Py_RETURN_NONE;
}
/*[clinic input]
_tkinter.tkapp.settrace
func: object
/
Set the tracing function.
[clinic start generated code]*/
static PyObject *
_tkinter_tkapp_settrace(TkappObject *self, PyObject *func)
/*[clinic end generated code: output=847f6ebdf46e84fa input=31b260d46d3d018a]*/
{
if (func == Py_None) {
func = NULL;
}
else {
Py_INCREF(func);
}
Py_XSETREF(self->trace, func);
Py_RETURN_NONE;
}
/*[clinic input]
_tkinter.tkapp.gettrace
Get the tracing function.
[clinic start generated code]*/
static PyObject *
_tkinter_tkapp_gettrace_impl(TkappObject *self)
/*[clinic end generated code: output=d4e2ba7d63e77bb5 input=ac2aea5be74e8c4c]*/
{
PyObject *func = self->trace;
if (!func) {
func = Py_None;
}
Py_INCREF(func);
return func;
}
/*[clinic input]
_tkinter.tkapp.willdispatch
@ -2835,6 +2979,7 @@ Tkapp_Dealloc(PyObject *self)
ENTER_TCL
Tcl_DeleteInterp(Tkapp_Interp(self));
LEAVE_TCL
Py_XDECREF(((TkappObject *)self)->trace);
PyObject_Free(self);
Py_DECREF(tp);
DisableEventHook();
@ -3045,6 +3190,8 @@ static PyMethodDef Tkapp_methods[] =
{
_TKINTER_TKAPP_WILLDISPATCH_METHODDEF
{"wantobjects", Tkapp_WantObjects, METH_VARARGS},
_TKINTER_TKAPP_SETTRACE_METHODDEF
_TKINTER_TKAPP_GETTRACE_METHODDEF
{"call", Tkapp_Call, METH_VARARGS},
_TKINTER_TKAPP_EVAL_METHODDEF
_TKINTER_TKAPP_EVALFILE_METHODDEF

29
Modules/clinic/_tkinter.c.h generated
View file

@ -626,6 +626,33 @@ _tkinter_tkapp_loadtk(TkappObject *self, PyObject *Py_UNUSED(ignored))
return _tkinter_tkapp_loadtk_impl(self);
}
PyDoc_STRVAR(_tkinter_tkapp_settrace__doc__,
"settrace($self, func, /)\n"
"--\n"
"\n"
"Set the tracing function.");
#define _TKINTER_TKAPP_SETTRACE_METHODDEF \
{"settrace", (PyCFunction)_tkinter_tkapp_settrace, METH_O, _tkinter_tkapp_settrace__doc__},
PyDoc_STRVAR(_tkinter_tkapp_gettrace__doc__,
"gettrace($self, /)\n"
"--\n"
"\n"
"Get the tracing function.");
#define _TKINTER_TKAPP_GETTRACE_METHODDEF \
{"gettrace", (PyCFunction)_tkinter_tkapp_gettrace, METH_NOARGS, _tkinter_tkapp_gettrace__doc__},
static PyObject *
_tkinter_tkapp_gettrace_impl(TkappObject *self);
static PyObject *
_tkinter_tkapp_gettrace(TkappObject *self, PyObject *Py_UNUSED(ignored))
{
return _tkinter_tkapp_gettrace_impl(self);
}
PyDoc_STRVAR(_tkinter_tkapp_willdispatch__doc__,
"willdispatch($self, /)\n"
"--\n"
@ -865,4 +892,4 @@ exit:
#ifndef _TKINTER_TKAPP_DELETEFILEHANDLER_METHODDEF
#define _TKINTER_TKAPP_DELETEFILEHANDLER_METHODDEF
#endif /* !defined(_TKINTER_TKAPP_DELETEFILEHANDLER_METHODDEF) */
/*[clinic end generated code: output=2a4e3bf8448604b5 input=a9049054013a1b77]*/
/*[clinic end generated code: output=61ba8eef2e489a1b input=a9049054013a1b77]*/