gh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 #124156

culler · 2024-09-17T04:40:56Z

This PR updates tkinter, ttk, test.test_tkinter and test.test_ttk to make them work and pass tests when built against either TclTk 8.6.15, which was released today, or TclTk 9.0.0 which currently has a release candidate and will be released soon. The changes to the tests include some re-organization to make it easier to accommodate expected development of Tk 9, particularly with respect to the new TclObject of type "pixels" used in Tk 9 for options whose values represent screen distances.

Please also see the discussion on PR #124112.

Note that, unlike #124112, this PR targets Python 3.14.

Issue: Update tkinter to use Tk 8.6.15 or (better) Tk 9.0 #124111

bedevere-app · 2024-09-17T04:41:04Z

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

zooba

Do you know why your generated files look like they're completely changed? It is line endings being bad? (I believe our regen scripts assume you're using autocrlf on Windows.)

PCbuild/tcltk.props

…tting.

culler · 2024-09-19T16:38:05Z

Do you know why your generated files look like they're completely changed? It is line endings being bad? (I believe our regen scripts assume you're using autocrlf on Windows.)

I have no idea. I committed those by mistake, since I am used to using git commit -a. It has something to do with Windows - those files were not changed by other platforms.

I think I have now restored the autogenerated files that I committed by mistake.

zware

Looking good! I have some comments that are mostly style nits, and I think we may want to hold off on the changes to PCbuild/. I don't think we'll be able to move the Windows builds for <=3.13 to Tcl/Tk 9 (at least not immediately), so it will make backporting the other changes easier to leave the 3.14 PCbuild/ updates to a separate PR.

Thanks!

Lib/test/test_tkinter/test_misc.py

Lib/test/test_tkinter/test_widgets.py

Lib/test/test_tkinter/widget_tests.py

Lib/test/test_ttk/test_widgets.py

…pped and _no_round.

culler · 2024-09-20T16:38:46Z

I think I have now addressed all issues raised in the comments. Is there anything else that is needed?

zooba · 2024-09-23T15:09:09Z

We don't want example files in the build directory. To "save" the changes for later, they could either be a draft PR, comments in the file (not preferred), or you could add the changes with Condition="$(TclMajorVersion) == '9'" checks so that they automatically apply when building against 9.0 (preferred).¹

Number comparisons are a bit wonky in MSBuild, so usually just best to pick the most sensible default. In this case, it's probably actually to check $(TclMajorVersion) == '8' for the old behaviour, so that when 10.0 comes out it'll get the newer behaviours. ↩

culler · 2024-09-23T15:34:12Z

We don't want example files in the build directory. To "save" the changes for later, they could either be a draft PR, comments in the file (not preferred), or you could add the changes with Condition="$(TclMajorVersion) == '9'" checks so that they automatically apply when building against 9.0 (preferred).1

Footnotes
1. Number comparisons are a bit wonky in MSBuild, so usually just best to pick the most sensible default. In this case, it's probably actually to check `$(TclMajorVersion) == '8'` for the old behaviour, so that when 10.0 comes out it'll get the newer behaviours. [↩](#user-content-fnref-1-9d9cf4f3af8602fa729bad031ef1ba2c)

Sure. I will attempt to modify _tkinter.vcxproj to allow building against either 8.6.14 or 9.0.0. (Note that 8.6.15 has been released, but the binaries are not available to get_externals.bat yet.)

…9_for_python314

…ersion by setting the TclVersion environment variable

…9_for_python314

culler · 2024-09-25T17:08:19Z

I think this PR is finished. The PR checks test against Tcl/Tk 8.6.14, and they are showing no failures. I have tested against Tcl/Tk 8.6.15 and Tcl/Tk 9.0.0 (rc2) on my own machines, running Ubuntu 22.04, Windows 11, and macOS 14. There are no failures in those 6 cases. The issue reported in #124378 with 8.6.15 has been resolved here.

The release of Tcl/Tk 9.0.0 is expected within a week, and surely will happen by the end of next week.

zware

This is great, thank you! I'm satisfied with this change overall, but I think we should get a once-over from @serhiy-storchaka for the tkinter changes and a final confirmation from @zooba that the PCbuild/ changes match his expectations.

With your permission, I'd like to extract your ttk Notebook test fixes to a separate PR so that we can go ahead with it and get it backported. (If you would prefer to make that split yourself, that works for me.)

I expect that we will eventually be backporting this whole PR even if we don't start shipping 9.0 with our <3.14 binaries because at some point our non-Windows CI systems will inevitably update to 9.0, but I'm not sure how quickly that will happen and want to be sure we get 8.6.15 supported as soon as we can.

Lib/test/test_tkinter/test_misc.py

zware · 2024-09-25T17:38:08Z

Lib/test/test_tkinter/support.py

@@ -112,6 +113,10 @@ def get_tk_patchlevel(root):
 def pixels_conv(value):
    return float(value[:-1]) * units[value[-1:]]

+pix_re = re.compile(r'[0-9]*\.?[0-9]*[cimp]{1}')
+def is_pixel_str(x):
+    return pix_re.fullmatch(x) != None


Nit: this doesn't seem to be used anymore.

culler · 2024-09-25T18:15:25Z

This is great, thank you! I'm satisfied with this change overall, but I think we should get a once-over from @serhiy-storchaka for the tkinter changes and a final confirmation from @zooba that the PCbuild/ changes match his expectations.

Thanks! That sounds good,

With your permission, I'd like to extract your ttk Notebook test fixes to a separate PR so that we can go ahead with it and get it backported. (If you would prefer to make that split yourself, that works for me.)

By all means. I would prefer to have you handle the split.

I expect that we will eventually be backporting this whole PR even if we don't start shipping 9.0 with our <3.14 binaries because at some point our non-Windows CI systems will inevitably update to 9.0, but I'm not sure how quickly that will happen and want to be sure we get 8.6.15 supported as soon as we can.

Great!

culler · 2024-09-25T20:10:05Z

According to this email the release of Tcl/Tk 9.0.0.0 will happen tomorrow.

Addendum: Tcl/Tk 9.0.0.0 were in fact released today 2/26/2024 as scheduled.

zooba

Along with the MSI changes (and possibly under PC/layout as well, I haven't checked), we need to make sure that we're okay with redistributing libtommath.dll and also that there isn't a static linking option for it. zlib unfortunately causes us trouble, but static linking here is impossible (because Tcl/Tk doesn't allow for it in their build scripts - I suspect the same will apply to tommath).

I'm okay with merging without the MSI changes, but we then cannot update any releases until it's done. As annoying as it is for backports, I'd require a comment in get_externals.bat to this effect.

PCbuild/_tkinter.vcxproj

PCbuild/tcltk.props

zooba · 2024-09-27T11:13:26Z

PCbuild/tcltk.props

@@ -17,15 +17,20 @@
    <tcltkDir Condition="$(tcltkDir) == ''">$(ExternalsDir)tcltk-$(TclVersion)\$(ArchName)\</tcltkDir>
    <tclWin32Exe Condition="$(Platform) == 'Win32'">$(tcltkDir)\bin\tclsh$(TclMajorVersion)$(TclMinorVersion)t.exe</tclWin32Exe>
    <tclWin32Exe Condition="$(Platform) != 'Win32'">$(tcltkDir)\..\win32\bin\tclsh$(TclMajorVersion)$(TclMinorVersion)t.exe</tclWin32Exe>
+    <tclExternalTommath Condition="$(TclMajorVersion) == '9'">TCL_WITH_EXTERNAL_TOMMATH;</tclExternalTommath>


This is not used anywhere, just remove it.

Actually, the TCL_WITH_EXTERNAL_TOMMATH constant is used when building against TclTk 9.0; although it is not used by 8.6. With 9.0, if it is not defined then all of the symbols defined in libtommath.dll are reported by the linker as being undefined. I believe that this is related to how the Tcl stubs library works; it is not a straightforward linker error since libtommath.dll is being passed to the linker.

One might hope that the existence of a constant named TCL_WITH_EXTERNAL_TOMMATH indicates that one could choose not to have an external libtommath.dlll and instead arrange for libtommath to be statically linked into libtcl.dll, as is the case with Tcl 8.6. However, I was not able to find a combination of build options which accomplished that. I will try to find out if it is possible.

@zooba: As far as I can tell. the following command uses MSVC to build a static library tcl90s.lib which has both zlib and (part of) libtommath built-in:
nmake -f makefile.vc TCL_WITH_INTERNAL_ZLIB=1 TCL_WITH_EXTERNAL_TOMMATH=0 STATIC_BUILD=1

According to dumpbin, the tclsh90s.exe executable built by that command does not have libtommath.dll or zlib.dll as dependencies. So presumably the same would be true of the _tkinter extension if it were linked against tcl90s.lib.

If you are willing to use gcc in msys64 then configure --disable-static seems to do the equivalent thing.

Reference: https://core.tcl-lang.org/tips/doc/trunk/tip/538.md

…9_for_python314

It's not really the place to call out TclVersion particularly. We probably should have a note about environment variables somewhere, but I don't have a good wording for it at the moment. We can add that later on.

oehhar · 2024-11-15T14:02:28Z

Big applause to Marc for this big bunch of work. I am sure, the TkInter community will enjoy tk 9.0, as it has a better look and scaling ability of the whole gui.
Harald with greeting from the Tcl/Tk team !

bedevere-app · 2024-11-28T13:55:14Z

GH-127364 is a backport of this pull request to the 3.13 branch.

…ythonGH-124156) (cherry picked from commit 47cbf03)

vstinner · 2024-11-29T09:45:52Z

I propose to backport this change to Python 3.13, see: #127364.

See the discussion on the issue for the backport rationale.

…ythonGH-124156)

culler added 2 commits September 16, 2024 18:14

New branch for PR against Python 3.14.

797ab58

Ttk tests on linux

03ccc1b

bedevere-app bot added the awaiting review label Sep 17, 2024

bedevere-app bot mentioned this pull request Sep 17, 2024

Update tkinter to use Tk 8.6.15 or (better) Tk 9.0 #124111

Open

Remove trailing whitespace.

d7fdc88

This comment was marked as duplicate.

Sign in to view

culler added 2 commits September 17, 2024 10:39

Add NEWS file.

9fe5e01

Make Windows build work; adjust for new changes to Canvas.

144c754

culler requested a review from a team as a code owner September 19, 2024 16:11

zooba reviewed Sep 19, 2024

View reviewed changes

PCbuild/tcltk.props Outdated Show resolved Hide resolved

PCbuild/tcltk.props Outdated Show resolved Hide resolved

Attempt to restore autogenerated files that git tricked me into commi…

3b21086

…tting.

Revert other autogenerated files committed by mistake

485e38a

zware reviewed Sep 19, 2024

View reviewed changes

Lib/test/test_tkinter/test_misc.py Outdated Show resolved Hide resolved

Lib/test/test_tkinter/test_widgets.py Outdated Show resolved Hide resolved

Lib/test/test_tkinter/widget_tests.py Outdated Show resolved Hide resolved

Lib/test/test_ttk/test_widgets.py Outdated Show resolved Hide resolved

culler added 7 commits September 19, 2024 14:06

Revert one more autogenerated file committed by mistake

5a954ec

Reference for combobox issue; address conditional definitions of _cli…

50d6958

…pped and _no_round.

Revert PCbuild changes; add examples for tk 9

ee186de

Adjust no_round for Canvas and Scrollbar.

1318d04

Adjust _clipped for Canvas once more.

e68994f

Hmmm = Canvas does clip highlightthickness.

c069c89

Remove message catalog.

8072c54

culler requested a review from zware September 20, 2024 16:38

Force checks to rerun since CLA signing seems hung. (No changes.)

ec56443

culler force-pushed the tk9_for_python314 branch from 8072c54 to ec56443 Compare September 21, 2024 02:06

culler added 2 commits September 23, 2024 11:39

Merge branch 'tk9_for_python314' of github.com:culler/cpython into tk…

4f753f8

…9_for_python314

Update build files to use Tcl/Tk 8.6.14 by default but to allow any v…

bf2243f

…ersion by setting the TclVersion environment variable

culler added 4 commits September 24, 2024 22:17

Deal with test_configure_width and test_configure_height for Notebooks.

2ef001b

Merge branch 'tk9_for_python314' of github.com:culler/cpython into tk…

cc50039

…9_for_python314

Need to make tests pass with 8.6.14 too, for the PR checks.

6a9ebc1

Fix version tests in NotebookTest

406aeff

zware approved these changes Sep 25, 2024

View reviewed changes

bedevere-app bot added awaiting merge and removed awaiting review labels Sep 25, 2024

Include changes suggested by @zware

5edecc1

culler requested a review from zooba September 25, 2024 18:29

zware requested a review from serhiy-storchaka September 25, 2024 18:36

zware mentioned this pull request Sep 25, 2024

gh-124378: Update test_ttk for Tcl/Tk 8.6.15 #124542

Merged

Merge branch 'main' into tk9_for_python314

f661969

zooba reviewed Sep 27, 2024

View reviewed changes

culler and others added 5 commits September 29, 2024 13:36

Add changes to tcltk.props and _tkinter.vcxproj suggested by @zooba

822c3bf

Merge branch 'tk9_for_python314' of github.com:culler/cpython into tk…

7d851a8

…9_for_python314

Merge branch 'main' into tk9_for_python314

635d807

Merge remote-tracking branch 'origin/main' into tk9_for_python314

ba09108

Formatting fixups, remove note from build.bat

9075a80

It's not really the place to call out TclVersion particularly. We probably should have a note about environment variables somewhere, but I don't have a good wording for it at the moment. We can add that later on.

zware changed the title ~~gh-124111 Update tkinter to use TclTk 8.6.15 or 9.0.0~~ gh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 Nov 14, 2024

zware merged commit 47cbf03 into python:main Nov 14, 2024
39 checks passed

bedevere-app bot removed the awaiting merge label Nov 14, 2024

TransparentLC mentioned this pull request Nov 18, 2024

项目中用到的tkinter（tcl和tk）可否更新到兼容9.0大版本，目前项目需要的是8.6大版本 TransparentLC/realesrgan-gui#91

Open

vstinner pushed a commit to vstinner/cpython that referenced this pull request Nov 28, 2024

pythongh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 (p…

8eb4d00

…ythonGH-124156) (cherry picked from commit 47cbf03)

picnixz pushed a commit to picnixz/cpython that referenced this pull request Dec 8, 2024

pythongh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 (p…

a693262

…ythonGH-124156)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

gh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 #124156

gh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 #124156

culler commented Sep 17, 2024 •

edited by bedevere-app bot

Loading

bedevere-app bot commented Sep 17, 2024

This comment was marked as duplicate.

zooba left a comment

culler commented Sep 19, 2024 •

edited

Loading

zware left a comment

culler commented Sep 20, 2024

zooba commented Sep 23, 2024

culler commented Sep 23, 2024

Footnotes

culler commented Sep 25, 2024

zware left a comment

zware Sep 25, 2024

culler commented Sep 25, 2024

culler commented Sep 25, 2024 •

edited

Loading

zooba left a comment

zooba Sep 27, 2024

culler Sep 29, 2024

culler Sep 30, 2024 •

edited

Loading

oehhar commented Nov 15, 2024

bedevere-app bot commented Nov 28, 2024

vstinner commented Nov 29, 2024

gh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 #124156

gh-124111: Update tkinter for compatibility with Tcl/Tk 9.0.0 #124156

Conversation

culler commented Sep 17, 2024 • edited by bedevere-app bot Loading

bedevere-app bot commented Sep 17, 2024

This comment was marked as duplicate.

zooba left a comment

Choose a reason for hiding this comment

culler commented Sep 19, 2024 • edited Loading

zware left a comment

Choose a reason for hiding this comment

culler commented Sep 20, 2024

zooba commented Sep 23, 2024

Footnotes

culler commented Sep 23, 2024

Footnotes

culler commented Sep 25, 2024

zware left a comment

Choose a reason for hiding this comment

zware Sep 25, 2024

Choose a reason for hiding this comment

culler commented Sep 25, 2024

culler commented Sep 25, 2024 • edited Loading

zooba left a comment

Choose a reason for hiding this comment

zooba Sep 27, 2024

Choose a reason for hiding this comment

culler Sep 29, 2024

Choose a reason for hiding this comment

culler Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

oehhar commented Nov 15, 2024

bedevere-app bot commented Nov 28, 2024

vstinner commented Nov 29, 2024

culler commented Sep 17, 2024 •

edited by bedevere-app bot

Loading

culler commented Sep 19, 2024 •

edited

Loading

culler commented Sep 25, 2024 •

edited

Loading

culler Sep 30, 2024 •

edited

Loading