Use typeshed.Incomplete and object instead of Any in tkinter stubs #8458

Akuli · 2022-08-01T18:17:24Z

Created by replacing all Anys with Incomplete and then reviewing manually with git add -p.

Tkinter had quite a lot of Any for a few reasons:

Old versions of stubgen generated Any | None (actually Optional[Any]) for parameters with a None default value.
I used Any in callables before I learned about Callable[[foo], object] for ignored return values.
Things that are impossible to type accurately. I left these as Any.

…o tk-incomplete

stdlib/tkinter/__init__.pyi

stdlib/tkinter/commondialog.pyi

stdlib/tkinter/tix.pyi

stdlib/tkinter/ttk.pyi

stdlib/tkinter/__init__.pyi

Co-authored-by: Alex Waygood <[email protected]>

stdlib/tkinter/__init__.pyi

srittau

Thanks, this is very useful! I skimmed it, and while there are a few more places where the Incomplete could be removed, since this is only a stylistic nit, we can merge as is.

AlexWaygood · 2022-08-02T19:05:05Z

stdlib/tkinter/__init__.pyi

@@ -1126,7 +1131,7 @@ class Canvas(Widget, XView, YView):
        insertontime: int = ...,
        insertwidth: _ScreenUnits = ...,
        name: str = ...,
-        offset: Any = ...,  # undocumented
+        offset: Incomplete = ...,  # undocumented


Suggested change

offset: Incomplete = ..., # undocumented

offset=..., # undocumented

AlexWaygood · 2022-08-02T19:05:20Z

stdlib/tkinter/__init__.pyi

@@ -1165,7 +1170,7 @@ class Canvas(Widget, XView, YView):
        insertofftime: int = ...,
        insertontime: int = ...,
        insertwidth: _ScreenUnits = ...,
-        offset: Any = ...,  # undocumented
+        offset: Incomplete = ...,  # undocumented


Suggested change

offset: Incomplete = ..., # undocumented

offset=..., # undocumented

AlexWaygood · 2022-08-02T19:06:25Z

stdlib/tkinter/filedialog.pyi

-    def go(self, dir_or_file: Any = ..., pattern: str = ..., default: str = ..., key: Any | None = ...): ...
-    def quit(self, how: Any | None = ...) -> None: ...
+    how: Incomplete | None
+    def go(self, dir_or_file: Incomplete = ..., pattern: str = ..., default: str = ..., key: Incomplete | None = ...): ...


Suggested change

def go(self, dir_or_file: Incomplete = ..., pattern: str = ..., default: str = ..., key: Incomplete | None = ...): ...

def go(self, dir_or_file=..., pattern: str = ..., default: str = ..., key: Incomplete | None = ...): ...

AlexWaygood · 2022-08-02T19:07:35Z

stdlib/tkinter/ttk.pyi

@@ -77,7 +78,7 @@ class Button(Widget):
        default: Literal["normal", "active", "disabled"] = ...,
        image: tkinter._ImageSpec = ...,
        name: str = ...,
-        padding: Any = ...,  # undocumented
+        padding: Incomplete = ...,  # undocumented


Suggested change

padding: Incomplete = ..., # undocumented

padding=..., # undocumented

AlexWaygood · 2022-08-02T19:07:49Z

stdlib/tkinter/ttk.pyi

@@ -96,7 +97,7 @@ class Button(Widget):
        cursor: tkinter._Cursor = ...,
        default: Literal["normal", "active", "disabled"] = ...,
        image: tkinter._ImageSpec = ...,
-        padding: Any = ...,
+        padding: Incomplete = ...,


Suggested change

padding: Incomplete = ...,

padding=...,

AlexWaygood · 2022-08-02T19:09:33Z

stdlib/tkinter/ttk.pyi

@@ -546,7 +547,7 @@ class Notebook(Widget):
        sticky: str = ...,  # consists of letters 'n', 's', 'w', 'e', no repeats, may be empty
        padding: tkinter._Padding = ...,
        text: str = ...,
-        image: Any = ...,  # Sequence of an image name, followed by zero or more (sequences of one or more state names followed by an image name)
+        image: Incomplete = ...,  # Sequence of an image name, followed by zero or more (sequences of one or more state names followed by an image name)


Suggested change

image: Incomplete = ..., # Sequence of an image name, followed by zero or more (sequences of one or more state names followed by an image name)

image=..., # Sequence of an image name, followed by zero or more (sequences of one or more state names followed by an image name)

AlexWaygood · 2022-08-02T19:09:49Z

stdlib/tkinter/ttk.pyi

@@ -662,7 +663,7 @@ class Radiobutton(Widget):
        cursor: tkinter._Cursor = ...,
        image: tkinter._ImageSpec = ...,
        name: str = ...,
-        padding: Any = ...,  # undocumented
+        padding: Incomplete = ...,  # undocumented


Suggested change

padding: Incomplete = ..., # undocumented

padding=..., # undocumented

AlexWaygood · 2022-08-02T19:09:59Z

stdlib/tkinter/ttk.pyi

@@ -682,7 +683,7 @@ class Radiobutton(Widget):
        compound: _TtkCompound = ...,
        cursor: tkinter._Cursor = ...,
        image: tkinter._ImageSpec = ...,
-        padding: Any = ...,
+        padding: Incomplete = ...,


Suggested change

padding: Incomplete = ...,

padding=...,

AlexWaygood · 2022-08-02T19:10:13Z

stdlib/tkinter/ttk.pyi

@@ -869,7 +870,7 @@ class Spinbox(Entry):
        invalidcommand: tkinter._EntryValidateCommand = ...,  # undocumented
        justify: Literal["left", "center", "right"] = ...,  # undocumented
        name: str = ...,
-        show: Any = ...,  # undocumented
+        show: Incomplete = ...,  # undocumented


Suggested change

show: Incomplete = ..., # undocumented

show=..., # undocumented

AlexWaygood · 2022-08-02T19:10:26Z

stdlib/tkinter/ttk.pyi

@@ -898,7 +899,7 @@ class Spinbox(Entry):
        increment: float = ...,
        invalidcommand: tkinter._EntryValidateCommand = ...,
        justify: Literal["left", "center", "right"] = ...,
-        show: Any = ...,
+        show: Incomplete = ...,


Suggested change

show: Incomplete = ...,

show=...,

github-actions · 2022-08-02T19:12:38Z

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

Akuli · 2022-08-02T19:42:01Z

Don't know how I missed all of those :D I'll make a new PR.

Akuli and others added 3 commits August 1, 2022 21:16

Use Incomplete in tkinter stubs

9e26c33

pyclean go brr

82b2a93

[pre-commit.ci] auto fixes from pre-commit.com hooks

e594fa3

This comment has been minimized.

Sign in to view

Akuli added 2 commits August 1, 2022 21:27

pyright ignores

86f1652

Merge branch 'tk-incomplete' of https://github.com/Akuli/typeshed int…

621ed21

…o tk-incomplete

Akuli changed the title ~~Use typeshed.Incomplete in tkinter stubs~~ Use typeshed.Incomplete and object instead of Any in tkinter stubs Aug 1, 2022

This comment has been minimized.

Sign in to view

Akuli commented Aug 1, 2022

View reviewed changes

Akuli added 3 commits August 1, 2022 22:47

Don't touch cnf arguments

edc173e

Apply suggestions from code review

ee20c75

Merge remote-tracking branch 'me/tk-incomplete' into tk-incomplete

e4304f6

This comment has been minimized.

Sign in to view

Akuli marked this pull request as ready for review August 1, 2022 20:01

srittau reviewed Aug 2, 2022

View reviewed changes

stdlib/tkinter/__init__.pyi Show resolved Hide resolved

AlexWaygood reviewed Aug 2, 2022

View reviewed changes

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

Update stdlib/tkinter/__init__.pyi

3c70dce

Co-authored-by: Alex Waygood <[email protected]>

Akuli commented Aug 2, 2022

View reviewed changes

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

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

Akuli added 2 commits August 2, 2022 21:41

Update stdlib/tkinter/__init__.pyi

c803959

Update stdlib/tkinter/__init__.pyi

9101e52

This comment has been minimized.

Sign in to view

srittau approved these changes Aug 2, 2022

View reviewed changes

This comment has been minimized.

Sign in to view

Akuli and others added 2 commits August 2, 2022 22:03

Delete remaining unnecessary Incompletes

07e676a

[pre-commit.ci] auto fixes from pre-commit.com hooks

626542a

Akuli merged commit 5e5f3b4 into python:master Aug 2, 2022

Akuli deleted the tk-incomplete branch August 2, 2022 19:10

AlexWaygood reviewed Aug 2, 2022

View reviewed changes

Akuli mentioned this pull request Aug 2, 2022

tkinter: get rid of unnecessary Incomplete #8471

Merged

hauntsaninja mentioned this pull request Aug 2, 2022

Preferring explicit Incomplete for unannotated arguments #8472

Closed

Josverl mentioned this pull request Aug 12, 2022

Verify correct effects of mypy switch Any --> Incomplete Josverl/micropython-stubber#254

Closed

2 tasks

	offset: Incomplete = ..., # undocumented
	offset=..., # undocumented

	def go(self, dir_or_file: Incomplete = ..., pattern: str = ..., default: str = ..., key: Incomplete \| None = ...): ...
	def go(self, dir_or_file=..., pattern: str = ..., default: str = ..., key: Incomplete \| None = ...): ...

	padding: Incomplete = ..., # undocumented
	padding=..., # undocumented

	image: Incomplete = ..., # Sequence of an image name, followed by zero or more (sequences of one or more state names followed by an image name)
	image=..., # Sequence of an image name, followed by zero or more (sequences of one or more state names followed by an image name)

	show: Incomplete = ..., # undocumented
	show=..., # undocumented

Uh oh!

Use typeshed.Incomplete and object instead of Any in tkinter stubs #8458

Use typeshed.Incomplete and object instead of Any in tkinter stubs #8458

Uh oh!

Conversation

Akuli commented Aug 1, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

This comment has been minimized.

This comment has been minimized.

srittau left a comment

Choose a reason for hiding this comment

Uh oh!

This comment has been minimized.

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Aug 2, 2022

Uh oh!

Akuli commented Aug 2, 2022

Uh oh!

Uh oh!

Akuli commented Aug 1, 2022 •

edited

Loading