https://github.com/python/cpython/commit/7431c3799efbd06ed03ee70b64420f45e83b3667
commit: 7431c3799efbd06ed03ee70b64420f45e83b3667
branch: main
author: Adam Turner <9087854+aa-tur...@users.noreply.github.com>
committer: AA-Turner <9087854+aa-tur...@users.noreply.github.com>
date: 2024-07-18T18:38:29Z
summary:
GH-121970: Combine custom Pygments lexers into a package (#121976)
Co-authored-by: Hugo van Kemenade <1324225+hug...@users.noreply.github.com>
files:
A Doc/tools/extensions/lexers/__init__.py
A Doc/tools/extensions/lexers/asdl_lexer.py
A Doc/tools/extensions/lexers/peg_lexer.py
D Doc/tools/extensions/asdl_highlight.py
D Doc/tools/extensions/peg_highlight.py
M Doc/conf.py
diff --git a/Doc/conf.py b/Doc/conf.py
index 6ab8e8ccbdfd96..7f925dc7a8eb26 100644
--- a/Doc/conf.py
+++ b/Doc/conf.py
@@ -18,11 +18,10 @@
# ---------------------
extensions = [
- 'asdl_highlight',
'c_annotations',
'escape4chm',
'glossary_search',
- 'peg_highlight',
+ 'lexers',
'pyspecific',
'sphinx.ext.coverage',
'sphinx.ext.doctest',
diff --git a/Doc/tools/extensions/lexers/__init__.py
b/Doc/tools/extensions/lexers/__init__.py
new file mode 100644
index 00000000000000..e12ac5be8139cc
--- /dev/null
+++ b/Doc/tools/extensions/lexers/__init__.py
@@ -0,0 +1,15 @@
+from .asdl_lexer import ASDLLexer
+from .peg_lexer import PEGLexer
+
+
+def setup(app):
+ # Used for highlighting Parser/Python.asdl in library/ast.rst
+ app.add_lexer("asdl", ASDLLexer)
+ # Used for highlighting Grammar/python.gram in reference/grammar.rst
+ app.add_lexer("peg", PEGLexer)
+
+ return {
+ "version": "1.0",
+ "parallel_read_safe": True,
+ "parallel_write_safe": True,
+ }
diff --git a/Doc/tools/extensions/asdl_highlight.py
b/Doc/tools/extensions/lexers/asdl_lexer.py
similarity index 62%
rename from Doc/tools/extensions/asdl_highlight.py
rename to Doc/tools/extensions/lexers/asdl_lexer.py
index 42863a4b3bcd6a..2cea058566ad85 100644
--- a/Doc/tools/extensions/asdl_highlight.py
+++ b/Doc/tools/extensions/lexers/asdl_lexer.py
@@ -1,15 +1,6 @@
-import sys
-from pathlib import Path
+from pygments.lexer import RegexLexer, bygroups, include
+from pygments.token import Comment, Keyword, Name, Operator, Punctuation, Text
-CPYTHON_ROOT = Path(__file__).resolve().parent.parent.parent.parent
-sys.path.append(str(CPYTHON_ROOT / "Parser"))
-
-from pygments.lexer import RegexLexer, bygroups, include, words
-from pygments.token import (Comment, Keyword, Name, Operator,
- Punctuation, Text)
-
-from asdl import builtin_types
-from sphinx.highlighting import lexers
class ASDLLexer(RegexLexer):
name = "ASDL"
@@ -34,7 +25,10 @@ class ASDLLexer(RegexLexer):
r"(\w+)(\*\s|\?\s|\s)(\w+)",
bygroups(Name.Builtin.Pseudo, Operator, Name),
),
- (words(builtin_types), Name.Builtin),
+ # Keep in line with ``builtin_types`` from Parser/asdl.py.
+ # ASDL's 4 builtin types are
+ # constant, identifier, int, string
+ ('constant|identifier|int|string', Name.Builtin),
(r"attributes", Name.Builtin),
(
_name + _text_ws + "(=)",
@@ -46,8 +40,3 @@ class ASDLLexer(RegexLexer):
(r".", Text),
],
}
-
-
-def setup(app):
- lexers["asdl"] = ASDLLexer()
- return {'version': '1.0', 'parallel_read_safe': True}
diff --git a/Doc/tools/extensions/peg_highlight.py
b/Doc/tools/extensions/lexers/peg_lexer.py
similarity index 94%
rename from Doc/tools/extensions/peg_highlight.py
rename to Doc/tools/extensions/lexers/peg_lexer.py
index 4bdc2ee1861334..827af205583f61 100644
--- a/Doc/tools/extensions/peg_highlight.py
+++ b/Doc/tools/extensions/lexers/peg_lexer.py
@@ -1,8 +1,6 @@
from pygments.lexer import RegexLexer, bygroups, include
from pygments.token import Comment, Keyword, Name, Operator, Punctuation, Text
-from sphinx.highlighting import lexers
-
class PEGLexer(RegexLexer):
"""Pygments Lexer for PEG grammar (.gram) files
@@ -79,8 +77,3 @@ class PEGLexer(RegexLexer):
(r".", Text),
],
}
-
-
-def setup(app):
- lexers["peg"] = PEGLexer()
- return {"version": "1.0", "parallel_read_safe": True}
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
