upstream/ipython Files · IPython/zmq/pylab/backend_payload.py

Created JSON-safety utilities....

Created JSON-safety utilities. These will be useful to make it easy to create objects that are safe for encoding as JSON. Full test suite with 100% coverage included.

Brian Granger - - Load All Authors

File last commit:

r2827:34964c21


                r2947:5c6d229c

Download file

             backend_payload.py
        
                    26 lines
            
             | 740 B
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / zmq / pylab / backend_payload.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """ Provides basic funtionality for payload backends.

      """

      # Local imports.

      from IPython.core.interactiveshell import InteractiveShell

      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.

          """

          payload = dict(

              source='IPython.zmq.pylab.backend_payload.add_plot_payload', 

              format=format, data=data, metadata=metadata

          )

          InteractiveShell.instance().payload_manager.write_payload(payload)

	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

				""" Provides basic funtionality for payload backends.
				"""

				# Local imports.
				from IPython.core.interactiveshell import InteractiveShell


				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.
				"""
				payload = dict(
				source='IPython.zmq.pylab.backend_payload.add_plot_payload',
				format=format, data=data, metadata=metadata
				)
				InteractiveShell.instance().payload_manager.write_payload(payload)