nbconvert/api/latex.py

 """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
"""

#-----------------------------------------------------------------------------
# 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
                       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.
        """

        #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)