Skip to content

gh-127802: Schedule removal of legacy tkinter variable trace methods in 3.17 #152012

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

Open
serhiy-storchaka wants to merge 1 commit into
base: main
Choose a base branch
from
+28 −9
Open

gh-127802: Schedule removal of legacy tkinter variable trace methods in 3.17 #152012

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions Doc/deprecations/pending-removal-in-3.17.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,13 @@ Pending removal in Python 3.17

See :pep:`PEP 688 <688#current-options>` for more details.
(Contributed by Shantanu Jain in :gh:`91896`.)

* :mod:`tkinter`:

- The :class:`!tkinter.Variable` methods :meth:`!trace_variable`,
:meth:`!trace` (an alias of :meth:`!trace_variable`),
:meth:`!trace_vdelete` and :meth:`!trace_vinfo`, deprecated since
Python 3.14, are scheduled for removal in Python 3.17.
Use :meth:`!trace_add`, :meth:`!trace_remove` and :meth:`!trace_info`
instead.
(Contributed by Serhiy Storchaka in :gh:`120220`.)
24 changes: 15 additions & 9 deletions Lib/tkinter/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -505,12 +505,14 @@ def trace_variable(self, mode, callback):
Return the name of the callback.

This deprecated method wraps a deprecated Tcl method removed
in Tcl 9.0. Use trace_add() instead.
in Tcl 9.0 and will be removed in Python 3.17. Use trace_add()
instead.
"""
import warnings
warnings.warn(
"trace_variable() is deprecated and not supported with Tcl 9; "
"use trace_add() instead.",
"trace_variable() is deprecated and will be removed in Python "
"3.17; use trace_add() instead. It is not supported with "
"Tcl 9.",
DeprecationWarning, stacklevel=2)
cbname = self._register(callback)
self._tk.call("trace", "variable", self._name, mode, cbname)
Expand All @@ -525,12 +527,14 @@ def trace_vdelete(self, mode, cbname):
CBNAME is the name of the callback returned from trace_variable or trace.

This deprecated method wraps a deprecated Tcl method removed
in Tcl 9.0. Use trace_remove() instead.
in Tcl 9.0 and will be removed in Python 3.17. Use trace_remove()
instead.
"""
import warnings
warnings.warn(
"trace_vdelete() is deprecated and not supported with Tcl 9; "
"use trace_remove() instead.",
"trace_vdelete() is deprecated and will be removed in Python "
"3.17; use trace_remove() instead. It is not supported with "
"Tcl 9.",
DeprecationWarning, stacklevel=2)
self._tk.call("trace", "vdelete", self._name, mode, cbname)
cbname = self._tk.splitlist(cbname)[0]
Expand All @@ -548,12 +552,14 @@ def trace_vinfo(self):
"""Return all trace callback information.

This deprecated method wraps a deprecated Tcl method removed
in Tcl 9.0. Use trace_info() instead.
in Tcl 9.0 and will be removed in Python 3.17. Use trace_info()
instead.
"""
import warnings
warnings.warn(
"trace_vinfo() is deprecated and not supported with Tcl 9; "
"use trace_info() instead.",
"trace_vinfo() is deprecated and will be removed in Python "
"3.17; use trace_info() instead. It is not supported with "
"Tcl 9.",
DeprecationWarning, stacklevel=2)
return [self._tk.splitlist(x) for x in self._tk.splitlist(
self._tk.call("trace", "vinfo", self._name))]
Expand Down
3 changes: 3 additions & 0 deletions Misc/NEWS.d/next/Library/2026-06-23-17-14-04.gh-issue-127802.nGSxo6.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
The deprecated :class:`tkinter.Variable` methods :meth:`!trace_variable`,
:meth:`!trace`, :meth:`!trace_vdelete` and :meth:`!trace_vinfo` are now
scheduled for removal in Python 3.17.
Loading