官方教程¶

一、阅前须知¶

1.1 标签说明*¶

• new: 最新功能，需要最新提交的 tkintertools 版本，而非已发行的版本；
• deprecated: 弃用功能，未来将不再使用；
• experimental: 实验性功能，功能可能不完善或者存在问题；
• fixed: 修复的功能，当前版本存在问题但最新版本中修复的；
• bug: 存在已知问题的功能；
• third-party: 第三方功能，功能由第三方包提供；

1.2 主题说明*¶

此网站主题默认跟随系统，可手动调节为暗色主题或者亮色主题，这不仅会影响网站的颜色外观，更会影响部分在不同主题下的图片，因为 tkintertools 涉及亮色和暗色主题，所以部分效果预览图也会同步受网站主题而切换。

例如，下面的 “图1 在 VSC 中查看类的文档字符串” 就受网站主题影响，大家可以试着在页面顶部切换网站主题颜色，看看这张图片有什么变化。

此外，本站的所有图片都可以通过点击来放大。

1.3 图像说明*¶

图形分为两种，一种是由图片文件直接展示的，还有一种是由 Markdown 的 Mermaid 语法代码块生成的，如下面的流程图。某些时候这些图没有完全生成，而是呈现出一种源代码的状态，此时可以尝试刷新网页重新让它们生成。

另外，它们的颜色也与主题有关。

1.4 前置需求¶

推荐在阅读此教程的同时搭配 Visual Studio Code（以下简称 VSC）进行开发，使用 PyCharm 或者 Visual Studio 也可以，但我个人更推荐使用 VSC。

tkintertools 3（以下简称 tkt 3 或 tkt） 专门对 VSC 做了文档字符串的优化，可以十分方便地在 VSC 内看到每个函数、类甚至是常量的详细信息，包括它们的类型、默认值和使用方法。只需要将鼠标移动到想要查看的函数或者类上面即可，PyCharm 和 Visual Studio 也有类似的功能，但渲染效果不如 VSC 的那么好。虽然可以直接查看文档字符串，但 tkt 3 在开发的时候为了力求符合 PEP 8 的规则，所以文档字符串均是英文的。阅读起来不方便的朋友们可以在本站查阅教程来进行辅助开发。

图1 在 VSC 中查看类的文档字符串

最后，请注意，tkt 3 目前仍处于测试阶段，还存在一些问题仍需解决，如若遇到问题，可以在仓库提出一个 Issue，我会尽可能地解决它们。另外，不要一次性提太多的 Issue，参与本项目开发工作的只有我一人，忙不过来。

二、想说的一些事情¶

2.1 关于该项目名字的由来¶

明明是个框架（虽然不大），但为什么名字是 “tkintertools” 而不是 “tkinterframework” 或者别的呢？

实际上，以前我只是想做一个小工具辅助开发，但随着做的东西越来越多，就想着把它们整合起来做成一个模块，这就是 tkt 1 了。tkt 1 并没有在 PyPI 上发布，因为它纯粹是我自己使用的，但后来觉着自己写的还不错，就又将其功能充分扩展了一下，从单个的模块发展到了一个包，并发到 PyPI 上面供别人使用。而从一开始，名字就没改过。

flowchart LR

    subgraph module / 模块
    1(0.1) -.-> 2(2.5.11)
    end
    subgraph package / 包
    3(2.5.12) -.-> 4(3.0.0.alpha3)
    end
    subgraph library / 库
    5(3.0.0.alpha4) -.-> 6(latest)
    end
    2 --> 3
    4 --> 5

到现在的 tkt 3，它已经不是一个简单的包了，而是包内含有包（应该可以说是一个小框架或者库了），但鉴于项目改个名不方便（PyPI 上只能重新建个新项目），改了后原来的数据（如下载量）都会丢失，同时会影响到一些已经使用 tkt 2 的用户，就没改了。

2.2 作者的话¶

此项目完全是我以前一时兴起做的，从一代到二代，再到现在的三代，已经过去将近两年了。

大家如果觉得这个项目不错，还请帮忙点一个免费的 ⭐Star 吧，本人只是一个非计算机专业，自学编程大学牲，要点免费的 ⭐Star 不过分吧。