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

Remove EventManager reset methods, because they violate encapsulation....

Remove EventManager reset methods, because they violate encapsulation. The whole idea of the EventManager is that you can register hooks without worrying about what hooks other pieces of code might be registering. The reset methods violate this separation of concerns, since they will blow away everyone else's hooks too. (See gh-6680 for an example of this breaking things.) Since there is never any safe way to use them, we simply remove them entirely.

Paul Ivanov - - Load All Authors

File last commit:

r12222:1ec6f582


                r18547:4043b271

Download file

             base.py
        
                    56 lines
            
             | 1.7 KiB
            
                | text/x-python
            
             |
                PythonLexer
            
             / IPython / nbconvert / writers / base.py
          
                    History
                
                 |
                  Annotation
                 | Raw
                 |Copy content
                 |Copy permalink

      """

      Contains writer base 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.utils.traitlets import List

      from ..utils.base import NbConvertBase

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

      # Classes

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

      class WriterBase(NbConvertBase):

          """Consumes output from nbconvert export...() methods and writes to a

          useful location. """

          files = List([], config=True, help="""

              List of the files that the notebook references.  Files will be 

              included with written output.""")

          def __init__(self, config=None, **kw):

              """

              Constructor

              """

              super(WriterBase, self).__init__(config=config, **kw)

          def write(self, output, resources, **kw):

              """

              Consume and write Jinja output.

              Parameters

              ----------

              output : string

                  Conversion results.  This string contains the file contents of the

                  converted file.

              resources : dict

                  Resources created and filled by the nbconvert conversion process.

                  Includes output from preprocessors, such as the extract figure

                  preprocessor.

              """

              raise NotImplementedError()

	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

				"""
				Contains writer base 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.utils.traitlets import List

				from ..utils.base import NbConvertBase

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

				class WriterBase(NbConvertBase):
				"""Consumes output from nbconvert export...() methods and writes to a
				useful location. """


				files = List([], config=True, help="""
				List of the files that the notebook references. Files will be
				included with written output.""")


				def __init__(self, config=None, **kw):
				"""
				Constructor
				"""
				super(WriterBase, self).__init__(config=config, **kw)


				def write(self, output, resources, **kw):
				"""
				Consume and write Jinja output.

				Parameters
				----------
				output : string
				Conversion results. This string contains the file contents of the
				converted file.
				resources : dict
				Resources created and filled by the nbconvert conversion process.
				Includes output from preprocessors, such as the extract figure
				preprocessor.
				"""

				raise NotImplementedError()