1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244
|
"""
HTML renderer for mistletoe.
"""
import html
from itertools import chain
from urllib.parse import quote
from mistletoe import block_token
from mistletoe import span_token
from mistletoe.block_token import HtmlBlock
from mistletoe.span_token import HtmlSpan
from mistletoe.base_renderer import BaseRenderer
class HtmlRenderer(BaseRenderer):
"""
HTML renderer class.
See mistletoe.base_renderer module for more info.
"""
def __init__(
self,
*extras,
html_escape_double_quotes=False,
html_escape_single_quotes=False,
process_html_tokens=True,
**kwargs
):
"""
Args:
extras (list): allows subclasses to add even more custom tokens.
html_escape_double_quotes (bool): whether to also escape double
quotes when HTML-escaping rendered text.
html_escape_single_quotes (bool): whether to also escape single
quotes when HTML-escaping rendered text.
process_html_tokens (bool): whether to include HTML tokens in the
processing. If `False`, HTML markup will be treated as plain
text: e.g. input ``<br>`` will be rendered as ``<br>``.
**kwargs: additional parameters to be passed to the ancestor's
constructor.
"""
self._suppress_ptag_stack = [False]
final_extras = chain((HtmlBlock, HtmlSpan) if process_html_tokens else (), extras)
super().__init__(*final_extras, **kwargs)
self.html_escape_double_quotes = html_escape_double_quotes
self.html_escape_single_quotes = html_escape_single_quotes
def __exit__(self, *args):
super().__exit__(*args)
def render_to_plain(self, token) -> str:
if token.children is not None:
inner = [self.render_to_plain(child) for child in token.children]
return ''.join(inner)
return html.escape(token.content)
def render_strong(self, token: span_token.Strong) -> str:
template = '<strong>{}</strong>'
return template.format(self.render_inner(token))
def render_emphasis(self, token: span_token.Emphasis) -> str:
template = '<em>{}</em>'
return template.format(self.render_inner(token))
def render_inline_code(self, token: span_token.InlineCode) -> str:
template = '<code>{}</code>'
inner = self.escape_html_text(token.children[0].content)
return template.format(inner)
def render_strikethrough(self, token: span_token.Strikethrough) -> str:
template = '<del>{}</del>'
return template.format(self.render_inner(token))
def render_image(self, token: span_token.Image) -> str:
template = '<img src="{}" alt="{}"{} />'
if token.title:
title = ' title="{}"'.format(html.escape(token.title))
else:
title = ''
return template.format(token.src, self.render_to_plain(token), title)
def render_link(self, token: span_token.Link) -> str:
template = '<a href="{target}"{title}>{inner}</a>'
target = self.escape_url(token.target)
if token.title:
title = ' title="{}"'.format(html.escape(token.title))
else:
title = ''
inner = self.render_inner(token)
return template.format(target=target, title=title, inner=inner)
def render_auto_link(self, token: span_token.AutoLink) -> str:
template = '<a href="{target}">{inner}</a>'
if token.mailto:
target = 'mailto:{}'.format(token.target)
else:
target = self.escape_url(token.target)
inner = self.render_inner(token)
return template.format(target=target, inner=inner)
def render_escape_sequence(self, token: span_token.EscapeSequence) -> str:
return self.render_inner(token)
def render_raw_text(self, token: span_token.RawText) -> str:
return self.escape_html_text(token.content)
@staticmethod
def render_html_span(token: span_token.HtmlSpan) -> str:
return token.content
def render_heading(self, token: block_token.Heading) -> str:
template = '<h{level}>{inner}</h{level}>'
inner = self.render_inner(token)
return template.format(level=token.level, inner=inner)
def render_quote(self, token: block_token.Quote) -> str:
elements = ['<blockquote>']
self._suppress_ptag_stack.append(False)
elements.extend([self.render(child) for child in token.children])
self._suppress_ptag_stack.pop()
elements.append('</blockquote>')
return '\n'.join(elements)
def render_paragraph(self, token: block_token.Paragraph) -> str:
if self._suppress_ptag_stack[-1]:
return '{}'.format(self.render_inner(token))
return '<p>{}</p>'.format(self.render_inner(token))
def render_block_code(self, token: block_token.BlockCode) -> str:
template = '<pre><code{attr}>{inner}</code></pre>'
if token.language:
attr = ' class="{}"'.format('language-{}'.format(html.escape(token.language)))
else:
attr = ''
inner = self.escape_html_text(token.content)
return template.format(attr=attr, inner=inner)
def render_list(self, token: block_token.List) -> str:
template = '<{tag}{attr}>\n{inner}\n</{tag}>'
if token.start is not None:
tag = 'ol'
attr = ' start="{}"'.format(token.start) if token.start != 1 else ''
else:
tag = 'ul'
attr = ''
self._suppress_ptag_stack.append(not token.loose)
inner = '\n'.join([self.render(child) for child in token.children])
self._suppress_ptag_stack.pop()
return template.format(tag=tag, attr=attr, inner=inner)
def render_list_item(self, token: block_token.ListItem) -> str:
if len(token.children) == 0:
return '<li></li>'
inner = '\n'.join([self.render(child) for child in token.children])
inner_template = '\n{}\n'
if self._suppress_ptag_stack[-1]:
if token.children[0].__class__.__name__ == 'Paragraph':
inner_template = inner_template[1:]
if token.children[-1].__class__.__name__ == 'Paragraph':
inner_template = inner_template[:-1]
return '<li>{}</li>'.format(inner_template.format(inner))
def render_table(self, token: block_token.Table) -> str:
# This is actually gross and I wonder if there's a better way to do it.
#
# The primary difficulty seems to be passing down alignment options to
# reach individual cells.
template = '<table>\n{inner}</table>'
if hasattr(token, 'header'):
head_template = '<thead>\n{inner}</thead>\n'
head_inner = self.render_table_row(token.header, is_header=True)
head_rendered = head_template.format(inner=head_inner)
else:
head_rendered = ''
body_template = '<tbody>\n{inner}</tbody>\n'
body_inner = self.render_inner(token)
body_rendered = body_template.format(inner=body_inner)
return template.format(inner=head_rendered + body_rendered)
def render_table_row(self, token: block_token.TableRow, is_header=False) -> str:
template = '<tr>\n{inner}</tr>\n'
inner = ''.join([self.render_table_cell(child, is_header)
for child in token.children])
return template.format(inner=inner)
def render_table_cell(self, token: block_token.TableCell, in_header=False) -> str:
template = '<{tag}{attr}>{inner}</{tag}>\n'
tag = 'th' if in_header else 'td'
if token.align is None:
align = 'left'
elif token.align == 0:
align = 'center'
elif token.align == 1:
align = 'right'
attr = ' align="{}"'.format(align)
inner = self.render_inner(token)
return template.format(tag=tag, attr=attr, inner=inner)
@staticmethod
def render_thematic_break(token: block_token.ThematicBreak) -> str:
return '<hr />'
@staticmethod
def render_line_break(token: span_token.LineBreak) -> str:
return '\n' if token.soft else '<br />\n'
@staticmethod
def render_html_block(token: block_token.HtmlBlock) -> str:
return token.content
def render_document(self, token: block_token.Document) -> str:
self.footnotes.update(token.footnotes)
inner = '\n'.join([self.render(child) for child in token.children])
return '{}\n'.format(inner) if inner else ''
def escape_html_text(self, s: str) -> str:
"""
Like `html.escape()`, but this looks into the current rendering options
to decide which of the quotes (double, single, or both) to escape.
Intended for escaping text content. To escape content of an attribute,
simply call `html.escape()`.
"""
s = s.replace("&", "&") # Must be done first!
s = s.replace("<", "<")
s = s.replace(">", ">")
if self.html_escape_double_quotes:
s = s.replace('"', """)
if self.html_escape_single_quotes:
s = s.replace('\'', "'")
return s
@staticmethod
def escape_url(raw: str) -> str:
"""
Escape urls to prevent code injection craziness. (Hopefully.)
"""
return html.escape(quote(raw, safe='/#:()*?=%@+,&;'))
HTMLRenderer = HtmlRenderer
"""
Deprecated name of the `HtmlRenderer` class.
"""
|