##// END OF EJS Templates
Intercept <esc> avoid closing websocket on Firefox...
Intercept <esc> avoid closing websocket on Firefox Closes #1031; closes #1032 (rebased and fixed tiny typo)

File last commit:

r5085:0a8f09f8
r5389:a329ff02
Show More
displaypub.py
302 lines | 9.3 KiB | text/x-python | PythonLexer
"""An interface for publishing rich data to frontends.
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.
Authors:
* Brian Granger
"""
#-----------------------------------------------------------------------------
# Copyright (C) 2008-2010 The IPython Development Team
#
# Distributed under the terms of the BSD License. The full license is in
# the file COPYING, distributed as part of this software.
#-----------------------------------------------------------------------------
#-----------------------------------------------------------------------------
# Imports
#-----------------------------------------------------------------------------
from __future__ import print_function
from IPython.config.configurable import Configurable
#-----------------------------------------------------------------------------
# Main payload class
#-----------------------------------------------------------------------------
class DisplayPublisher(Configurable):
"""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.
"""
def _validate_data(self, source, data, metadata=None):
"""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.
"""
if not isinstance(source, basestring):
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):
"""Publish data and metadata to all frontends.
See the ``display_data`` message in the messaging documentation for
more details about this message type.
The following MIME types are currently implemented:
* text/plain
* text/html
* text/latex
* application/json
* application/javascript
* image/png
* image/jpeg
* image/svg+xml
Parameters
----------
source : str
A string that give the function or method that created the data,
such as 'IPython.core.page'.
data : dict
A dictionary having keys that are valid MIME types (like
'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.
"""
from IPython.utils import io
# The default is to simply write the plain text data using io.stdout.
if data.has_key('text/plain'):
print(data['text/plain'], file=io.stdout)
def clear_output(self, stdout=True, stderr=True, other=True):
"""Clear the output of the cell receiving output."""
pass
def publish_display_data(source, data, metadata=None):
"""Publish data and metadata to all frontends.
See the ``display_data`` message in the messaging documentation for
more details about this message type.
The following MIME types are currently implemented:
* text/plain
* text/html
* text/latex
* application/json
* application/javascript
* image/png
* image/jpeg
* image/svg+xml
Parameters
----------
source : str
A string that give the function or method that created the data,
such as 'IPython.core.page'.
data : dict
A dictionary having keys that are valid MIME types (like
'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.
"""
from IPython.core.interactiveshell import InteractiveShell
InteractiveShell.instance().display_pub.publish(
source,
data,
metadata
)
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):
"""Publish raw HTML data to all frontends.
Parameters
----------
data : unicode
The raw HTML 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_html',
{'text/html':data},
metadata=metadata
)
def publish_latex(data, metadata=None):
"""Publish raw LaTeX data to all frontends.
Parameters
----------
data : unicode
The raw LaTeX 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_latex',
{'text/latex':data},
metadata=metadata
)
def publish_png(data, metadata=None):
"""Publish raw binary PNG data to all frontends.
Parameters
----------
data : str/bytes
The raw binary PNG 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_png',
{'image/png':data},
metadata=metadata
)
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
)
def publish_svg(data, metadata=None):
"""Publish raw SVG data to all frontends.
Parameters
----------
data : unicode
The raw SVG 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_svg',
{'image/svg+xml':data},
metadata=metadata
)
def publish_json(data, metadata=None):
"""Publish raw JSON data to all frontends.
Parameters
----------
data : unicode
The raw JSON 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_json',
{'application/json':data},
metadata=metadata
)
def publish_javascript(data, metadata=None):
"""Publish raw Javascript data to all frontends.
Parameters
----------
data : unicode
The raw Javascript 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_javascript',
{'application/javascript':data},
metadata=metadata
)