upstream/ipython Files · IPython/nbconvert/exporters/tests/cheese.py

This feature was discussed in , but it doesn't look like anything was ever incorporated into the IPython Notebook....

This feature was discussed in , but it doesn't look like anything was ever incorporated into the IPython Notebook. Here's a brief overview of the changes: - Display of messages from other clients can be toggled on and off from within a notebook, either using the ``<M-m>e`` keyboard shortcut in the web UI, or through the option in the "Kernel" menu. - notebook.js controls whether messages are displayed through a callback that is invoked from kernel.js when no callbacks are available for a message. - The UI displays ``execute_input`` messages originating from an other clients in new cells at the end of the notebook. Output messages (``execute_result`` et al.) will only be displayed if a cell exists with a matching message ID. Pending design questions: - Should each ``execute_input`` message cause a new cell to be created? - Should new cells be placed at the end of the notebook, or elsewhere? If the latter, what criteria should be followed?

Paul Ivanov - - Load All Authors

File last commit:

r12219:60e06808


                r19164:17ac8ca3

Download file

             cheese.py
        
                    48 lines
            
             | 1.5 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / tests / cheese.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        Jonathan Frederic
    
Added exporter tests

              r11480
            
      """

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
      Contains CheesePreprocessor

        Jonathan Frederic
    
Added exporter tests

              r11480
            
      """

      #-----------------------------------------------------------------------------

      # Copyright (c) 2013, the IPython Development Team.

      #

      # Distributed under the terms of the Modified BSD License.

      #

      # The full license is in the file COPYING.txt, distributed with this software.

      #-----------------------------------------------------------------------------

      #-----------------------------------------------------------------------------

      # Imports

      #-----------------------------------------------------------------------------

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
      from ...preprocessors.base import Preprocessor

        Jonathan Frederic
    
Added exporter tests

              r11480
            
      #-----------------------------------------------------------------------------

      # Classes

      #-----------------------------------------------------------------------------

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
      class CheesePreprocessor(Preprocessor):

        Jonathan Frederic
    
Added exporter tests

              r11480
            
          """

          Adds a cheese tag to the resources object

          """

          def __init__(self, **kw):

              """

              Public constructor

              """

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
              super(CheesePreprocessor, self).__init__(**kw)

        Jonathan Frederic
    
Added exporter tests

              r11480
            
        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
          def preprocess(self, nb, resources):

        Jonathan Frederic
    
Added exporter tests

              r11480
            
              """

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
              Sphinx preprocessing to apply on each notebook.

        Jonathan Frederic
    
Added exporter tests

              r11480
            
              Parameters

              ----------

              nb : NotebookNode

                  Notebook being converted

              resources : dictionary

                  Additional resources used in the conversion process.  Allows

        Paul Ivanov
    
replace 'transformer' with 'preprocessor'

              r12219
            
                  preprocessors to pass variables into the Jinja engine.

        Jonathan Frederic
    
Added exporter tests

              r11480
            
              """

              resources['cheese'] = 'real'

              return nb, resources

	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

Jonathan Frederic Added exporter tests	r11480	"""
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	Contains CheesePreprocessor
Jonathan Frederic Added exporter tests	r11480	"""
		#-----------------------------------------------------------------------------
		# Copyright (c) 2013, the IPython Development Team.
		#
		# Distributed under the terms of the Modified BSD License.
		#
		# The full license is in the file COPYING.txt, distributed with this software.
		#-----------------------------------------------------------------------------

		#-----------------------------------------------------------------------------
		# Imports
		#-----------------------------------------------------------------------------

Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	from ...preprocessors.base import Preprocessor
Jonathan Frederic Added exporter tests	r11480
		#-----------------------------------------------------------------------------
		# Classes
		#-----------------------------------------------------------------------------

Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	class CheesePreprocessor(Preprocessor):
Jonathan Frederic Added exporter tests	r11480	"""
		Adds a cheese tag to the resources object
		"""


		def __init__(self, **kw):
		"""
		Public constructor
		"""
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	super(CheesePreprocessor, self).__init__(**kw)
Jonathan Frederic Added exporter tests	r11480

Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	def preprocess(self, nb, resources):
Jonathan Frederic Added exporter tests	r11480	"""
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	Sphinx preprocessing to apply on each notebook.
Jonathan Frederic Added exporter tests	r11480
		Parameters
		----------
		nb : NotebookNode
		Notebook being converted
		resources : dictionary
		Additional resources used in the conversion process. Allows
Paul Ivanov replace 'transformer' with 'preprocessor'	r12219	preprocessors to pass variables into the Jinja engine.
Jonathan Frederic Added exporter tests	r11480	"""
		resources['cheese'] = 'real'
		return nb, resources