Type annotation overhaul

[demberto]

Highlights:

• Removed redundant imports and sorted them.
• Type hinted almost all the functions in the entire code base (even some examples).
• Corrected many wrong and incomplete type hints (unspecialised collections, missing optionals, etc).
• Upgraded them to use __future__.annotations (3.7+ feature, which customtkinter supports).

This is a big PR, it will need a few inputs and revisions from you and me.
I have left type hinting to you or used Any at ambiguous places.
⚠️ There are quite a few places where redundant code is present.
⚠️ The unit tests raise a lot of errors and they need to be updated.

There are some glaring code quality issues all over; along with the lack of docstrings at many places.
I highly suggest you to integrate ruff and black in your pre-commit hooks or atleast in your workflow.

[bfedie518]

What's this *_? I've never seen that before.

[demberto]

x and y were unused in that context. Python uses the convention of naming unused variables as _. *_ does a tuple unpack operation and can be thought of as an *args parameter used in functions.

[demberto]

Also, there's multiple places in the code that require attention. Redundant None checks, incorrect default values to name a few. It prevents a complete type hinting of the codebase.
I am unfamiliar with the actual logic and considering that tkinter itself is a very poor API, I leave it as is

[bfedie518]

I discovered this library a month ago and have been making simple fixes and formatting changes in my fork. I need to do a deeper dive to learn how it really works/is supposed to work.

[elly-hacen]

Can you add toast messages functionality in CTk? 🥹

[ghost]

Perhaps a Pylint Github action...

[FedericoSpada]

Hi,
You used the "type1 | type2" convention that has been implemented in Python 3.10. Your code is not compatible with Python 3.7.

I've planned to add Type Hints myself in the near future. If you don't want to redo the work again, since I like your work on the Import clauses, you could create a new PR dedicated to that.

[bfedie518]

Hi, You used the "type1 | type2" convention that has been implemented in Python 3.10. Your code is not compatible with Python 3.7.

I've planned to add Type Hints myself in the near future. If you don't want to redo the work again, since I like your work on the Import clauses, you could create a new PR dedicated to that.

__future__.annotations adds support for the type1 | type2 convention to Python 3.7

[FedericoSpada]

Oh, I didn't know that.
Is it considered good practice instead of sticking to the previous Optional[Union[...]] convention?

[bfedie518]

Oh, I didn't know that. Is it considered good practice instead of sticking to the previous Optional[Union[...]] convention?

Yeah. The pipe is used instead of Union[], and | None is preferred over Optional[].

[FedericoSpada]

I meant: for Python 3.7 specifically, is it good practice to use from __future__ import annotations and the new pipe convention, or is it better to stick to the convention that was present when that Python version was released?
Since newer versions are retro-compatible and still allow the old convention, it may be good practice for projects that should work across multiple Python versions to stick to the old one.