Merge pull request #1643 from Carreau/jpegQtconsole

handle jpg/jpeg in the qtconsole

This allows the native display of jpeg image in the qtconsole.

IPython/frontend/qt/console/rich_ipython_widget.py

@@ -1,3 +1,11 b''
+#-----------------------------------------------------------------------------
+# Copyright (c) 2010, IPython Development Team.
+#
+# Distributed under the terms of the Modified BSD License.
+#
+# The full license is in the file COPYING.txt, distributed with this software.
+#-----------------------------------------------------------------------------
+
 # Standard libary imports.
 from base64 import decodestring
 import os
@@ -7,6 +15,7 b' import re'
 from IPython.external.qt import QtCore, QtGui
 
 # Local imports
+from IPython.utils.traitlets import Bool
 from IPython.frontend.qt.svg import save_svg, svg_to_clipboard, svg_to_image
 from ipython_widget import IPythonWidget
 
@@ -19,7 +28,7 b' class RichIPythonWidget(IPythonWidget):'
 
     # RichIPythonWidget protected class variables.
     _payload_source_plot = 'IPython.zmq.pylab.backend_payload.add_plot_payload'
-
+    _jpg_supported = Bool(False)
     #---------------------------------------------------------------------------
     # 'object' interface
     #---------------------------------------------------------------------------
@@ -36,6 +45,13 b' class RichIPythonWidget(IPythonWidget):'
         # Dictionary for resolving document resource names to SVG data.
         self._name_to_svg_map = {}
 
+        # Do we support jpg ?
+        # it seems that sometime jpg support is a plugin of QT, so try to assume
+        # it is not always supported.
+        _supported_format = map(str, QtGui.QImageReader.supportedImageFormats())
+        self._jpg_supported = 'jpeg' in _supported_format
+
+
     #---------------------------------------------------------------------------
     # 'ConsoleWidget' protected interface
     #---------------------------------------------------------------------------
@@ -65,6 +81,15 b' class RichIPythonWidget(IPythonWidget):'
     #---------------------------------------------------------------------------
     # 'BaseFrontendMixin' abstract interface
     #---------------------------------------------------------------------------
+    def _pre_image_append(self, msg, prompt_number):
+        """ Append the Out[] prompt  and make the output nicer
+
+        Shared code for some the following if statement
+        """
+        self.log.debug("pyout: %s", msg.get('content', ''))
+        self._append_plain_text(self.output_sep, True)
+        self._append_html(self._make_out_prompt(prompt_number), True)
+        self._append_plain_text('\n', True)
 
     def _handle_pyout(self, msg):
         """ Overridden to handle rich data types, like SVG.
@@ -74,19 +99,17 b' class RichIPythonWidget(IPythonWidget):'
             prompt_number = content['execution_count']
             data = content['data']
             if data.has_key('image/svg+xml'):
-                self.log.debug("pyout: %s", msg.get('content', ''))
-                self._append_plain_text(self.output_sep, True)
-                self._append_html(self._make_out_prompt(prompt_number), True)
+                self._pre_image_append(msg, prompt_number)
                 self._append_svg(data['image/svg+xml'], True)
                 self._append_html(self.output_sep2, True)
             elif data.has_key('image/png'):
-                self.log.debug("pyout: %s", msg.get('content', ''))
-                self._append_plain_text(self.output_sep, True)
-                self._append_html(self._make_out_prompt(prompt_number), True)
-                # This helps the output to look nice.
-                self._append_plain_text('\n', True)
+                self._pre_image_append(msg, prompt_number)
                 self._append_png(decodestring(data['image/png'].encode('ascii')), True)
                 self._append_html(self.output_sep2, True)
+            elif data.has_key('image/jpeg') and self._jpg_supported:
+                self._pre_image_append(msg, prompt_number)
+                self._append_jpg(decodestring(data['image/jpeg'].encode('ascii')), True)
+                self._append_html(self.output_sep2, True)
             else:
                 # Default back to the plain text representation.
                 return super(RichIPythonWidget, self)._handle_pyout(msg)
@@ -110,6 +133,10 b' class RichIPythonWidget(IPythonWidget):'
                 # in a JSON structure so we decode it.
                 png = decodestring(data['image/png'].encode('ascii'))
                 self._append_png(png, True)
+            elif data.has_key('image/jpeg') and self._jpg_supported:
+                self.log.debug("display: %s", msg.get('content', ''))
+                jpg = decodestring(data['image/jpeg'].encode('ascii'))
+                self._append_jpg(jpg, True)
             else:
                 # Default back to the plain text representation.
                 return super(RichIPythonWidget, self)._handle_display_data(msg)
@@ -118,6 +145,10 b' class RichIPythonWidget(IPythonWidget):'
     # 'RichIPythonWidget' protected interface
     #---------------------------------------------------------------------------
 
+    def _append_jpg(self, jpg, before_prompt=False):
+        """ Append raw JPG data to the widget."""
+        self._append_custom(self._insert_jpg, jpg, before_prompt)
+
     def _append_png(self, png, before_prompt=False):
         """ Append raw PNG data to the widget.
         """
@@ -168,10 +199,10 b' class RichIPythonWidget(IPythonWidget):'
             written (e.g., for linked images).  If None, all images are to be
             included inline.
 
-        format : "png"|"svg", optional [default "png"]
+        format : "png"|"svg"|"jpg", optional [default "png"]
             Format for returned or referenced images.
         """
-        if format == "png":
+        if format in ("png","jpg"):
             try:
                 image = self._get_image(match.group("name"))
             except KeyError:
@@ -181,20 +212,20 b' class RichIPythonWidget(IPythonWidget):'
                 if not os.path.exists(path):
                     os.mkdir(path)
                 relpath = os.path.basename(path)
-                if image.save("%s/qt_img%s.png" % (path,match.group("name")),
+                if image.save("%s/qt_img%s.%s" % (path, match.group("name"), format),
                               "PNG"):
-                    return '<img src="%s/qt_img%s.png">' % (relpath,
-                                                            match.group("name"))
+                    return '<img src="%s/qt_img%s.%s">' % (relpath,
+                                                            match.group("name"),format)
                 else:
                     return "<b>Couldn't save image!</b>"
             else:
                 ba = QtCore.QByteArray()
                 buffer_ = QtCore.QBuffer(ba)
                 buffer_.open(QtCore.QIODevice.WriteOnly)
-                image.save(buffer_, "PNG")
+                image.save(buffer_, format.upper())
                 buffer_.close()
-                return '<img src="data:image/png;base64,\n%s\n" />' % (
-                    re.sub(r'(.{60})',r'\1\n',str(ba.toBase64())))
+                return '<img src="data:image/%s;base64,\n%s\n" />' % (
+                    format,re.sub(r'(.{60})',r'\1\n',str(ba.toBase64())))
 
         elif format == "svg":
             try:
@@ -215,14 +246,22 b' class RichIPythonWidget(IPythonWidget):'
         else:
             return '<b>Unrecognized image format</b>'
 
+    def _insert_jpg(self, cursor, jpg):
+        """ Insert raw PNG data into the widget."""
+        self._insert_img(cursor, jpg, 'jpg')
+
     def _insert_png(self, cursor, png):
         """ Insert raw PNG data into the widget.
         """
+        self._insert_img(cursor, png, 'png')
+
+    def _insert_img(self, cursor, img, fmt):
+        """ insert a raw image, jpg or png """
         try:
             image = QtGui.QImage()
-            image.loadFromData(png, 'PNG')
+            image.loadFromData(img, fmt.upper())
         except ValueError:
-            self._insert_plain_text(cursor, 'Received invalid PNG data.')
+            self._insert_plain_text(cursor, 'Received invalid %s data.'%fmt)
         else:
             format = self._add_image(image)
             cursor.insertBlock()