Replaced image rendering from IPython's image display and overrided PIL's Image.show()

Author: daexs

bin/run_markdown.py

@@ -11,6 +11,7 @@
 import plotly.graph_objects as go
 import sys
 import traceback
+from PIL import Image
 
 
 def main():
@@ -83,6 +84,12 @@ def _capture_plotly_show(fig, counter, result, output_dir, stem):
     result["html_files"].append(html_filename)
     result.setdefault("html_content", []).append(html_content)
 
+def _capture_Image_show(img, counter, result, output_dir, stem):
+    """Saves Images instead of displaying them."""
+    png_filename = f"{stem}_image_{counter}.png"
+    png_path = output_dir / png_filename
+    img.save(png_path, "PNG")
+    result["images"].append(png_filename)
 
 def _generate_markdown(args, content, code_blocks, execution_results, output_dir):
     """Generate the output markdown with embedded results."""
@@ -211,6 +218,7 @@ def _run_all_blocks(args, code_blocks, stem=None, block_number=None):
             "__file__": "<markdown_code>",
         }
     figure_counter = 0
+    # img_counter = 0
     for i, block in enumerate(code_blocks):
         if block_number is None:
             _report(args.verbose > 1, f"- Executing block {i}/{len(code_blocks)}")
@@ -256,10 +264,18 @@ def patched_show(self, *args, **kwargs):
                 figure_counter += 1
                 if stem is not None:
                     _capture_plotly_show(self, figure_counter, result, output_dir, stem)
+            def patched_img_show(self, *args, **kwargs):
+                nonlocal figure_counter
+                figure_counter += 1
+                if stem is not None:
+                    _capture_Image_show(self, figure_counter, result, output_dir, stem)
             original_show = go.Figure.show
+            original_img_show = Image.Image.show
+            Image.Image.show = patched_img_show
             go.Figure.show = patched_show
             exec(code, exec_globals)
             go.Figure.show = original_show
+            Image.Image.show = original_img_show
 
     except Exception as e:
         result["error"] = f"Error executing code: {str(e)}\n{traceback.format_exc()}"

doc/python/static-image-export.md

@@ -200,19 +200,22 @@ fig = px.bar(data_canada, x='year', y='pop')
 img_bytes = fig.to_image(format="png")
 ```
 
-Here's the bytes object displayed using `IPython.display.Image`:
+Here's the bytes object displayed using `Image.show()`:
 
 ```python
-from IPython.display import Image
-Image(img_bytes)
+from PIL import Image
+from io import BytesIO
+img = Image.open(BytesIO(img_bytes))
+img.show()
 ```
 
 ## Specify Image Dimensions and Scale
 In addition to the image format, the `to_image` and `write_image` functions provide arguments to specify the image `width` and `height` in logical pixels. They also provide a `scale` parameter that can be used to increase (`scale` > 1) or decrease (`scale` < 1) the physical resolution of the resulting image.
 
 ```python
 img_bytes = fig.to_image(format="png", width=600, height=350, scale=2)
-Image(img_bytes)
+img = Image.open(BytesIO(img_bytes))
+img.show()
 ```
 
 ## Specify Image Export Engine