export.py
220 lines
| 6.1 KiB
| text/x-python
|
PythonLexer
|
r10677 | """ | ||
|
r10690 | Module containing single call export functions. | ||
|
r10485 | """ | ||
#----------------------------------------------------------------------------- | ||||
# 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. | ||||
#----------------------------------------------------------------------------- | ||||
|
r10690 | #----------------------------------------------------------------------------- | ||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
|
r10771 | from functools import wraps | ||
|
r10690 | |||
|
r10624 | from IPython.nbformat.v3.nbbase import NotebookNode | ||
|
r11367 | from IPython.config import Config | ||
|
r10624 | |||
|
r10788 | from .exporter import Exporter | ||
|
r11108 | from .basichtml import BasicHTMLExporter | ||
from .fullhtml import FullHTMLExporter | ||||
|
r10788 | from .latex import LatexExporter | ||
from .markdown import MarkdownExporter | ||||
from .python import PythonExporter | ||||
from .reveal import RevealExporter | ||||
from .rst import RstExporter | ||||
from .sphinx_howto import SphinxHowtoExporter | ||||
from .sphinx_manual import SphinxManualExporter | ||||
|
r10768 | |||
|
r10485 | #----------------------------------------------------------------------------- | ||
|
r10771 | # Classes | ||
|
r10485 | #----------------------------------------------------------------------------- | ||
|
r10588 | |||
|
r10771 | def DocDecorator(f): | ||
|
r10690 | |||
|
r10771 | #Set docstring of function | ||
f.__doc__ = f.__doc__ + """ | ||||
nb : Notebook node | ||||
|
r11367 | config : config (optional, keyword arg) | ||
|
r10690 | User configuration instance. | ||
|
r11367 | resources : dict (optional, keyword arg) | ||
Resources used in the conversion process. | ||||
|
r10690 | |||
Returns | ||||
---------- | ||||
tuple- output, resources, exporter_instance | ||||
output : str | ||||
Jinja 2 output. This is the resulting converted notebook. | ||||
resources : dictionary | ||||
Dictionary of resources used prior to and during the conversion | ||||
process. | ||||
exporter_instance : Exporter | ||||
Instance of the Exporter class used to export the document. Useful | ||||
to caller because it provides a 'file_extension' property which | ||||
|
r10771 | specifies what extension the output should be saved as.""" | ||
@wraps(f) | ||||
def decorator(*args, **kwargs): | ||||
return f(*args, **kwargs) | ||||
return decorator | ||||
#----------------------------------------------------------------------------- | ||||
# Functions | ||||
#----------------------------------------------------------------------------- | ||||
|
r11088 | __all__ = [ | ||
'export', | ||||
'export_sphinx_manual', | ||||
'export_sphinx_howto', | ||||
'export_basic_html', | ||||
'export_full_html', | ||||
'export_latex', | ||||
'export_markdown', | ||||
'export_python', | ||||
'export_reveal', | ||||
'export_rst', | ||||
|
r11250 | 'export_by_name', | ||
'get_export_names' | ||||
|
r11088 | ] | ||
|
r11372 | class ExporterNameError(NameError): | ||
pass | ||||
|
r10771 | @DocDecorator | ||
|
r11367 | def export(exporter_type, nb, **kw): | ||
|
r10771 | """ | ||
Export a notebook object using specific exporter class. | ||||
exporter_type : Exporter class type | ||||
Class type of the exporter that should be used. This method | ||||
will initialize it's own instance of the class. It is | ||||
ASSUMED that the class type provided exposes a | ||||
constructor (__init__) with the same signature as the | ||||
base Exporter class.} | ||||
|
r10690 | """ | ||
|
r10624 | |||
#Check arguments | ||||
if exporter_type is None: | ||||
raise TypeError("Exporter is None") | ||||
|
r10626 | elif not issubclass(exporter_type, Exporter): | ||
|
r10624 | raise TypeError("Exporter type does not inherit from Exporter (base)") | ||
if nb is None: | ||||
raise TypeError("nb is None") | ||||
#Create the exporter | ||||
|
r11379 | resources = kw.pop('resources', None) | ||
exporter_instance = exporter_type(**kw) | ||||
|
r10624 | |||
#Try to convert the notebook using the appropriate conversion function. | ||||
if isinstance(nb, NotebookNode): | ||||
|
r11367 | output, resources = exporter_instance.from_notebook_node(nb, resources) | ||
|
r10626 | elif isinstance(nb, basestring): | ||
|
r11367 | output, resources = exporter_instance.from_filename(nb, resources) | ||
|
r10624 | else: | ||
|
r11367 | output, resources = exporter_instance.from_file(nb, resources) | ||
return output, resources | ||||
|
r10624 | |||
|
r10677 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_sphinx_manual(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Sphinx Manual LaTeX | ||||
""" | ||||
|
r11367 | return export(SphinxManualExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_sphinx_howto(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Sphinx HowTo LaTeX | ||||
""" | ||||
|
r11367 | return export(SphinxHowtoExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_basic_html(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Basic HTML | ||||
""" | ||||
|
r11367 | return export(BasicHTMLExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_full_html(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Full HTML | ||||
""" | ||||
|
r11367 | return export(FullHTMLExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_latex(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to LaTeX | ||||
""" | ||||
|
r11367 | return export(LatexExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_markdown(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Markdown | ||||
""" | ||||
|
r11367 | return export(MarkdownExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_python(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Python | ||||
""" | ||||
|
r11367 | return export(PythonExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_reveal(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to Reveal | ||||
""" | ||||
|
r11367 | return export(RevealExporter, nb, **kw) | ||
|
r10690 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_rst(nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to RST | ||||
""" | ||||
|
r11367 | return export(RstExporter, nb, **kw) | ||
|
r10485 | |||
|
r10677 | |||
|
r10771 | @DocDecorator | ||
|
r11367 | def export_by_name(format_name, nb, **kw): | ||
|
r10690 | """ | ||
Export a notebook object to a template type by its name. Reflection | ||||
(Inspect) is used to find the template's corresponding explicit export | ||||
method defined in this module. That method is then called directly. | ||||
|
r11367 | format_name : str | ||
|
r10690 | Name of the template style to export to. | ||
""" | ||||
|
r11367 | function_name = "export_" + format_name.lower() | ||
|
r10690 | |||
|
r10769 | if function_name in globals(): | ||
|
r11367 | return globals()[function_name](nb, **kw) | ||
|
r10769 | else: | ||
|
r11372 | raise ExporterNameError("template for `%s` not found" % function_name) | ||
|
r10875 | |||
|
r11250 | def get_export_names(): | ||
"Return a list of the currently supported export targets" | ||||
# grab everything after 'export_' | ||||
l = [x[len('export_'):] for x in __all__ if x.startswith('export_')] | ||||
|
r11367 | |||
|
r11377 | # filter out the one method that is not a template | ||
|
r11250 | l = [x for x in l if 'by_name' not in x] | ||
return sorted(l) | ||||