tweak double-encode logic for image data

minrk · minrk · commit bc29c714d0d4 · 2013-03-25T21:29:27.000-07:00
instead of only b64-encoding for valid image data, b64-encode unless it is specifically detected as b64-encoded valid image data. This prevents garbage data from skipping the b64 step, and causing unicode errors. Closes #3081
diff --git a/IPython/utils/jsonutil.py b/IPython/utils/jsonutil.py
@@ -97,7 +97,9 @@ def date_default(obj):
 
 # constants for identifying png/jpeg data
 PNG = b'\x89PNG\r\n\x1a\n'
+PNG64 = encodebytes(PNG)
 JPEG = b'\xff\xd8'
+JPEG64 = encodebytes(JPEG)
 
 def encode_images(format_dict):
     """b64-encodes images in a displaypub format dict
@@ -120,12 +122,21 @@ def encode_images(format_dict):
 
     """
     encoded = format_dict.copy()
+
     pngdata = format_dict.get('image/png')
-    if isinstance(pngdata, bytes) and pngdata[:8] == PNG:
-        encoded['image/png'] = encodebytes(pngdata).decode('ascii')
+    if isinstance(pngdata, bytes):
+        # make sure we don't double-encode
+        if pngdata[:13] != PNG64:
+            pngdata = encodebytes(pngdata)
+        encoded['image/png'] = pngdata.decode('ascii')
+
     jpegdata = format_dict.get('image/jpeg')
-    if isinstance(jpegdata, bytes) and jpegdata[:2] == JPEG:
-        encoded['image/jpeg'] = encodebytes(jpegdata).decode('ascii')
+    if isinstance(jpegdata, bytes):
+        # make sure we don't double-encode
+        if jpegdata[:5] != JPEG64:
+            jpegdata = encodebytes(jpegdata)
+        encoded['image/jpeg'] = jpegdata.decode('ascii')
+
     return encoded
 
 
