More clean-up. Nomenclature changes

nbconvert/api/base.py

@@ -1,266 +1,274 b''
 """Exporter for the notebook conversion pipeline.
 
 This module defines Exporter, a highly configurable converter
 that uses Jinja2 to export notebook files into different format.
 
 You can register both pre-transformers that will act on the notebook format
 befor conversion and jinja filter that would then be availlable in the templates
 """
 
 #-----------------------------------------------------------------------------
 # 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 __future__ import print_function, absolute_import
 
 # Stdlib imports
 import io
 import os
 
 # IPython imports
 from IPython.config.configurable import Configurable
 from IPython.nbformat import current as nbformat
 from IPython.utils.traitlets import MetaHasTraits, Unicode, List, Bool
 from IPython.utils.text import indent
 
 # other libs/dependencies
 from jinja2 import Environment, FileSystemLoader
 from markdown import markdown
 
 # local import
 import filters.strings
 import filters.markdown
 import filters.latex
 import filters.datatypefilter
 import filters.pygments
 import filters.ansi
 
 import transformers.extractfigure
 import transformers.csshtmlheader
 import transformers.revealhelp
 import transformers.coalescestreams
 
 
 #-----------------------------------------------------------------------------
 # Globals and constants
 #-----------------------------------------------------------------------------
 
 #Standard Jinja2 environment constants
 TEMPLATE_PATH = "/../templates/"
 TEMPLATE_SKELETON_PATH = "/../templates/skeleton/"
 TEMPLATE_EXTENSION = ".tpl"
 
 #Jinja2 extensions to load.
 JINJA_EXTENSIONS = ['jinja2.ext.loopcontrols']
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 class Exporter(Configurable):
     """ A Jinja2 base converter templates
 
     Pre-process the IPYNB files, feed it through Jinja2 templates,
     and spit an converted files and a data object with other data
     should be mostly configurable
     """
 
     pre_transformer_order = List(['haspyout_transformer'],
         config=True,
         help= """
             An ordered list of pre-transformer to apply to the IPYNB
             file before running through templates
             """
         )
 
     template_file = Unicode(
             '', config=True,
             help="Name of the template file to use")
 
     fileext = Unicode(
         'txt', config=True, 
         help="Extension of the file that should be written to disk"
         )
 
     stdout = Bool(
         True, config=True,
         help="""Whether to print the converted IPYNB file to stdout
         "use full do diff files without actually writing a new file"""
         )
 
     write = Bool(
         False, config=True,
         help="""Should the converted notebook file be written to disk
         along with potential extracted resources."""
         )
 
     #Processors that process the input data prior to the export, set in the 
     #constructor for this class.
     preprocessors = [] 
 
-    def __init__(self, preprocessors={}, jinja_filters={}, config=None, export_format, **kw):
+    def __init__(self, preprocessors=None, jinja_filters=None, config=None, export_format, **kw):
         """ Init a new converter.
 
         config: the Configurable config object to pass around.
 
         preprocessors: dict of **availlable** key/value function to run on
                        ipynb json data before conversion to extract/inline file.
                        See `transformer.py` and `ConfigurableTransformers`
 
                        set the order in which the transformers should apply
                        with the `pre_transformer_order` trait of this class
 
                        transformers registerd by this key will take precedence on
                        default one.
 
         jinja_filters: dict of supplementary jinja filter that should be made
                        availlable in template. If those are of Configurable Class type,
                        they will be instanciated with the config object as argument.
 
                        user defined filter will overwrite the one availlable by default.
         """
 
         #Set the default options for the exporter.
         default_config = self.config
             
         #Set properties that must be set in the config class in order to 
         #propagate to other classes.
         default_config.GlobalConfigurable.display_data_priority =['svg', 'png', 'latex', 'jpg', 'jpeg','text']
         default_config.ExtractFigureTransformer.display_data_priority=['svg', 'png', 'latex', 'jpg', 'jpeg','text']
 
         #Set default properties of the exporter.
         #For most (or all cases), the template file name matches the format name.
         self.display_data_priority= ['svg', 'png', 'latex', 'jpg', 'jpeg','text']
         self.template_file = export_format
 
         if not config == None:
             default_config._merge(config)
         config = default_config    
     
         #Call the base class constructor
         super(Exporter, self).__init__(config=config, **kw)
 
         #Standard environment
         self.ext = TEMPLATE_EXTENSION
         self._init_environment()
 
-        #TODO: Implement reflection style methods to get user transformers.        
-        #for name in self.pre_transformer_order:
-        #    # get the user-defined transformer first
-        #    transformer = preprocessors.get(name, getattr(trans, name, None))
-        #    if isinstance(transformer, MetaHasTraits):
-        #        transformer = transformer(config=config)
-        #    self.preprocessors.append(transformer)
+        #TODO: Implement reflection style methods to get user transformers.
+        #if not preprocessors is None:        
+        #    for name in self.pre_transformer_order:
+        #        # get the user-defined transformer first
+        #        transformer = preprocessors.get(name, getattr(trans, name, None))
+        #        if isinstance(transformer, MetaHasTraits):
+        #            transformer = transformer(config=config)
+        #        self.preprocessors.append(transformer)
 
         #For compatibility, TODO: remove later.
         self.preprocessors.append(transformers.coalescestreams.coalesce_streams)
         self.preprocessors.append(transformers.extractfigure.ExtractFigureTransformer(config=config))
         self.preprocessors.append(transformers.revealhelp.RevealHelpTransformer(config=config))
         self.preprocessors.append(transformers.csshtmlheader.CSSHtmlHeaderTransformer(config=config))
 
         #Add filters to the Jinja2 environment
-        self._register_filters(config)
+        self._register_filters()
 
         #Load user filters.  Overwrite existing filters if need be.
-        for key, user_filter in jinja_filters.iteritems():
-            if isinstance(user_filter, MetaHasTraits):
-                self.env.filters[key] = user_filter(config=config)
-            else:
-                self.env.filters[key] = user_filter
+        if not jinja_filters is None:
+            for key, user_filter in jinja_filters.iteritems():
+                if isinstance(user_filter, MetaHasTraits):
+                    self.env.filters[key] = user_filter(config=config)
+                else:
+                    self.env.filters[key] = user_filter
 
         #Load the template file.
         self.template = self.env.get_template(self.template_file+self.ext)
 
 
-    def export(self, nb):
-        """Export notebook object
+    def from_notebook_node(self, nb):
+        """Export NotebookNode instance
 
-        nb: Notebook object to export.
+        nb: NotebookNode to export.
 
         Returns both the converted ipynb file and a dict containing the
         resources created along the way via the transformers and Jinja2
         processing.
         """
 
         nb, resources = self._preprocess(nb)
         return self.template.render(nb=nb, resources=resources), resources
 
 
     def from_filename(self, filename):
         """Read and export a notebook from a filename
 
         filename: Filename of the notebook file to export.
 
         Returns both the converted ipynb file and a dict containing the
         resources created along the way via the transformers and Jinja2
         processing.
         """
         with io.open(filename) as f:
-            return self.export(nbformat.read(f, 'json'))
+            return self.from_notebook_node(nbformat.read(f, 'json'))
 
 
     def from_file(self, file_stream):
-        """Read and export a notebook from a filename
+        """Read and export a notebook from a file stream
 
         file_stream: File handle of file that contains notebook data.
 
         Returns both the converted ipynb file and a dict containing the
         resources created along the way via the transformers and Jinja2
         processing.
         """
 
-        return self.export(nbformat.read(file_stream, 'json'))
-
+        return self.from_notebook_node(nbformat.read(file_stream, 'json'))
+
+
+    def register_filter(self, name, filter):
+        if MetaHasTraits(filter):
+            self.env.filters[name] = filter(config=self.config)
+        else:
+            self.env.filters[name] = filter
+
+
+    def _register_filters(self):
+        self.register_filter('indent', indent)
+        self.register_filter('markdown', markdown)
+        self.register_filter('ansi2html', filters.ansi.ansi2html)
+        self.register_filter('filter_data_type', filters.datatypefilter.DataTypeFilter)
+        self.register_filter('get_lines', filters.strings.get_lines)
+        self.register_filter('highlight', filters.pygments.highlight)
+        self.register_filter('highlight2html', filters.pygments.highlight) 
+        self.register_filter('highlight2latex', filters.pygments.highlight2latex)
+        self.register_filter('markdown2latex', filters.markdown.markdown2latex)
+        self.register_filter('markdown2rst', filters.markdown.markdown2rst)
+        self.register_filter('pycomment', filters.strings.python_comment)
+        self.register_filter('rm_ansi', filters.ansi.remove_ansi)
+        self.register_filter('rm_dollars', filters.strings.strip_dollars)
+        self.register_filter('rm_fake', filters.strings.rm_fake)
+        self.register_filter('rm_math_space', filters.latex.rm_math_space)
+        self.register_filter('wrap', filters.strings.wrap)
 
+        
     def _init_environment(self):
         self.env = Environment(
             loader=FileSystemLoader([
                 os.path.dirname(os.path.realpath(__file__)) + TEMPLATE_PATH,
                 os.path.dirname(os.path.realpath(__file__)) + TEMPLATE_SKELETON_PATH,
                 ]),
             extensions=JINJA_EXTENSIONS
             )
 
 
-    def _register_filters(self, config):
-        self.env.filters['indent'] = indent
-        self.env.filters['markdown'] = markdown
-        
-        self.env.filters['ansi2html'] = filters.ansi.ansi2html
-        self.env.filters['filter_data_type'] = filters.datatypefilter.DataTypeFilter(config=config)
-        self.env.filters['get_lines'] = filters.strings.get_lines 
-        self.env.filters['highlight'] = filters.pygments.highlight
-        self.env.filters['highlight2html'] = filters.pygments.highlight 
-        self.env.filters['highlight2latex'] = filters.pygments.highlight2latex
-        self.env.filters['markdown2latex'] = filters.markdown.markdown2latex
-        self.env.filters['markdown2rst'] = filters.markdown.markdown2rst
-        self.env.filters['pycomment'] = filters.strings.python_comment
-        self.env.filters['rm_ansi'] = filters.ansi.remove_ansi
-        self.env.filters['rm_dollars'] = filters.strings.strip_dollars
-        self.env.filters['rm_fake'] = filters.strings.rm_fake
-        self.env.filters['rm_math_space'] = filters.latex.rm_math_space
-        self.env.filters['wrap'] = filters.strings.wrap
-    
-
     def _preprocess(self, nb):
         """ Preprocess the notebook using the transformers specific
         for the current export format.
 
         nb: Notebook to preprocess
         """
 
         #Dict of 'resources' that can be filled by the preprocessors.
         resources = {}
 
         #Run each transformer on the notebook.  Carry the output along
         #to each transformer
         for transformer in self.preprocessors:
             nb, resources = transformer(nb, resources)
         return nb, resources
 

nbconvert/api/latex.py

@@ -1,150 +1,127 b''
  """Latex exporter for the notebook conversion pipeline.
 
 This module defines Exporter, a highly configurable converter
 that uses Jinja2 to export notebook files into different format.
 
 You can register both pre-transformers that will act on the notebook format
-befor conversion and jinja filter that would then be availlable in the templates
+before conversion and jinja filter that would then be available in the templates
 """
 
 #-----------------------------------------------------------------------------
 # 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 base.Exporter as Exporter
 
 #Try to import the Sphinx exporter.  If the user doesn't have Sphinx isntalled 
 #on his/her machine, fail silently.
 try:
     from .sphinx_transformer import (SphinxTransformer) #TODO
 except ImportError:
     SphinxTransformer = None
 
 #-----------------------------------------------------------------------------
 # Globals and constants
 #-----------------------------------------------------------------------------
 
 #Latex Jinja2 constants
 LATEX_TEMPLATE_PATH = "/../templates/tex/"
 LATEX_TEMPLATE_SKELETON_PATH = "/../templates/tex/skeleton/"
 LATEX_TEMPLATE_EXTENSION = ".tplx"
 
 #Special Jinja2 syntax that will not conflict when exporting latex.
 LATEX_JINJA_COMMENT_BLOCK = ["((=", "=))"]
 LATEX_JINJA_VARIABLE_BLOCK = ["(((", ")))"]
 LATEX_JINJA_LOGIC_BLOCK = ["((*", "*))"]
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 class LatexExporter(Exporter):
     """ A Jinja2 base converter templates
 
     Preprocess the ipynb files, feed it throug jinja templates,
     and spit an converted files and a data object with other data
     should be mostly configurable
     """
 
     #Processors that process the input data prior to the export, set in the 
     #constructor for this class.
     preprocessors = [] 
 
     def __init__(self, preprocessors={}, jinja_filters={}, config=None, export_format, **kw):
         """ Init a new converter.
 
         config: the Configurable config object to pass around.
 
-        preprocessors: dict of **availlable** key/value function to run on
+        preprocessors: dict of **available** key/value function to run on
                        ipynb json data before conversion to extract/inline file.
                        See `transformer.py` and `ConfigurableTransformers`
 
                        set the order in which the transformers should apply
                        with the `pre_transformer_order` trait of this class
 
                        transformers registerd by this key will take precedence on
                        default one.
 
         jinja_filters: dict of supplementary jinja filter that should be made
-                       availlable in template. If those are of Configurable Class type,
+                       available in template. If those are of Configurable Class type,
                        they will be instanciated with the config object as argument.
 
-                       user defined filter will overwrite the one availlable by default.
+                       user defined filter will overwrite the one available by default.
         """
 
-        #Merge default config options with user specific override options.
-        default_config = self._get_default_options()
-        if not config == None:
-            default_config._merge(config)
-        config = default_config
-
         #Call the base class constructor
         super(Exporter, self).__init__(config=config, **kw)
 
-        #Create a Latex environment if the user is exporting latex.
-        if self.tex_environement:
-            self.ext = LATEX_TEMPLATE_EXTENSION
-            self.env = Environment(
-                loader=FileSystemLoader([
-                    os.path.dirname(os.path.realpath(__file__)) + LATEX_TEMPLATE_PATH,
-                    os.path.dirname(os.path.realpath(__file__)) + LATEX_TEMPLATE_SKELETON_PATH,
-                    ]),
-                extensions=JINJA_EXTENSIONS
-                )
-
-            #Set special Jinja2 syntax that will not conflict with latex.
-            self.env.block_start_string = LATEX_JINJA_LOGIC_BLOCK[0]
-            self.env.block_end_string = LATEX_JINJA_LOGIC_BLOCK[1]
-            self.env.variable_start_string = LATEX_JINJA_VARIABLE_BLOCK[0]
-            self.env.variable_end_string = LATEX_JINJA_VARIABLE_BLOCK[1]
-            self.env.comment_start_string = LATEX_JINJA_COMMENT_BLOCK[0]
-            self.env.comment_end_string = LATEX_JINJA_COMMENT_BLOCK[1]
-
-        else: #Standard environment
-            self.ext = TEMPLATE_EXTENSION
-            self.env = Environment(
-                loader=FileSystemLoader([
-                    os.path.dirname(os.path.realpath(__file__)) + TEMPLATE_PATH,
-                    os.path.dirname(os.path.realpath(__file__)) + TEMPLATE_SKELETON_PATH,
-                    ]),
-                extensions=JINJA_EXTENSIONS
-                )
-
-        for name in self.pre_transformer_order:
-            # get the user-defined transformer first
-            transformer = preprocessors.get(name, getattr(trans, name, None))
-            if isinstance(transformer, MetaHasTraits):
-                transformer = transformer(config=config)
-            self.preprocessors.append(transformer)
-
         #For compatibility, TODO: remove later.
         self.preprocessors.append(trans.coalesce_streams)
         self.preprocessors.append(trans.ExtractFigureTransformer(config=config))
         self.preprocessors.append(trans.RevealHelpTransformer(config=config))
         self.preprocessors.append(trans.CSSHtmlHeaderTransformer(config=config))
         self.preprocessors.append(LatexTransformer(config=config))
 
         #Only load the sphinx transformer if the file reference worked 
         #(Sphinx dependencies exist on the user's machine.)
         if SphinxTransformer:
             self.preprocessors.append(SphinxTransformer(config=config))
 
         #Add filters to the Jinja2 environment
         self.env.filters['escape_tex'] = filters.latex.escape_tex 
         self.env.filters['highlight'] = filters.pygments.highlight2latex 
             
         #Load user filters.  Overwrite existing filters if need be.
         for key, user_filter in jinja_filters.iteritems():
             if isinstance(user_filter, MetaHasTraits):
                 self.env.filters[key] = user_filter(config=config)
             else:
                 self.env.filters[key] = user_filter
 
         #Load the template file.
         self.template = self.env.get_template(self.template_file+self.ext)
+
+
+    def _init_environment(self):
+        self.ext = LATEX_TEMPLATE_EXTENSION
+        self.env = Environment(
+            loader=FileSystemLoader([
+                os.path.dirname(os.path.realpath(__file__)) + LATEX_TEMPLATE_PATH,
+                os.path.dirname(os.path.realpath(__file__)) + LATEX_TEMPLATE_SKELETON_PATH,
+                ]),
+            extensions=JINJA_EXTENSIONS
+            )
+
+        #Set special Jinja2 syntax that will not conflict with latex.
+        self.env.block_start_string = LATEX_JINJA_LOGIC_BLOCK[0]
+        self.env.block_end_string = LATEX_JINJA_LOGIC_BLOCK[1]
+        self.env.variable_start_string = LATEX_JINJA_VARIABLE_BLOCK[0]
+        self.env.variable_end_string = LATEX_JINJA_VARIABLE_BLOCK[1]
+        self.env.comment_start_string = LATEX_JINJA_COMMENT_BLOCK[0]
+        self.env.comment_end_string = LATEX_JINJA_COMMENT_BLOCK[1]
  No newline at end of file