backend_payload.py
23 lines
| 669 B
| text/x-python
|
PythonLexer
epatters
|
r2756 | """ Provides basic funtionality for payload backends. | ||
""" | ||||
# Local imports. | ||||
Brian Granger
|
r2814 | from IPython.core.interactiveshell import InteractiveShell | ||
epatters
|
r2756 | |||
def add_plot_payload(format, data, metadata={}): | ||||
""" Add a plot payload to the current execution reply. | ||||
Parameters: | ||||
----------- | ||||
format : str | ||||
Identifies the format of the plot data. | ||||
data : str | ||||
The raw plot data. | ||||
metadata : dict, optional [default empty] | ||||
Allows for specification of additional information about the plot data. | ||||
""" | ||||
Brian Granger
|
r2814 | payload = dict(type='plot', format=format, data=data, metadata=metadata) | ||
InteractiveShell.instance().payload_manager.write_payload(payload) | ||||