mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
7a4ce71f6b
If pygments fails to lex a source string as the specified highlight language, Sphinx prints a warning. Previously, that warning did not include the actual source text, although it does include location information. However, in some cases the location information may be missing, there may be multiple highlighted literals on the same line, or the rST is automatically generated somehow. In such cases, it can be difficult to determine the source text that led to the error. With this change, the source text is included in the warning.
105 lines
3.5 KiB
Python
105 lines
3.5 KiB
Python
"""Test the Pygments highlighting bridge."""
|
|
|
|
from unittest import mock
|
|
|
|
from pygments.formatters.html import HtmlFormatter
|
|
from pygments.lexer import RegexLexer
|
|
from pygments.token import Name, Text
|
|
|
|
from sphinx.highlighting import PygmentsBridge
|
|
|
|
|
|
class MyLexer(RegexLexer):
|
|
name = 'testlexer'
|
|
|
|
tokens = {
|
|
'root': [
|
|
('a', Name),
|
|
('b', Text),
|
|
],
|
|
}
|
|
|
|
|
|
class MyFormatter(HtmlFormatter):
|
|
def format(self, tokensource, outfile):
|
|
for tok in tokensource:
|
|
outfile.write(tok[1])
|
|
|
|
|
|
class ComplainOnUnhighlighted(PygmentsBridge):
|
|
def unhighlighted(self, source):
|
|
raise AssertionError("should highlight %r" % source)
|
|
|
|
|
|
def test_add_lexer(app, status, warning):
|
|
app.add_lexer('test', MyLexer)
|
|
|
|
bridge = PygmentsBridge('html')
|
|
ret = bridge.highlight_block('ab', 'test')
|
|
assert '<span class="n">a</span>b' in ret
|
|
|
|
|
|
def test_detect_interactive():
|
|
bridge = ComplainOnUnhighlighted('html')
|
|
blocks = [
|
|
"""
|
|
>>> testing()
|
|
True
|
|
""",
|
|
]
|
|
for block in blocks:
|
|
ret = bridge.highlight_block(block.lstrip(), 'python')
|
|
assert ret.startswith("<div class=\"highlight\">")
|
|
|
|
|
|
def test_lexer_options():
|
|
bridge = PygmentsBridge('html')
|
|
ret = bridge.highlight_block('//comment', 'php', opts={'startinline': True})
|
|
assert '<span class="c1">//comment</span>' in ret
|
|
|
|
|
|
def test_set_formatter():
|
|
PygmentsBridge.html_formatter = MyFormatter
|
|
try:
|
|
bridge = PygmentsBridge('html')
|
|
ret = bridge.highlight_block('foo\n', 'python')
|
|
assert ret == 'foo\n'
|
|
finally:
|
|
PygmentsBridge.html_formatter = HtmlFormatter
|
|
|
|
|
|
@mock.patch('sphinx.highlighting.logger')
|
|
def test_default_highlight(logger):
|
|
bridge = PygmentsBridge('html')
|
|
|
|
# default: highlights as python3
|
|
ret = bridge.highlight_block('print "Hello sphinx world"', 'default')
|
|
assert ret == ('<div class="highlight"><pre><span></span><span class="nb">print</span> '
|
|
'<span class="s2">"Hello sphinx world"</span>\n</pre></div>\n')
|
|
|
|
# default: fallbacks to none if highlighting failed
|
|
ret = bridge.highlight_block('reST ``like`` text', 'default')
|
|
assert ret == '<div class="highlight"><pre><span></span>reST ``like`` text\n</pre></div>\n'
|
|
|
|
# python: highlights as python3
|
|
ret = bridge.highlight_block('print("Hello sphinx world")', 'python')
|
|
assert ret == ('<div class="highlight"><pre><span></span><span class="nb">print</span>'
|
|
'<span class="p">(</span>'
|
|
'<span class="s2">"Hello sphinx world"</span>'
|
|
'<span class="p">)</span>\n</pre></div>\n')
|
|
|
|
# python3: highlights as python3
|
|
ret = bridge.highlight_block('print("Hello sphinx world")', 'python3')
|
|
assert ret == ('<div class="highlight"><pre><span></span><span class="nb">print</span>'
|
|
'<span class="p">(</span>'
|
|
'<span class="s2">"Hello sphinx world"</span>'
|
|
'<span class="p">)</span>\n</pre></div>\n')
|
|
|
|
# python: raises error if highlighting failed
|
|
ret = bridge.highlight_block('reST ``like`` text', 'python')
|
|
logger.warning.assert_called_with('Could not lex literal_block %r as "%s". '
|
|
'Highlighting skipped.',
|
|
'reST ``like`` text', 'python',
|
|
type='misc', subtype='highlighting_failure',
|
|
location=None)
|