More complete type stubs for tkinter Canvas methods. #5188

DanielRosenwasser · 2021-04-08T06:47:51Z

This change

Establishes a NewType called _ObjectId, meant to ensure that arbitrary handles aren't created.
Defines more specific method declarations for Canvas instances.

github-actions · 2021-04-08T07:06:32Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ /tmp/mypy_primer/new_typeshed/typeshed_to_test/stdlib/tkinter/__init__.pyi:1170: error: invalid syntax  [syntax]
- porcupine/utils.py:22: error: Cannot find implementation or library stub for module named "dacite"  [import]
- porcupine/settings.py:17: error: Cannot find implementation or library stub for module named "dacite"  [import]
- porcupine/settings.py:80: error: unused 'type: ignore' comment
- porcupine/plugins/langserver.py:29: error: Cannot find implementation or library stub for module named "sansio_lsp_client"  [import]
- porcupine/plugins/filetypes.py:11: error: Library stubs not installed for "toml" (or incompatible with Python 3.8)  [import]
- porcupine/plugins/filetypes.py:11: note: (or run "mypy --install-types" to install all missing stub packages)
- porcupine/plugins/filetypes.py:11: note: Hint: "python3 -m pip install types-toml"
- porcupine/plugins/filetypes.py:11: note: See https://mypy.readthedocs.io/en/latest/running_mypy.html#missing-imports

hauntsaninja · 2021-04-08T07:44:49Z

It'll be a couple years before typeshed can use PEP 570 syntax, for now positional-only arguments are indicated by prefixing with a double underscore.

srittau · 2021-04-08T08:00:55Z

Except for some auto generate code for protobuf, this is the first time we use NewType in typeshed. Just something we need to watch out for after the change is published.

hauntsaninja · 2021-04-08T08:05:24Z

Wow, I cannot wait to be done with Python 3.5.1 :-)

srittau

Thanks, remarks below! Also, running black on this file should hopefully fix the build issues.

stdlib/tkinter/__init__.pyi

DanielRosenwasser · 2021-04-10T07:44:05Z

I can't seem to get black installed on Windows for whatever reason, so I will hold off on that step if that's acceptable to you all.

Akuli · 2021-04-10T08:03:16Z

I blacked the code (pull before making more changes), but it is also possible on windows. I think something like:

py -m venv env
env\Scripts\activate.bat
pip install black
black stdlib

github-actions · 2021-04-10T08:06:05Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ porcupine/plugins/welcome.py:47: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/welcome.py:51: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/minimap.py:93: error: Argument "font" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/linenumbers.py:47: error: Argument 1 to "delete" of "Canvas" has incompatible type "str"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:331: error: Argument "font" to "create_text" of "Canvas" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/fold.py:60: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:64: error: Argument "columns" to "Treeview" has incompatible type "Tuple[str, str, str]"; expected "Union[str, Union[List[str], Tuple[str, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:93: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pastebin.py:200: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]

stdlib/tkinter/__init__.pyi

github-actions · 2021-04-10T08:21:09Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ porcupine/plugins/welcome.py:47: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/welcome.py:51: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/minimap.py:93: error: Argument "font" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/linenumbers.py:47: error: Argument 1 to "delete" of "Canvas" has incompatible type "str"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:331: error: Argument "font" to "create_text" of "Canvas" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/fold.py:60: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:64: error: Argument "columns" to "Treeview" has incompatible type "Tuple[str, str, str]"; expected "Union[str, Union[List[str], Tuple[str, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:93: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pastebin.py:200: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]

github-actions · 2021-04-10T08:26:48Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ porcupine/plugins/welcome.py:47: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/welcome.py:51: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/minimap.py:93: error: Argument "font" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/linenumbers.py:47: error: Argument 1 to "delete" of "Canvas" has incompatible type "str"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:331: error: Argument "font" to "create_text" of "Canvas" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/fold.py:60: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:64: error: Argument "columns" to "Treeview" has incompatible type "Tuple[str, str, str]"; expected "Union[str, Union[List[str], Tuple[str, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:93: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pastebin.py:200: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]

stdlib/tkinter/__init__.pyi

Akuli · 2021-04-10T20:51:20Z

Can you find/replace tuple back to Tuple? The lower-case tuple seems to be causing mypy problems (#4820 ). Once those are no longer a problem, we can make a separate pull request that changes Tuple to tuple.

github-actions · 2021-04-10T20:53:13Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ porcupine/plugins/welcome.py:47: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/welcome.py:51: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/minimap.py:93: error: Argument "font" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/linenumbers.py:47: error: Argument 1 to "delete" of "Canvas" has incompatible type "str"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:331: error: Argument "font" to "create_text" of "Canvas" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/fold.py:60: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:64: error: Argument "columns" to "Treeview" has incompatible type "Tuple[str, str, str]"; expected "Union[str, Union[List[str], Tuple[str, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:93: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pastebin.py:200: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]

github-actions · 2021-04-10T20:53:56Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ porcupine/plugins/welcome.py:47: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/welcome.py:51: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/minimap.py:93: error: Argument "font" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/linenumbers.py:47: error: Argument 1 to "delete" of "Canvas" has incompatible type "str"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:331: error: Argument "font" to "create_text" of "Canvas" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/fold.py:60: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:64: error: Argument "columns" to "Treeview" has incompatible type "Tuple[str, str, str]"; expected "Union[str, Union[List[str], Tuple[str, Any]]]"  [arg-type]
+ porcupine/plugins/pluginmanager.py:93: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, str]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]
+ porcupine/plugins/pastebin.py:200: error: Argument "font" to "Label" has incompatible type "Tuple[str, int, Tuple[]]"; expected "Union[str, Font, Union[List[Any], Tuple[Any, Any]]]"  [arg-type]

github-actions · 2021-04-11T02:03:54Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ porcupine/plugins/linenumbers.py:47: error: Argument 1 to "delete" of "Canvas" has incompatible type "str"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[_CanvasObjectId, Iterable[_CanvasObjectId]]"  [arg-type]

Akuli · 2021-04-11T12:48:45Z

Often you can use a tag string instead of an item ID. The remaining mypy_primer failures are from code that does canvas.delete('all'), where 'all' is a tag string. That should be accepted whenever the manual page says tagOrId.

To fix this, you can replace _CanvasObjectId with Union[str, _CanvasObjectId] in a few places, or add a type alias:

_TagOrId = Union[_CanvasObjectId, str]

Akuli · 2021-04-17T19:29:21Z

@DanielRosenwasser Are you still interested in working on this? There's no hurry, but I can do the rest if you want.

DanielRosenwasser · 2021-04-17T22:02:47Z

Hey @Akuli let me know if there's anything I've missed in the latest changes.

github-actions · 2021-04-17T22:22:15Z

Diff from mypy_primer, showing the effect of this PR on open source code:

porcupine (https://github.com/Akuli/porcupine.git)
+ more_plugins/tetris.py:307: error: Argument 1 to "delete" of "Canvas" has incompatible type "int"; expected "Union[str, _CanvasItemId]"  [arg-type]

Akuli · 2021-04-18T14:54:14Z

The mypy_primer failure comes from code that (I wrote and) uses int as the type for canvas items. What would be the recommended way once this PR is merged? We have a few options:

Try to have mypy automatically determine the type (not possible in this case)
Use tkinter._CanvasItemId (I don't think this works, and it's fragile and not discoverable, not guessable, not documented anywhere)
Rename it to CanvasItemId and use that (would work, but still not discoverable/guessable/documented)
Just get rid of NewType and everything will work

What do you think?

DanielRosenwasser · 2021-04-18T17:00:28Z

I've been thinking about this a bit and it really depends on how much someone wants to protect against breaking the abstraction in addition to making sure you can't forge a fake object ID (on purpose or accidentally). In either case, it's not that important and unlikely that an ID will ever stop being an int.

DanielRosenwasser · 2021-04-18T17:00:50Z

So I'll try to just turn it into a plain type alias to int later today.

github-actions · 2021-04-21T16:44:14Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

github-actions · 2021-04-21T16:44:20Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

stdlib/tkinter/__init__.pyi

Akuli · 2021-04-21T20:22:25Z

The code needs blacking again. Let me know whether you want to black it yourself or you want me to black it again.

Co-authored-by: Akuli <akuviljanen17@gmail.com>

Akuli · 2021-04-21T21:25:01Z

I decided to black it

Akuli

Thanks!

DanielRosenwasser · 2021-04-21T21:27:22Z

Ah just as I was figuring out how to venv 😄

Thanks!

github-actions · 2021-04-21T21:39:54Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

github-actions · 2021-04-21T21:48:28Z

According to mypy_primer, this change has no effect on the checked open source code. 🤖🎉

More complete type stubs for tkinter Canvas methods.

b9a0b00

srittau requested changes Apr 8, 2021

View reviewed changes

DanielRosenwasser added 2 commits April 9, 2021 18:54

Some feedback.

ea23e77

Tuple.

dce09b5

Akuli added 2 commits April 10, 2021 11:04

black

a566452

isort

5d2c6fe

Akuli requested changes Apr 10, 2021

View reviewed changes

stdlib/tkinter/__init__.pyi Outdated Show resolved Hide resolved

DanielRosenwasser added 2 commits April 10, 2021 13:33

Add separator between positional-or-keyword args and keyword-only args.

7c2a0cc

int to float

7ff3351

Akuli requested changes Apr 10, 2021

View reviewed changes

stdlib/tkinter/__init__.pyi Outdated Show resolved Hide resolved

DanielRosenwasser added 3 commits April 10, 2021 18:39

Screen units.

1b78139

Back to Tuple.

a1d5b99

Use bool I guess.

9f3d67a

Addressed some more feedback.

4381924

DanielRosenwasser added 2 commits April 21, 2021 09:22

Switch to type alias.

2cd9d6a

Remove unused NewType import.

9fdba60

Akuli requested changes Apr 21, 2021

View reviewed changes

stdlib/tkinter/__init__.pyi Outdated Show resolved Hide resolved

DanielRosenwasser and others added 2 commits April 21, 2021 14:17

Update stdlib/tkinter/__init__.pyi

9a7a6b7

Co-authored-by: Akuli <akuviljanen17@gmail.com>

black

47308ec

Akuli approved these changes Apr 21, 2021

View reviewed changes

Akuli merged commit 863b8f2 into python:master Apr 22, 2021

Akuli mentioned this pull request Jun 6, 2021

Use pre-commit.ci on PRs #5552

Closed

DanielRosenwasser deleted the canvas branch April 19, 2024 18:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

More complete type stubs for tkinter Canvas methods. #5188

More complete type stubs for tkinter Canvas methods. #5188

DanielRosenwasser commented Apr 8, 2021

github-actions bot commented Apr 8, 2021

hauntsaninja commented Apr 8, 2021

srittau commented Apr 8, 2021

hauntsaninja commented Apr 8, 2021

srittau left a comment

DanielRosenwasser commented Apr 10, 2021

Akuli commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

Akuli commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 11, 2021

Akuli commented Apr 11, 2021

Akuli commented Apr 17, 2021

DanielRosenwasser commented Apr 17, 2021

github-actions bot commented Apr 17, 2021

Akuli commented Apr 18, 2021

DanielRosenwasser commented Apr 18, 2021

DanielRosenwasser commented Apr 18, 2021

github-actions bot commented Apr 21, 2021

github-actions bot commented Apr 21, 2021

Akuli commented Apr 21, 2021

Akuli commented Apr 21, 2021

Akuli left a comment

DanielRosenwasser commented Apr 21, 2021

github-actions bot commented Apr 21, 2021

github-actions bot commented Apr 21, 2021

More complete type stubs for tkinter Canvas methods. #5188

More complete type stubs for tkinter Canvas methods. #5188

Conversation

DanielRosenwasser commented Apr 8, 2021

github-actions bot commented Apr 8, 2021

hauntsaninja commented Apr 8, 2021

srittau commented Apr 8, 2021

hauntsaninja commented Apr 8, 2021

srittau left a comment

Choose a reason for hiding this comment

DanielRosenwasser commented Apr 10, 2021

Akuli commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

Akuli commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 10, 2021

github-actions bot commented Apr 11, 2021

Akuli commented Apr 11, 2021

Akuli commented Apr 17, 2021

DanielRosenwasser commented Apr 17, 2021

github-actions bot commented Apr 17, 2021

Akuli commented Apr 18, 2021

DanielRosenwasser commented Apr 18, 2021

DanielRosenwasser commented Apr 18, 2021

github-actions bot commented Apr 21, 2021

github-actions bot commented Apr 21, 2021

Akuli commented Apr 21, 2021

Akuli commented Apr 21, 2021

Akuli left a comment

Choose a reason for hiding this comment

DanielRosenwasser commented Apr 21, 2021

github-actions bot commented Apr 21, 2021

github-actions bot commented Apr 21, 2021