gh-124111 Update tkinter to use TclTk 8.6.15 or 9.0.0 #124156
Conversation
|
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 |
|
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 |
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. |
There was a problem hiding this comment.
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!
…pped and _no_round.
|
I think I have now addressed all issues raised in the comments. Is there anything else that is needed? |
culler
force-pushed
the
tk9_for_python314
branch
from
8072c54
to
ec56443
Compare
|
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 Footnotes
|
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.) |
…ersion by setting the TclVersion environment variable
|
I have removed the "examples" and modified the build scripts to use the TclVersion environment variable to decide which Tk version gets used for the build. (The version must also be installed in ../externals/tcltk-W.X.Y.Z, which can either be done locally or by the get_externals script. I tested on my machine and was able to build both for Tk 8.6.14 (using the binaries downloaded by get_externals) and for Tk 9.0.0.0 (installed by me, by setting the INSTALLDIR variable in a standaard build of Tcl and Tk with nmake and makefile.vc). |
There was a problem hiding this comment.
Some of these changes cause failures for me on Pop_OS! 22.04 (Ubuntu 22.04 derivative) with Tcl/Tk 9.0.0b3. It's possible that I'm getting my configuration wrong, but switching to Tcl/Tk 9.0.0b3 without this PR causes one failure, then adding these changes introduces a bunch of other failures, mostly around rounding as far as I can tell.
I am getting no failures on Ubuntu 22.04. I think that you are probably using the released 9.0.b3 while I am using the tips of main branches of the fossil repositories for Tcl and Tk. (I did that because they presumably are closer to the actual 9.0.0 releases.) There have been recent changes to how some of the widgets handle rounding. I am using commits 8627aad9bd for Tcl and d2f53df7a8 for Tk. (Both from 9/23) Note: part of what I am trying to do here is to make it easier to adjust the tests as these sorts of changes happen. I think the plan is that eventually all of these options will be rounded. Also more options will be changed to accept pixel values (e.g. 10p or 23m). |
|
Ahh, that makes sense. It also makes me think we probably want to sit on this until 9.0 is actually released or has at least had a release candidate, though :-/ |
Sure. A release candidate is imminent. The core-9-0-0-rc branch is being finalized right now. |
|
I switched to the tip of the core-9-0-0-rc branches of Tcl and Tk and reran the tkinter and ttk tests on Ubuntu 22.04, I still am seeing no errors. Addendum 1: Also no errors on Windows 11 with the tips of the core-9-0-0-rc branches. Addendum2: Also no errors on macOS 14 with the tips of the cre-9-0-0-rc branches. Addendum3: The third Tcl 9.0.0.0 release candidate is now available here. I expect the final release will happen in the next week or two. |
|
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. |
There was a problem hiding this comment.
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/support.py
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
Nit: this doesn't seem to be used anymore.
Thanks! That sounds good,
By all means. I would prefer to have you handle the split.
Great! |
|
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. |
There was a problem hiding this comment.
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.
| @@ -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> | |||
There was a problem hiding this comment.
This is not used anywhere, just remove it.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
@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
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.