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

Complete support of git commit info with IPython.sys_info()....

Complete support of git commit info with IPython.sys_info(). This will give us an easy way for users to report platform details, without trying to cram lots of data into the version string. Now, the version information in release.py is simple and doesn't attempt to read version control data at runtime. We expose sys_info() as a top-level function so it's very easy to remember/direct for new users. Minor doc/copyright notices updates in the same files.

Brian Granger - - Load All Authors

File last commit:

r2827:34964c21


                r3204:45904cee

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)