From 500d6fe801469b9757e9aee0a30c6d8117008f9f 2014-04-11 04:12:19 From: MinRK Date: 2014-04-11 04:12:19 Subject: [PATCH] add PDFExporter replace `nbconvert --to latex --post pdf` with `nbconvert --to pdf` --- diff --git a/IPython/nbconvert/exporters/__init__.py b/IPython/nbconvert/exporters/__init__.py index 23f6195..6397472 100644 --- a/IPython/nbconvert/exporters/__init__.py +++ b/IPython/nbconvert/exporters/__init__.py @@ -4,6 +4,7 @@ from .slides import SlidesExporter from .templateexporter import TemplateExporter from .latex import LatexExporter from .markdown import MarkdownExporter +from .pdf import PDFExporter from .python import PythonExporter from .rst import RSTExporter from .exporter import Exporter diff --git a/IPython/nbconvert/exporters/export.py b/IPython/nbconvert/exporters/export.py index e9fff80..62f909e 100644 --- a/IPython/nbconvert/exporters/export.py +++ b/IPython/nbconvert/exporters/export.py @@ -1,17 +1,7 @@ -""" -Module containing single call export functions. -""" -#----------------------------------------------------------------------------- -# 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. -#----------------------------------------------------------------------------- +"""Module containing single call export functions.""" -#----------------------------------------------------------------------------- -# Imports -#----------------------------------------------------------------------------- +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. from functools import wraps @@ -24,6 +14,7 @@ from .templateexporter import TemplateExporter from .html import HTMLExporter from .slides import SlidesExporter from .latex import LatexExporter +from .pdf import PDFExporter from .markdown import MarkdownExporter from .python import PythonExporter from .rst import RSTExporter @@ -79,6 +70,7 @@ __all__ = [ 'export_custom', 'export_slides', 'export_latex', + 'export_pdf', 'export_markdown', 'export_python', 'export_rst', @@ -134,6 +126,7 @@ exporter_map = dict( html=HTMLExporter, slides=SlidesExporter, latex=LatexExporter, + pdf=PDFExporter, markdown=MarkdownExporter, python=PythonExporter, rst=RSTExporter, diff --git a/IPython/nbconvert/exporters/pdf.py b/IPython/nbconvert/exporters/pdf.py new file mode 100644 index 0000000..0ef2b2d --- /dev/null +++ b/IPython/nbconvert/exporters/pdf.py @@ -0,0 +1,141 @@ +"""Export to PDF via latex""" + +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. + +import subprocess +import os +import sys + +from IPython.utils.traitlets import Integer, List, Bool, Instance +from IPython.utils.tempdir import TemporaryWorkingDirectory +from .latex import LatexExporter + + +class PDFExporter(LatexExporter): + """Writer designed to write to PDF files""" + + latex_count = Integer(3, config=True, + help="How many times latex will be called." + ) + + latex_command = List([u"pdflatex", u"{filename}"], config=True, + help="Shell command used to compile latex." + ) + + bib_command = List([u"bibtex", u"{filename}"], config=True, + help="Shell command used to run bibtex." + ) + + verbose = Bool(False, config=True, + help="Whether to display the output of latex commands." + ) + + temp_file_exts = List(['.aux', '.bbl', '.blg', '.idx', '.log', '.out'], config=True, + help="File extensions of temp files to remove after running." + ) + + writer = Instance("IPython.nbconvert.writers.FilesWriter", args=()) + + def run_command(self, command_list, filename, count, log_function): + """Run command_list count times. + + Parameters + ---------- + command_list : list + A list of args to provide to Popen. Each element of this + list will be interpolated with the filename to convert. + filename : unicode + The name of the file to convert. + count : int + How many times to run the command. + + Returns + ------- + success : bool + A boolean indicating if the command was successful (True) + or failed (False). + """ + command = [c.format(filename=filename) for c in command_list] + #In windows and python 2.x there is a bug in subprocess.Popen and + # unicode commands are not supported + if sys.platform == 'win32' and sys.version_info < (3,0): + #We must use cp1252 encoding for calling subprocess.Popen + #Note that sys.stdin.encoding and encoding.DEFAULT_ENCODING + # could be different (cp437 in case of dos console) + command = [c.encode('cp1252') for c in command] + times = 'time' if count == 1 else 'times' + self.log.info("Running %s %i %s: %s", command_list[0], count, times, command) + with open(os.devnull, 'rb') as null: + stdout = subprocess.PIPE if not self.verbose else None + for index in range(count): + p = subprocess.Popen(command, stdout=stdout, stdin=null) + out, err = p.communicate() + if p.returncode: + if self.verbose: + # verbose means I didn't capture stdout with PIPE, + # so it's already been displayed and `out` is None. + out = u'' + else: + out = out.decode('utf-8', 'replace') + log_function(command, out) + return False # failure + return True # success + + def run_latex(self, filename): + """Run pdflatex self.latex_count times.""" + + def log_error(command, out): + self.log.critical(u"%s failed: %s\n%s", command[0], command, out) + + return self.run_command(self.latex_command, filename, + self.latex_count, log_error) + + def run_bib(self, filename): + """Run bibtex self.latex_count times.""" + filename = os.path.splitext(filename)[0] + + def log_error(command, out): + self.log.warn('%s had problems, most likely because there were no citations', + command[0]) + self.log.debug(u"%s output: %s\n%s", command[0], command, out) + + return self.run_command(self.bib_command, filename, 1, log_error) + + def clean_temp_files(self, filename): + """Remove temporary files created by pdflatex/bibtex.""" + self.log.info("Removing temporary LaTeX files") + filename = os.path.splitext(filename)[0] + for ext in self.temp_file_exts: + try: + os.remove(filename+ext) + except OSError: + pass + + def from_notebook_node(self, nb, resources=None, **kw): + latex, resources = super(PDFExporter, self).from_notebook_node( + nb, resources=resources, **kw + ) + with TemporaryWorkingDirectory() as td: + notebook_name = "notebook" + tex_file = self.writer.write(latex, resources, notebook_name=notebook_name) + self.log.info("Building PDF") + rc = self.run_latex(tex_file) + if not rc: + rc = self.run_bib(tex_file) + if not rc: + rc = self.run_latex(tex_file) + + pdf_file = notebook_name + '.pdf' + if not os.path.isfile(pdf_file): + raise RuntimeError("PDF creating failed") + self.log.info('PDF successfully created') + with open(pdf_file, 'rb') as f: + pdf_data = f.read() + + # convert output extension to pdf + # the writer above required it to be tex + resources['output_extension'] = 'pdf' + + return pdf_data, resources + diff --git a/IPython/nbconvert/nbconvertapp.py b/IPython/nbconvert/nbconvertapp.py index 1c8a62c..fb31df4 100755 --- a/IPython/nbconvert/nbconvertapp.py +++ b/IPython/nbconvert/nbconvertapp.py @@ -1,21 +1,12 @@ #!/usr/bin/env python -"""NBConvert is a utility for conversion of .ipynb files. +"""NbConvert is a utility for conversion of .ipynb files. Command-line interface for the NbConvert conversion utility. """ -#----------------------------------------------------------------------------- -#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 -#----------------------------------------------------------------------------- +# Copyright (c) IPython Development Team. +# Distributed under the terms of the Modified BSD License. -# Stdlib imports from __future__ import print_function import logging @@ -23,7 +14,6 @@ import sys import os import glob -# From IPython from IPython.core.application import BaseIPythonApplication, base_aliases, base_flags from IPython.core.profiledir import ProfileDir from IPython.config import catch_config_error, Configurable @@ -128,9 +118,9 @@ class NbConvertApp(BaseIPythonApplication): > ipython nbconvert mynotebook.ipynb --stdout - A post-processor can be used to compile a PDF + PDF is generated via latex - > ipython nbconvert mynotebook.ipynb --to latex --post PDF + > ipython nbconvert mynotebook.ipynb --to pdf You can get (and serve) a Reveal.js-powered slideshow