upstream/ipython Files · IPython/nbconvert/exporters/tests/base.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?

MinRK - - Load All Authors

File last commit:

r15439:37fe6ef6


                r19164:17ac8ca3

Download file

             base.py
        
                    54 lines
            
             | 2.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / tests / base.py
          
                    History
                
                 |
                  Source
                 | Raw
                 |Copy content
                 |Copy permalink

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
      """Base TestCase class for testing Exporters"""

        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

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

      import os

        MinRK
    
run html nbconvert tests if node or pandoc is available

              r15439
            
      from IPython.testing.decorators import onlyif_any_cmd_exists

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
        Jonathan Frederic
    
Added exporter tests

              r11480
            
      from ...tests.base import TestsBase

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

      # Class

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

        MinRK
    
propagate raw_mimetype to nbconvert

              r13678
            
      all_raw_mimetypes = {

        Thomas Kluyver
    
Condense raw_mimetype and mime_type traitlets into output_mimetype

              r13832
            
          'text/x-python',

        MinRK
    
propagate raw_mimetype to nbconvert

              r13678
            
          'text/markdown',

          'text/html',

          'text/restructuredtext',

          'text/latex',

      }

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
        Jonathan Frederic
    
Added exporter tests

              r11480
            
      class ExportersTestsBase(TestsBase):

          """Contains base test functions for exporters"""

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
          exporter_class = None

          should_include_raw = None

          def _get_notebook(self, nb_name='notebook2.ipynb'):

              return os.path.join(self._get_files_path(), nb_name)

        MinRK
    
run html nbconvert tests if node or pandoc is available

              r15439
            
          @onlyif_any_cmd_exists('nodejs', 'node', 'pandoc')

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
          def test_raw_cell_inclusion(self):

        MinRK
    
propagate raw_mimetype to nbconvert

              r13678
            
              """test raw cell inclusion based on raw_mimetype metadata"""

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
              if self.should_include_raw is None:

                  return

              exporter = self.exporter_class()

              (output, resources) = exporter.from_filename(self._get_notebook('rawtest.ipynb'))

              for inc in self.should_include_raw:

                  self.assertIn('raw %s' % inc, output, "should include %s" % inc)

        MinRK
    
propagate raw_mimetype to nbconvert

              r13678
            
              self.assertIn('no raw_mimetype metadata', output)

              for exc in all_raw_mimetypes.difference(self.should_include_raw):

        MinRK
    
test raw cell inclusion based on raw_format metadata

              r13665
            
                  self.assertNotIn('raw %s' % exc, output, "should exclude %s" % exc)

              self.assertNotIn('never be included', output)

	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

MinRK test raw cell inclusion based on raw_format metadata	r13665	"""Base TestCase class for testing Exporters"""
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
		#-----------------------------------------------------------------------------

		import os

MinRK run html nbconvert tests if node or pandoc is available	r15439	from IPython.testing.decorators import onlyif_any_cmd_exists
MinRK test raw cell inclusion based on raw_format metadata	r13665
Jonathan Frederic Added exporter tests	r11480	from ...tests.base import TestsBase

		#-----------------------------------------------------------------------------
		# Class
		#-----------------------------------------------------------------------------

MinRK propagate raw_mimetype to nbconvert	r13678	all_raw_mimetypes = {
Thomas Kluyver Condense raw_mimetype and mime_type traitlets into output_mimetype	r13832	'text/x-python',
MinRK propagate raw_mimetype to nbconvert	r13678	'text/markdown',
		'text/html',
		'text/restructuredtext',
		'text/latex',
		}
MinRK test raw cell inclusion based on raw_format metadata	r13665
Jonathan Frederic Added exporter tests	r11480	class ExportersTestsBase(TestsBase):
		"""Contains base test functions for exporters"""
MinRK test raw cell inclusion based on raw_format metadata	r13665
		exporter_class = None
		should_include_raw = None

		def _get_notebook(self, nb_name='notebook2.ipynb'):
		return os.path.join(self._get_files_path(), nb_name)

MinRK run html nbconvert tests if node or pandoc is available	r15439	@onlyif_any_cmd_exists('nodejs', 'node', 'pandoc')
MinRK test raw cell inclusion based on raw_format metadata	r13665	def test_raw_cell_inclusion(self):
MinRK propagate raw_mimetype to nbconvert	r13678	"""test raw cell inclusion based on raw_mimetype metadata"""
MinRK test raw cell inclusion based on raw_format metadata	r13665	if self.should_include_raw is None:
		return
		exporter = self.exporter_class()
		(output, resources) = exporter.from_filename(self._get_notebook('rawtest.ipynb'))
		for inc in self.should_include_raw:
		self.assertIn('raw %s' % inc, output, "should include %s" % inc)
MinRK propagate raw_mimetype to nbconvert	r13678	self.assertIn('no raw_mimetype metadata', output)
		for exc in all_raw_mimetypes.difference(self.should_include_raw):
MinRK test raw cell inclusion based on raw_format metadata	r13665	self.assertNotIn('raw %s' % exc, output, "should exclude %s" % exc)
		self.assertNotIn('never be included', output)