Skip to content
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.

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

gh-66410: Do not stringify arguments of Tkinter callback #98592

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
@@ -652,6 +652,16 @@ Porting to Python 3.12
:class:`bytes` type is accepted for bytes strings.
(Contributed by Victor Stinner in :gh:`98393`.)

* Callbacks registered in the :mod:`tkinter` module now take arguments as
various Python objects (``int``, ``float``, ``bytes``, ``tuple``),
not just ``str``.
To restore the previous behavior set :mod:`!tkinter` module global
:data:`~tkinter.wantobject` to ``1`` before creating the
:class:`~tkinter.Tk` object or call the :meth:`~tkinter.Tk.wantobject`
method of the :class:`!Tk` object with argument ``1``.
Calling it with argument ``2`` restores the current default behavior.
(Contributed by Serhiy Storchaka in :gh:`66410`.)

Deprecated
----------

@@ -107,7 +107,7 @@ def dispatch(self, operation, *args):
to *args to accomplish that. For an example, see colorizer.py.
'''
m = self._operations.get(operation)
m = self._operations.get(str(operation))
try:
if m:
return m(*args)
@@ -487,29 +487,36 @@ def testfunc(arg):
return arg
self.interp.createcommand('testfunc', testfunc)
self.addCleanup(self.interp.tk.deletecommand, 'testfunc')
def check(value, expected=None, *, eq=self.assertEqual):
if expected is None:
expected = value
def check(value, expected1=None, expected2=None, *, eq=self.assertEqual):
expected = value
if self.wantobjects >= 2:
if expected2 is not None:
expected = expected2
expected_type = type(expected)
else:
if expected1 is not None:
expected = expected1
expected_type = str
nonlocal result
result = None
r = self.interp.call('testfunc', value)
self.assertIsInstance(result, str)
self.assertIsInstance(result, expected_type)
eq(result, expected)
self.assertIsInstance(r, str)
self.assertIsInstance(r, expected_type)
eq(r, expected)
def float_eq(actual, expected):
self.assertAlmostEqual(float(actual), expected,
delta=abs(expected) * 1e-10)

check(True, '1')
check(False, '0')
check(True, '1', 1)
check(False, '0', 0)
check('string')
check('string\xbd')
check('string\u20ac')
check('string\U0001f4bb')
if sys.platform != 'win32':
check('<\udce2\udc82\udcac>', '<\u20ac>')
check('<\udced\udca0\udcbd\udced\udcb2\udcbb>', '<\U0001f4bb>')
check('<\udce2\udc82\udcac>', '<\u20ac>', '<\u20ac>')
check('<\udced\udca0\udcbd\udced\udcb2\udcbb>', '<\U0001f4bb>', '<\U0001f4bb>')
check('')
check(b'string', 'string')
check(b'string\xe2\x82\xac', 'string\xe2\x82\xac')
@@ -531,9 +538,13 @@ def float_eq(actual, expected):
check(float('inf'), eq=float_eq)
check(-float('inf'), eq=float_eq)
# XXX NaN representation can be not parsable by float()
check((), '')
check((1, (2,), (3, 4), '5 6', ()), '1 2 {3 4} {5 6} {}')
check([1, [2,], [3, 4], '5 6', []], '1 2 {3 4} {5 6} {}')
check((), '', '')
check((1, (2,), (3, 4), '5 6', ()),
'1 2 {3 4} {5 6} {}',
(1, (2,), (3, 4), '5 6', ''))
check([1, [2,], [3, 4], '5 6', []],
'1 2 {3 4} {5 6} {}',
(1, (2,), (3, 4), '5 6', ''))

def test_splitlist(self):
splitlist = self.interp.tk.splitlist
@@ -40,7 +40,7 @@
from tkinter.constants import *
import re

wantobjects = 1
wantobjects = 2

TkVersion = float(_tkinter.TK_VERSION)
TclVersion = float(_tkinter.TCL_VERSION)
@@ -1648,7 +1648,10 @@ def getint_event(s):
try:
e.type = EventType(T)
except ValueError:
e.type = T
try:
e.type = EventType(str(T))
except ValueError:
e.type = T
try:
e.widget = self._nametowidget(W)
except KeyError:
@@ -0,0 +1,7 @@
Callbacks registered in the :mod:`tkinter` module now take arguments as
various Python objects (``int``, ``float``, ``bytes``, ``tuple``), not just
``str``. To restore the previous behavior set :mod:`!tkinter` module global
:data:`~tkinter.wantobject` to ``1`` before creating the
:class:`~tkinter.Tk` object or call the :meth:`~tkinter.Tk.wantobject`
method of the :class:`!Tk` object with argument ``1``. Calling it with
argument ``2`` restores the current default behavior.
@@ -2190,7 +2190,7 @@ _tkinter_tkapp_splitlist(TkappObject *self, PyObject *arg)

/* Client data struct */
typedef struct {
PyObject *self;
TkappObject *self;
PyObject *func;
} PythonCmd_ClientData;

@@ -2214,6 +2214,7 @@ PythonCmd(ClientData clientData, Tcl_Interp *interp,
PyObject *args, *res;
int i;
Tcl_Obj *obj_res;
int objargs = data->self->wantobjects >= 2;

ENTER_PYTHON

@@ -2222,7 +2223,8 @@ PythonCmd(ClientData clientData, Tcl_Interp *interp,
return PythonCmd_Error(interp);

for (i = 0; i < (objc - 1); i++) {
PyObject *s = unicodeFromTclObj(objv[i + 1]);
PyObject *s = objargs ? FromObj(data->self, objv[i + 1])
: unicodeFromTclObj(objv[i + 1]);
if (!s) {
Py_DECREF(args);
return PythonCmd_Error(interp);
@@ -2324,7 +2326,7 @@ _tkinter_tkapp_createcommand_impl(TkappObject *self, const char *name,
return PyErr_NoMemory();
Py_INCREF(self);
Py_INCREF(func);
data->self = (PyObject *) self;
data->self = self;
data->func = func;
if (self->threaded && self->thread_id != Tcl_GetCurrentThread()) {
Tcl_Condition cond = NULL;
@@ -2851,7 +2853,7 @@ Tkapp_WantObjects(PyObject *self, PyObject *args)
if (!PyArg_ParseTuple(args, "|i:wantobjects", &wantobjects))
return NULL;
if (wantobjects == -1)
return PyBool_FromLong(((TkappObject*)self)->wantobjects);
return PyLong_FromLong(((TkappObject*)self)->wantobjects);
((TkappObject*)self)->wantobjects = wantobjects;

Py_RETURN_NONE;