Deprecate ImageTk._show

Author: radarhere

Tests/test_imagetk.py

@@ -112,3 +112,13 @@ def test_bitmapimage() -> None:
 
     with pytest.raises(ValueError):
         ImageTk.BitmapImage()
+
+
+def test_show_deprecated() -> None:
+    im = hopper()
+
+    with pytest.warns(DeprecationWarning):
+        try:
+            ImageTk._show(im, "test")
+        except tk.TclError:
+            pass

docs/deprecations.rst

@@ -193,6 +193,14 @@ Image.Image.get_child_images()
 method uses an image's file pointer, and so child images could only be retrieved from
 an :py:class:`PIL.ImageFile.ImageFile` instance.
 
+ImageTk._show()
+^^^^^^^^^^^^^^^
+
+.. deprecated:: 11.2.0
+
+``ImageTk._show()`` has been deprecated, as it was an unused helper for
+:py:meth:`.Image.Image.show`.
+
 Removed features
 ----------------
 

docs/releasenotes/11.2.0.rst

@@ -33,6 +33,14 @@ Image.Image.get_child_images()
 method uses an image's file pointer, and so child images could only be retrieved from
 an :py:class:`PIL.ImageFile.ImageFile` instance.
 
+ImageTk._show()
+^^^^^^^^^^^^^^^
+
+.. deprecated:: 11.2.0
+
+``ImageTk._show()`` has been deprecated, as it was an unused helper for
+:py:meth:`.Image.Image.show`.
+
 API Changes
 ===========
 

src/PIL/ImageTk.py

@@ -31,6 +31,7 @@
 from typing import TYPE_CHECKING, Any, cast
 
 from . import Image, ImageFile
+from ._deprecate import deprecate
 
 if TYPE_CHECKING:
     from ._typing import CapsuleType
@@ -266,8 +267,6 @@ def getimage(photo: PhotoImage) -> Image.Image:
 
 
 def _show(image: Image.Image, title: str | None) -> None:
-    """Helper for the Image.show method."""
-
     class UI(tkinter.Label):
         def __init__(self, master: tkinter.Toplevel, im: Image.Image) -> None:
             self.image: BitmapImage | PhotoImage
@@ -281,6 +280,7 @@ def __init__(self, master: tkinter.Toplevel, im: Image.Image) -> None:
                 image = self.image
             super().__init__(master, image=image, bg="black", bd=0)
 
+    deprecate("ImageTk._show", 13)
     if not getattr(tkinter, "_default_root"):
         msg = "tkinter not initialized"
         raise OSError(msg)