Skip to content

Add an _Image protocol to tkinter. #4766

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srittau merged 2 commits into from
Nov 13, 2020
Merged

Add an _Image protocol to tkinter. #4766

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f3ccb5c
Add an _Image protocol to tkinter.
rchen152 Nov 13, 2020
7967fe9
Add return types to _Image methods.
rchen152 Nov 13, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion stdlib/3/tkinter/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ _Cursor = Union[str, Tuple[str], Tuple[str, str], Tuple[str, str, str], Tuple[st
_EntryValidateCommand = Union[
Callable[[], bool], str, _TkinterSequence[str]
] # example when it's sequence: entry['invalidcommand'] = [entry.register(print), '%P']
_ImageSpec = Union[Image, str] # str can be from e.g. tkinter.image_names()
_ImageSpec = Union[_Image, str] # str can be from e.g. tkinter.image_names()
_Padding = Union[
_ScreenUnits,
Tuple[_ScreenUnits],
Expand Down Expand Up @@ -2831,6 +2831,12 @@ class OptionMenu(Menubutton):
# configure, config, cget are inherited from Menubutton
# destroy and __getitem__ are overrided, signature does not change

class _Image(Protocol):
tk: _tkinter.TkappType
def __del__(self) -> None: ...
Copy link
Member

@JelleZijlstra JelleZijlstra Nov 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

__del__ being part of a protocol seems odd, does tk really require it?

Copy link
Collaborator Author

@rchen152 rchen152 Nov 14, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I...don't really know. If there's documentation anywhere on what an image class should define to be tkinter-compatible, I haven't been able to find it. I just included all the methods that are present on both tkinter.Image and PIL.ImageTk.PhotoImage (except __str__).

def height(self) -> int: ...
def width(self) -> int: ...

class Image:
name: Any
tk: _tkinter.TkappType
Expand Down