##// END OF EJS Templates
tweak raw_input style...
tweak raw_input style more crowded, less jumpy

File last commit:

r7859:1eaf013b
r10376:641fc2f7
Show More
displaypub.py
309 lines | 9.5 KiB | text/x-python | PythonLexer
Brian Granger
Mostly final version of display data....
r3277 """An interface for publishing rich data to frontends.
Brian Granger
Initial version of DisplayPublisher is working....
r3276
Brian Granger
Display system is fully working now....
r3278 There are two components of the display system:
* Display formatters, which take a Python object and compute the
representation of the object in various formats (text, HTML, SVg, etc.).
* The display publisher that is used to send the representation data to the
various frontends.
This module defines the logic display publishing. The display publisher uses
the ``display_data`` message type that is defined in the IPython messaging
spec.
Brian Granger
Initial version of DisplayPublisher is working....
r3276 Authors:
* Brian Granger
"""
#-----------------------------------------------------------------------------
Matthias BUSSONNIER
update copyright to 2011/20xx-2011...
r5390 # Copyright (C) 2008-2011 The IPython Development Team
Brian Granger
Initial version of DisplayPublisher is working....
r3276 #
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
Brian Granger
Addressing review comments....
r3286 from __future__ import print_function
Brian Granger
Initial version of DisplayPublisher is working....
r3276 from IPython.config.configurable import Configurable
MinRK
clear_output implies '\r' for terminal frontends
r6422 from IPython.utils import io
Brian Granger
Initial version of DisplayPublisher is working....
r3276
#-----------------------------------------------------------------------------
# Main payload class
#-----------------------------------------------------------------------------
class DisplayPublisher(Configurable):
Brian Granger
Display system is fully working now....
r3278 """A traited class that publishes display data to frontends.
Instances of this class are created by the main IPython object and should
be accessed there.
"""
Brian Granger
Initial version of DisplayPublisher is working....
r3276
def _validate_data(self, source, data, metadata=None):
Brian Granger
Display system is fully working now....
r3278 """Validate the display data.
Parameters
----------
source : str
The fully dotted name of the callable that created the data, like
:func:`foo.bar.my_formatter`.
data : dict
The formata data dictionary.
metadata : dict
Any metadata for the data.
"""
Brian E. Granger
Fixing two minor things for review....
r4577 if not isinstance(source, basestring):
Brian Granger
Initial version of DisplayPublisher is working....
r3276 raise TypeError('source must be a str, got: %r' % source)
if not isinstance(data, dict):
raise TypeError('data must be a dict, got: %r' % data)
if metadata is not None:
if not isinstance(metadata, dict):
raise TypeError('metadata must be a dict, got: %r' % data)
def publish(self, source, data, metadata=None):
Brian Granger
Mostly final version of display data....
r3277 """Publish data and metadata to all frontends.
Brian Granger
Initial version of DisplayPublisher is working....
r3276
Brian Granger
Mostly final version of display data....
r3277 See the ``display_data`` message in the messaging documentation for
more details about this message type.
Brian Granger
Display system is fully working now....
r3278 The following MIME types are currently implemented:
* text/plain
* text/html
* text/latex
* application/json
Brian E. Granger
Updates to the display system....
r4526 * application/javascript
Brian Granger
Display system is fully working now....
r3278 * image/png
Brian E. Granger
Finishing display system work....
r4528 * image/jpeg
Brian E. Granger
Updates to the display system....
r4526 * image/svg+xml
Brian Granger
Display system is fully working now....
r3278
Brian Granger
Mostly final version of display data....
r3277 Parameters
----------
source : str
A string that give the function or method that created the data,
such as 'IPython.core.page'.
data : dict
Bernardo B. Marques
remove all trailling spaces
r4872 A dictionary having keys that are valid MIME types (like
Brian Granger
Mostly final version of display data....
r3277 'text/plain' or 'image/svg+xml') and values that are the data for
that MIME type. The data itself must be a JSON'able data
structure. Minimally all data should have the 'text/plain' data,
which can be displayed by all frontends. If more than the plain
text is given, it is up to the frontend to decide which
representation to use.
metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
MinRK
clear_output implies '\r' for terminal frontends
r6422
MinRK
io.Term.cin/out/err replaced by io.stdin/out/err...
r3800 # The default is to simply write the plain text data using io.stdout.
Bradley M. Froehle
2to3: Apply has_key fixer.
r7859 if 'text/plain' in data:
MinRK
io.Term.cin/out/err replaced by io.stdin/out/err...
r3800 print(data['text/plain'], file=io.stdout)
Brian Granger
Mostly final version of display data....
r3277
MinRK
clear_output implies '\r' for terminal frontends
r6422 def clear_output(self, stdout=True, stderr=True, other=True):
"""Clear the output of the cell receiving output."""
if stdout:
print('\033[2K\r', file=io.stdout, end='')
io.stdout.flush()
if stderr:
print('\033[2K\r', file=io.stderr, end='')
io.stderr.flush()
Brian Granger
Adding clear_output to kernel and HTML notebook.
r5080
Brian Granger
Mostly final version of display data....
r3277
Brian E. Granger
Updates to the display system....
r4526 def publish_display_data(source, data, metadata=None):
Brian Granger
Display system is fully working now....
r3278 """Publish data and metadata to all frontends.
Brian Granger
Mostly final version of display data....
r3277
Brian Granger
Display system is fully working now....
r3278 See the ``display_data`` message in the messaging documentation for
more details about this message type.
Brian Granger
Mostly final version of display data....
r3277
Brian Granger
Display system is fully working now....
r3278 The following MIME types are currently implemented:
Brian Granger
Mostly final version of display data....
r3277
Brian Granger
Display system is fully working now....
r3278 * text/plain
* text/html
* text/latex
* application/json
Brian E. Granger
Updates to the display system....
r4526 * application/javascript
Brian Granger
Display system is fully working now....
r3278 * image/png
Brian E. Granger
Finishing display system work....
r4528 * image/jpeg
Brian E. Granger
Updates to the display system....
r4526 * image/svg+xml
Brian Granger
Mostly final version of display data....
r3277
Brian Granger
Display system is fully working now....
r3278 Parameters
----------
source : str
A string that give the function or method that created the data,
such as 'IPython.core.page'.
data : dict
Bernardo B. Marques
remove all trailling spaces
r4872 A dictionary having keys that are valid MIME types (like
Brian Granger
Display system is fully working now....
r3278 'text/plain' or 'image/svg+xml') and values that are the data for
that MIME type. The data itself must be a JSON'able data
structure. Minimally all data should have the 'text/plain' data,
which can be displayed by all frontends. If more than the plain
text is given, it is up to the frontend to decide which
representation to use.
metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
Brian Granger
Mostly final version of display data....
r3277 """
from IPython.core.interactiveshell import InteractiveShell
InteractiveShell.instance().display_pub.publish(
source,
Brian Granger
Display system is fully working now....
r3278 data,
Brian Granger
Mostly final version of display data....
r3277 metadata
)
Brian Granger
Display system is fully working now....
r3278
Brian E. Granger
Updates to the display system....
r4526
def publish_pretty(data, metadata=None):
"""Publish raw text data to all frontends.
Parameters
----------
data : unicode
The raw text data to publish.
metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_pretty',
{'text/plain':data},
metadata=metadata
)
def publish_html(data, metadata=None):
Brian E. Granger
Finishing display system work....
r4528 """Publish raw HTML data to all frontends.
Brian E. Granger
Updates to the display system....
r4526
Parameters
----------
data : unicode
Brian E. Granger
Finishing display system work....
r4528 The raw HTML data to publish.
Brian E. Granger
Updates to the display system....
r4526 metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_html',
{'text/html':data},
metadata=metadata
)
def publish_latex(data, metadata=None):
Brian E. Granger
Finishing display system work....
r4528 """Publish raw LaTeX data to all frontends.
Brian E. Granger
Updates to the display system....
r4526
Parameters
----------
data : unicode
Brian E. Granger
Finishing display system work....
r4528 The raw LaTeX data to publish.
Brian E. Granger
Updates to the display system....
r4526 metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_latex',
{'text/latex':data},
metadata=metadata
)
def publish_png(data, metadata=None):
Brian E. Granger
Finishing display system work....
r4528 """Publish raw binary PNG data to all frontends.
Brian E. Granger
Updates to the display system....
r4526
Parameters
----------
data : str/bytes
Brian E. Granger
Finishing display system work....
r4528 The raw binary PNG data to publish.
Brian E. Granger
Updates to the display system....
r4526 metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_png',
{'image/png':data},
metadata=metadata
)
Brian E. Granger
Finishing display system work....
r4528
def publish_jpeg(data, metadata=None):
"""Publish raw binary JPEG data to all frontends.
Parameters
----------
data : str/bytes
The raw binary JPEG data to publish.
metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_jpeg',
{'image/jpeg':data},
metadata=metadata
)
Brian E. Granger
Updates to the display system....
r4526 def publish_svg(data, metadata=None):
Brian E. Granger
Finishing display system work....
r4528 """Publish raw SVG data to all frontends.
Brian E. Granger
Updates to the display system....
r4526
Parameters
----------
data : unicode
Brian E. Granger
Finishing display system work....
r4528 The raw SVG data to publish.
Brian E. Granger
Updates to the display system....
r4526 metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_svg',
{'image/svg+xml':data},
metadata=metadata
)
def publish_json(data, metadata=None):
Brian E. Granger
Finishing display system work....
r4528 """Publish raw JSON data to all frontends.
Brian E. Granger
Updates to the display system....
r4526
Parameters
----------
data : unicode
Brian E. Granger
Finishing display system work....
r4528 The raw JSON data to publish.
Brian E. Granger
Updates to the display system....
r4526 metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_json',
{'application/json':data},
metadata=metadata
)
def publish_javascript(data, metadata=None):
Brian E. Granger
Finishing display system work....
r4528 """Publish raw Javascript data to all frontends.
Brian E. Granger
Updates to the display system....
r4526
Parameters
----------
data : unicode
Brian E. Granger
Finishing display system work....
r4528 The raw Javascript data to publish.
Brian E. Granger
Updates to the display system....
r4526 metadata : dict
A dictionary for metadata related to the data. This can contain
arbitrary key, value pairs that frontends can use to interpret
the data.
"""
publish_display_data(
u'IPython.core.displaypub.publish_javascript',
{'application/javascript':data},
metadata=metadata
)