upstream/ipython Commit - r3880:e7df0ac1

Misc updates the display system....

Brian Granger -

r3880:e7df0ac1

parent child

IPython/core/formatters.py

0 +18 -1

                 objects, define a :meth:`_repr_html_` method or use the :meth:`for_type`
                 or :meth:`for_type_by_name` methods to register functions that handle
                 this.
+                The return value of this formatter should be a valid HTML snippet that
+                could be injected into an existing DOM. It should *not* include the
+                ```<html>`` or ```<body>`` tags.
                 """
                 format_type = Str('text/html')
                 objects, define a :meth:`_repr_svg_` method or use the :meth:`for_type`
                 or :meth:`for_type_by_name` methods to register functions that handle
                 this.
+                The return value of this formatter should be valid SVG enclosed in
+                ```<svg>``` tags, that could be injected into an existing DOM. It should
+                *not* include the ```<html>`` or ```<body>`` tags.
                 """
                 format_type = Str('image/svg+xml')
                 or :meth:`for_type_by_name` methods to register functions that handle
                 this.
-                The raw data should be the base64 encoded raw png data.
+                The return value of this formatter should be raw PNG data, *not*
+                base64 encoded.
                 """
                 format_type = Str('image/png')
                 objects, define a :meth:`_repr_latex_` method or use the :meth:`for_type`
                 or :meth:`for_type_by_name` methods to register functions that handle
                 this.
+                The return value of this formatter should be a valid LaTeX equation,
+                enclosed in either ```$``` or ```$$```.
                 """
                 format_type = Str('text/latex')
                 your objects, define a :meth:`_repr_json_` method or use the :meth:`for_type`
                 or :meth:`for_type_by_name` methods to register functions that handle
                 this.
+                The return value of this formatter should be a valid JSON string.
                 """
                 format_type = Str('application/json')
                 your objects, define a :meth:`_repr_javascript_` method or use the
                 :meth:`for_type` or :meth:`for_type_by_name` methods to register functions
                 that handle this.
+                The return value of this formatter should be valid Javascript code and
+                should *not* be enclosed in ```<script>``` tags.
                 """
                 format_type = Str('application/javascript')

IPython/extensions/sympyprinting.py ~~IPython/extensions/sympy_printing.py~~

0 renamed +1 -1

                 # them with suitable subs.
                 s = s.replace('\\operatorname','')
                 s = s.replace('\\overline', '\\bar')
-                png = latex_to_png(s, encode=True)
+                png = latex_to_png(s)
                 return png
             _loaded = False

IPython/lib/latextools.py

0 +1 -1

             #-----------------------------------------------------------------------------
-            def latex_to_png(s, encode=True):
+            def latex_to_png(s, encode=False):
                 """Render a LaTeX string to PNG using matplotlib.mathtext.
                 Parameters

IPython/zmq/zmqshell.py

0 +4 0

             from __future__ import print_function
             # Stdlib
+            from base64 import encodestring
             import inspect
             import os
                         self.msg['content']['execution_count'] = self.prompt_count
                 def write_format_data(self, format_dict):
+                    pngdata = format_dict.get('image/png')
+                    if pngdata is not None:
+                        format_dict['image/png'] = encodestring(pngdata)
                     self.msg['content']['data'] = format_dict
                 def finish_displayhook(self):

docs/examples/core/display.py

0 +4 -1

             """Code that shows off the IPython display logic.
             """
+            from IPython.lib.latextools import latex_to_png
             from IPython.core.display import (
                 display, display_pretty, display_html,
-                display_svg, display_json
+                display_svg, display_json, display_png
             )
             class Circle(object):
             <circle cx="100" cy="50" r="40" stroke="black" stroke-width="2" fill="red"/>
             </svg>"""
+                def _repr_png_(self):
+                    return latex_to_png('$\circle$')

General Comments 0

Write
Preview

You need to be logged in to leave comments. Login now

No TODOs yet

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages