upstream/ipython Files · IPython/nbconvert/exporters/rst.py

DEV: Refactor checkpoint logic from FileContentsManager....

DEV: Refactor checkpoint logic from FileContentsManager. - Add a `CheckpointManager` base class and infrastructure for creating a `checkpoint_manager` instance attribute on `ContentsManager`. - Provide default implementations of `delete` and `rename` in the base `ContentsManager` class. `ContentsManager` subclasses are now required to implement `delete_file` and `rename_file`. These methods no longer need to manage checkpoints. - Move checkpoint-related functionality from `FileContentsManager` to a dedicated `FileCheckpointManager` subclass. - Move shared filesystem interaction logic into `FileManagerMixin` used by both `FileContentsManager` and `FileCheckpointManager`. - Minor tweaks to ContentsManager tests to get methods from the right object. The purpose of this change is to provide an API for users to replace just the checkpoint logic associated with a particular `ContentsManager`. In particular, this change makes it possible to easily support remote storage of checkpoints while otherwise retaining normal filesystem interactions.

Thomas Kluyver - - Load All Authors

File last commit:

r19027:034353ef


                r19727:974ebd4a

Download file

             rst.py
        
                    40 lines
            
             | 1.2 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / rst.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """restructuredText Exporter class"""

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

      # 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

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

      from IPython.config import Config

      from .templateexporter import TemplateExporter

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

      # Classes

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

      class RSTExporter(TemplateExporter):

          """

          Exports restructured text documents.

          """

          def _file_extension_default(self):

              return '.rst'

          def _template_file_default(self):

              return 'rst'

          output_mimetype = 'text/restructuredtext'

          @property

          def default_config(self):

              c = Config({'ExtractOutputPreprocessor':{'enabled':True}})

              c.merge(super(RSTExporter,self).default_config)

              return c

	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

				"""restructuredText Exporter class"""

				#-----------------------------------------------------------------------------
				# 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
				#-----------------------------------------------------------------------------

				from IPython.config import Config

				from .templateexporter import TemplateExporter

				#-----------------------------------------------------------------------------
				# Classes
				#-----------------------------------------------------------------------------

				class RSTExporter(TemplateExporter):
				"""
				Exports restructured text documents.
				"""

				def _file_extension_default(self):
				return '.rst'

				def _template_file_default(self):
				return 'rst'

				output_mimetype = 'text/restructuredtext'

				@property
				def default_config(self):
				c = Config({'ExtractOutputPreprocessor':{'enabled':True}})
				c.merge(super(RSTExporter,self).default_config)
				return c