More clean-up. Nomenclature changes

nbconvert/api/base.py

@@ -104,7 +104,7 b' class Exporter(Configurable):'
     #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.
@@ -150,13 +150,14 b' class Exporter(Configurable):'
         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)
@@ -165,23 +166,24 b' class Exporter(Configurable):'
         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
@@ -202,11 +204,11 b' class Exporter(Configurable):'
         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.
 
@@ -215,9 +217,35 b' class Exporter(Configurable):'
         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([
@@ -228,26 +256,6 b' class Exporter(Configurable):'
             )
 
 
-    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.

nbconvert/api/latex.py

@@ -4,7 +4,7 b' 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
 """
 
 #-----------------------------------------------------------------------------
@@ -61,7 +61,7 b' class LatexExporter(Exporter):'
 
         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`
 
@@ -72,57 +72,15 b' class LatexExporter(Exporter):'
                        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))
@@ -148,3 +106,22 b' class LatexExporter(Exporter):'
 
         #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