upstream/ipython Files · IPython/nbconvert/postprocessors/base.py

Add comments emphasizing the order of steps in widget box remove() methods

Jake Vanderplas - - Load All Authors

File last commit:

r12249:4563b2ee


                r19066:657658b9

Download file

             base.py
        
                    35 lines
            
             | 1.0 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / postprocessors / base.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Basic post processor

      """

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

      #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 ..utils.base import NbConvertBase

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

      # Classes

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

      class PostProcessorBase(NbConvertBase):

          def __call__(self, input):

              """

              See def postprocess() ...

              """

              self.postprocess(input)

          def postprocess(self, input):

              """

              Post-process output from a writer.

              """

              raise NotImplementedError('postprocess')

	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

				"""
				Basic post processor
				"""
				#-----------------------------------------------------------------------------
				#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 ..utils.base import NbConvertBase


				#-----------------------------------------------------------------------------
				# Classes
				#-----------------------------------------------------------------------------
				class PostProcessorBase(NbConvertBase):

				def __call__(self, input):
				"""
				See def postprocess() ...
				"""
				self.postprocess(input)


				def postprocess(self, input):
				"""
				Post-process output from a writer.
				"""
				raise NotImplementedError('postprocess')