##// END OF EJS Templates
Backport PR #5498: use milestones to indicate backport...
Backport PR #5498: use milestones to indicate backport instead of labels. I think this will more clearly indicate what's new in what releases, plus it's way easier to show pull requests with a specific milestone than it is with a specific label.

File last commit:

r15880:9aa63755
r16231:a62ef02d
Show More
markdown.py
139 lines | 4.3 KiB | text/x-python | PythonLexer
Jonathan Frederic
Cleanup and refactor of filters
r10676 """Markdown filters
This file contains a collection of utility filters for dealing with
markdown within Jinja templates.
Jonathan Frederic
Transformer refactor
r10436 """
#-----------------------------------------------------------------------------
# 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
# Stdlib imports
MinRK
add marked.js entry point for md2html in nbconvert...
r14206 import os
Jonathan Frederic
Transformer refactor
r10436 import subprocess
Jonathan Frederic
Only check for node on first call, not on import.
r15697 import warnings
MinRK
prefer marked to pandoc for markdown2html...
r14203 from io import TextIOWrapper, BytesIO
Jonathan Frederic
Transformer refactor
r10436
MinRK
prefer marked to pandoc for markdown2html...
r14203 # IPython imports
MinRK
add markdown2html filter...
r11268 from IPython.nbconvert.utils.pandoc import pandoc
MinRK
prefer marked to pandoc for markdown2html...
r14203 from IPython.nbconvert.utils.exceptions import ConversionException
Jonathan Frederic
Cleanup
r15692 from IPython.utils.process import get_output_error_code
MinRK
prefer marked to pandoc for markdown2html...
r14203 from IPython.utils.py3compat import cast_bytes
Jonathan Frederic
Cleanup
r15692 from IPython.utils.version import check_version
MinRK
add markdown2html filter...
r11268
Jonathan Frederic
Transformer refactor
r10436 #-----------------------------------------------------------------------------
# Functions
#-----------------------------------------------------------------------------
MinRK
add marked.js entry point for md2html in nbconvert...
r14206 marked = os.path.join(os.path.dirname(__file__), "marked.js")
Jonathan Frederic
Only check for node on first call, not on import.
r15697 _node = None
Jonathan Frederic
Post code-review, extended refactor.
r10485
Brian E. Granger
Fixing import logic.
r11088 __all__ = [
MinRK
add markdown2html filter...
r11268 'markdown2html',
MinRK
prefer marked to pandoc for markdown2html...
r14203 'markdown2html_pandoc',
'markdown2html_marked',
Brian E. Granger
Fixing import logic.
r11088 'markdown2latex',
MinRK
prefer marked to pandoc for markdown2html...
r14203 'markdown2rst',
Brian E. Granger
Fixing import logic.
r11088 ]
MinRK
add marked.js entry point for md2html in nbconvert...
r14206 class NodeJSMissing(ConversionException):
"""Exception raised when node.js is missing."""
MinRK
prefer marked to pandoc for markdown2html...
r14203 pass
Jonathan Frederic
Cleanup and refactor of filters
r10676 def markdown2latex(source):
Jonathan Frederic
Transformer refactor
r10436 """Convert a markdown string to LaTeX via pandoc.
This function will raise an error if pandoc is not installed.
Any error messages generated by pandoc are printed to stderr.
Parameters
----------
Jonathan Frederic
Cleanup and refactor of filters
r10676 source : string
Jonathan Frederic
Transformer refactor
r10436 Input string, assumed to be valid markdown.
Returns
-------
out : string
Output as returned by pandoc.
"""
MinRK
add markdown2html filter...
r11268 return pandoc(source, 'markdown', 'latex')
Jonathan Frederic
Transformer refactor
r10436
Jonathan Frederic
Only check for node on first call, not on import.
r15697 def markdown2html(source):
"""Convert a markdown string to HTML"""
global _node
if _node is None:
# prefer md2html via marked if node.js >= 0.9.12 is available
# node is called nodejs on debian, so try that first
_node = 'nodejs'
if not _verify_node(_node):
_node = 'node'
if not _verify_node(_node):
warnings.warn( "Node.js 0.9.12 or later wasn't found.\n" +
"Nbconvert will try to use Pandoc instead.")
_node = False
Jonathan Frederic
Switch if/else order
r15700 if _node:
Jonathan Frederic
Only check for node on first call, not on import.
r15697 return markdown2html_marked(source)
Jonathan Frederic
Switch if/else order
r15700 else:
return markdown2html_pandoc(source)
Jonathan Frederic
Only check for node on first call, not on import.
r15697
MinRK
prefer marked to pandoc for markdown2html...
r14203 def markdown2html_pandoc(source):
MinRK
add markdown2html filter...
r11268 """Convert a markdown string to HTML via pandoc"""
MinRK
use mathjax-style for math passing through pandoc to html
r11294 return pandoc(source, 'markdown', 'html', extra_args=['--mathjax'])
MinRK
add markdown2html filter...
r11268
MinRK
prefer marked to pandoc for markdown2html...
r14203 def markdown2html_marked(source, encoding='utf-8'):
"""Convert a markdown string to HTML via marked"""
Jonathan Frederic
Only check for node on first call, not on import.
r15697 command = [_node, marked]
MinRK
prefer marked to pandoc for markdown2html...
r14203 try:
p = subprocess.Popen(command,
stdin=subprocess.PIPE, stdout=subprocess.PIPE
)
except OSError as e:
MinRK
add marked.js entry point for md2html in nbconvert...
r14206 raise NodeJSMissing(
MinRK
prefer marked to pandoc for markdown2html...
r14203 "The command '%s' returned an error: %s.\n" % (" ".join(command), e) +
MinRK
add marked.js entry point for md2html in nbconvert...
r14206 "Please check that Node.js is installed."
MinRK
prefer marked to pandoc for markdown2html...
r14203 )
out, _ = p.communicate(cast_bytes(source, encoding))
out = TextIOWrapper(BytesIO(out), encoding, 'replace').read()
return out.rstrip('\n')
Jonathan Frederic
Cleanup and refactor of filters
r10676 def markdown2rst(source):
Paul Ivanov
urlencode images for rst files...
r15880 """Convert a markdown string to ReST via pandoc.
Jonathan Frederic
Transformer refactor
r10436
This function will raise an error if pandoc is not installed.
Any error messages generated by pandoc are printed to stderr.
Parameters
----------
Jonathan Frederic
Cleanup and refactor of filters
r10676 source : string
Jonathan Frederic
Transformer refactor
r10436 Input string, assumed to be valid markdown.
Returns
-------
out : string
Output as returned by pandoc.
"""
MinRK
add markdown2html filter...
r11268 return pandoc(source, 'markdown', 'rst')
Jonathan Frederic
nbconvert: Make sure node is atleast version 0.9.12
r15691 def _verify_node(cmd):
Jonathan Frederic
Cleanup
r15692 """Verify that the node command exists and is at least the minimum supported
Jonathan Frederic
nbconvert: Make sure node is atleast version 0.9.12
r15691 version of node.
Parameters
----------
cmd : string
Node command to verify (i.e 'node')."""
MinRK
handle nodejs executable on debian...
r15437 try:
Jonathan Frederic
Cleanup
r15692 out, err, return_code = get_output_error_code([cmd, '--version'])
except OSError:
Jonathan Frederic
Split logic onto multiple lines.
r15693 # Command not found
Jonathan Frederic
nbconvert: Make sure node is atleast version 0.9.12
r15691 return False
Jonathan Frederic
Split logic onto multiple lines.
r15693 if return_code:
# Command error
return False
return check_version(out.lstrip('v'), '0.9.12')