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

Min RK - - Load All Authors

File last commit:

r19276:24fd91f5


                r19727:974ebd4a

Download file

             script.py
        
                    33 lines
            
             | 1.3 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / exporters / script.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """Generic script exporter class for any kernel language"""

      # Copyright (c) IPython Development Team.

      # Distributed under the terms of the Modified BSD License.

      from .templateexporter import TemplateExporter

      from IPython.utils.traitlets import Dict

      class ScriptExporter(TemplateExporter):

          _exporters = Dict()

          def _template_file_default(self):

              return 'script'

          def from_notebook_node(self, nb, resources=None, **kw):

              langinfo = nb.metadata.get('language_info', {})

              # delegate to custom exporter, if specified

              exporter_name = langinfo.get('nbconvert_exporter')

              if exporter_name and exporter_name != 'script':

                  self.log.debug("Loading script exporter: %s", exporter_name)

                  from .export import exporter_map

                  if exporter_name not in self._exporters:

                      Exporter = exporter_map[exporter_name]

                      self._exporters[exporter_name] = Exporter(parent=self)

                  exporter = self._exporters[exporter_name]

                  return exporter.from_notebook_node(nb, resources, **kw)

              self.file_extension = langinfo.get('file_extension', '.txt')

              self.output_mimetype = langinfo.get('mimetype', 'text/plain')

              return super(ScriptExporter, self).from_notebook_node(nb, resources, **kw)

	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

				"""Generic script exporter class for any kernel language"""

				# Copyright (c) IPython Development Team.
				# Distributed under the terms of the Modified BSD License.

				from .templateexporter import TemplateExporter

				from IPython.utils.traitlets import Dict

				class ScriptExporter(TemplateExporter):

				_exporters = Dict()

				def _template_file_default(self):
				return 'script'

				def from_notebook_node(self, nb, resources=None, **kw):
				langinfo = nb.metadata.get('language_info', {})

				# delegate to custom exporter, if specified
				exporter_name = langinfo.get('nbconvert_exporter')
				if exporter_name and exporter_name != 'script':
				self.log.debug("Loading script exporter: %s", exporter_name)
				from .export import exporter_map
				if exporter_name not in self._exporters:
				Exporter = exporter_map[exporter_name]
				self._exporters[exporter_name] = Exporter(parent=self)
				exporter = self._exporters[exporter_name]
				return exporter.from_notebook_node(nb, resources, **kw)

				self.file_extension = langinfo.get('file_extension', '.txt')
				self.output_mimetype = langinfo.get('mimetype', 'text/plain')
				return super(ScriptExporter, self).from_notebook_node(nb, resources, **kw)