diff options
| -rw-r--r-- | setup.py | 2 | ||||
| -rw-r--r-- | sphinx/highlighting.py | 33 | ||||
| -rw-r--r-- | sphinx/writers/latex.py | 13 | ||||
| -rw-r--r-- | tests/test_build_html.py | 21 | ||||
| -rw-r--r-- | tests/test_intl.py | 23 |
5 files changed, 21 insertions, 71 deletions
@@ -87,7 +87,7 @@ setup( 'sphinxcontrib-serializinghtml>=1.1.5', 'sphinxcontrib-qthelp', 'Jinja2>=3.0', - 'Pygments>=2.8', + 'Pygments>=2.12', 'docutils>=0.14,<0.20', 'snowballstemmer>=2.0', 'babel>=2.9', diff --git a/sphinx/highlighting.py b/sphinx/highlighting.py index bb020850f..4a737eb40 100644 --- a/sphinx/highlighting.py +++ b/sphinx/highlighting.py @@ -2,17 +2,15 @@ from functools import partial from importlib import import_module -from typing import Any, Dict, Optional +from typing import Any, Dict, Optional, Type, Union -from packaging import version -from pygments import __version__ as pygmentsversion from pygments import highlight from pygments.filters import ErrorToken from pygments.formatter import Formatter from pygments.formatters import HtmlFormatter, LatexFormatter from pygments.lexer import Lexer -from pygments.lexers import (CLexer, Python3Lexer, PythonConsoleLexer, PythonLexer, RstLexer, - TextLexer, get_lexer_by_name, guess_lexer) +from pygments.lexers import (CLexer, PythonConsoleLexer, PythonLexer, RstLexer, TextLexer, + get_lexer_by_name, guess_lexer) from pygments.style import Style from pygments.styles import get_style_by_name from pygments.util import ClassNotFound @@ -24,12 +22,10 @@ from sphinx.util import logging, texescape logger = logging.getLogger(__name__) lexers: Dict[str, Lexer] = {} -lexer_classes: Dict[str, Lexer] = { +lexer_classes: Dict[str, Union[Type[Lexer], 'partial[Lexer]']] = { 'none': partial(TextLexer, stripnl=False), 'python': partial(PythonLexer, stripnl=False), - 'python3': partial(Python3Lexer, stripnl=False), 'pycon': partial(PythonConsoleLexer, stripnl=False), - 'pycon3': partial(PythonConsoleLexer, python3=True, stripnl=False), 'rest': partial(RstLexer, stripnl=False), 'c': partial(CLexer, stripnl=False), } @@ -76,20 +72,6 @@ _LATEX_ADD_STYLES = r''' \protected\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+{\PYG@do{#2}}} \makeatother ''' -# fix extra space between lines when Pygments highlighting uses \fcolorbox -# add a {..} to limit \fboxsep scope, and force \fcolorbox use correct value -# cf pygments #1708 which makes this unneeded for Pygments > 2.7.4 -_LATEX_ADD_STYLES_FIXPYG = r''' -\makeatletter -% fix for Pygments <= 2.7.4 -\let\spx@original@fcolorbox\fcolorbox -\def\spx@fixpyg@fcolorbox{\fboxsep-\fboxrule\spx@original@fcolorbox} -\protected\def\PYG#1#2{\PYG@reset\PYG@toks#1+\relax+% - {\let\fcolorbox\spx@fixpyg@fcolorbox\PYG@do{#2}}} -\makeatother -''' -if version.parse(pygmentsversion).release <= (2, 7, 4): - _LATEX_ADD_STYLES += _LATEX_ADD_STYLES_FIXPYG class PygmentsBridge: @@ -132,17 +114,12 @@ class PygmentsBridge: opts = {} # find out which lexer to use - if lang in ('py', 'python'): + if lang in {'py', 'python', 'py3', 'python3', 'default'}: if source.startswith('>>>'): # interactive session lang = 'pycon' else: lang = 'python' - elif lang in ('py3', 'python3', 'default'): - if source.startswith('>>>'): - lang = 'pycon3' - else: - lang = 'python3' if lang in lexers: # just return custom lexers here (without installing raiseonerror filter) diff --git a/sphinx/writers/latex.py b/sphinx/writers/latex.py index e0b4ec03b..43f3910dd 100644 --- a/sphinx/writers/latex.py +++ b/sphinx/writers/latex.py @@ -1708,15 +1708,10 @@ class LaTeXTranslator(SphinxTranslator): opts = self.config.highlight_options.get(lang, {}) hlcode = self.highlighter.highlight_block( - node.astext(), lang, opts=opts, location=node) - # TODO: Use nowrap option once LaTeX formatter supports it - # https://github.com/pygments/pygments/pull/1343 - hlcode = hlcode.replace(r'\begin{Verbatim}[commandchars=\\\{\}]', - r'\sphinxcode{\sphinxupquote{%') - # get consistent trailer - hlcode = hlcode.rstrip()[:-15] # strip \n\end{Verbatim} - self.body.append(hlcode) - self.body.append('%' + CR + '}}') + node.astext(), lang, opts=opts, location=node, nowrap=True) + self.body.append(r'\sphinxcode{\sphinxupquote{%' + CR + + hlcode.rstrip() + '%' + CR # NoQA: W503 + + '}}') # NoQA: W503 raise nodes.SkipNode def depart_literal(self, node: Element) -> None: diff --git a/tests/test_build_html.py b/tests/test_build_html.py index 2b74690a1..8fd83b438 100644 --- a/tests/test_build_html.py +++ b/tests/test_build_html.py @@ -6,10 +6,8 @@ from itertools import chain, cycle from unittest.mock import ANY, call, patch import docutils -import pygments import pytest from html5lib import HTMLParser -from packaging import version from sphinx.builders.html import validate_html_extra_path, validate_html_static_path from sphinx.errors import ConfigError @@ -23,9 +21,6 @@ else: FIGURE_CAPTION = ".//figure/figcaption/p" -PYGMENTS_VERSION = version.parse(pygments.__version__).release - - ENV_WARNINGS = """\ %(root)s/autodoc_fodder.py:docstring of autodoc_fodder.MarkupError:\\d+: \ WARNING: Explicit markup ends without a blank line; unexpected unindent. @@ -1631,13 +1626,10 @@ def test_html_codeblock_linenos_style_table(app): app.build() content = (app.outdir / 'index.html').read_text(encoding='utf8') - if PYGMENTS_VERSION >= (2, 8): - assert ('<div class="linenodiv"><pre><span class="normal">1</span>\n' - '<span class="normal">2</span>\n' - '<span class="normal">3</span>\n' - '<span class="normal">4</span></pre></div>') in content - else: - assert '<div class="linenodiv"><pre>1\n2\n3\n4</pre></div>' in content + assert ('<div class="linenodiv"><pre><span class="normal">1</span>\n' + '<span class="normal">2</span>\n' + '<span class="normal">3</span>\n' + '<span class="normal">4</span></pre></div>') in content @pytest.mark.sphinx('html', testroot='reST-code-block', @@ -1646,10 +1638,7 @@ def test_html_codeblock_linenos_style_inline(app): app.build() content = (app.outdir / 'index.html').read_text(encoding='utf8') - if PYGMENTS_VERSION > (2, 7): - assert '<span class="linenos">1</span>' in content - else: - assert '<span class="lineno">1 </span>' in content + assert '<span class="linenos">1</span>' in content @pytest.mark.sphinx('html', testroot='highlight_options') diff --git a/tests/test_intl.py b/tests/test_intl.py index 1366b0a06..796d95bcc 100644 --- a/tests/test_intl.py +++ b/tests/test_intl.py @@ -7,7 +7,6 @@ import os import re import docutils -import pygments import pytest from babel.messages import mofile, pofile from babel.messages.catalog import Catalog @@ -25,8 +24,6 @@ sphinx_intl = pytest.mark.sphinx( }, ) -pygments_version = tuple(int(v) for v in pygments.__version__.split('.')) - def read_po(pathname): with pathname.open(encoding='utf-8') as f: @@ -1099,13 +1096,9 @@ def test_additional_targets_should_not_be_translated(app): assert_count(expected_expr, result, 1) # C code block with lang should not be translated but be *C* highlighted - if pygments_version < (2, 10, 0): - expected_expr = ("""<span class="cp">#include</span> """ - """<span class="cpf"><stdio.h></span>""") - else: - expected_expr = ("""<span class="cp">#include</span>""" - """<span class="w"> </span>""" - """<span class="cpf"><stdio.h></span>""") + expected_expr = ("""<span class="cp">#include</span>""" + """<span class="w"> </span>""" + """<span class="cpf"><stdio.h></span>""") assert_count(expected_expr, result, 1) # literal block in list item should not be translated @@ -1182,13 +1175,9 @@ def test_additional_targets_should_be_translated(app): assert_count(expected_expr, result, 1) # C code block with lang should be translated and be *C* highlighted - if pygments_version < (2, 10, 0): - expected_expr = ("""<span class="cp">#include</span> """ - """<span class="cpf"><STDIO.H></span>""") - else: - expected_expr = ("""<span class="cp">#include</span>""" - """<span class="w"> </span>""" - """<span class="cpf"><STDIO.H></span>""") + expected_expr = ("""<span class="cp">#include</span>""" + """<span class="w"> </span>""" + """<span class="cpf"><STDIO.H></span>""") assert_count(expected_expr, result, 1) # literal block in list item should be translated |