From 14c3385268c5763ed9bb0f543b290b2e1f4bdf37 Mon Sep 17 00:00:00 2001
From: Chris Sewell <chrisj_sewell@hotmail.com>
Date: Sun, 2 Jan 2022 15:33:51 +0100
Subject: [PATCH] =?UTF-8?q?=F0=9F=91=8C=20IMPROVE:=20`DocutilsRenderer.cre?=
 =?UTF-8?q?ate=5Fhighlighted=5Fcode=5Fblock`=20(#488)?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Minor improvement, to handle null lexer_name,
and allow for the use of an alternative node class.
---
 myst_parser/docutils_renderer.py                | 17 ++++++++---------
 .../fixtures/docutil_syntax_elements.md         |  2 +-
 2 files changed, 9 insertions(+), 10 deletions(-)

diff --git a/myst_parser/docutils_renderer.py b/myst_parser/docutils_renderer.py
index d2478444..642fc3ac 100644
--- a/myst_parser/docutils_renderer.py
+++ b/myst_parser/docutils_renderer.py
@@ -16,6 +16,7 @@
     Optional,
     Sequence,
     Tuple,
+    Type,
     Union,
     cast,
 )
@@ -432,12 +433,13 @@ def render_code_inline(self, token: SyntaxTreeNode) -> None:
     def create_highlighted_code_block(
         self,
         text: str,
-        lexer_name: str,
+        lexer_name: Optional[str],
         number_lines: bool = False,
         lineno_start: int = 1,
         source: Optional[str] = None,
         line: Optional[int] = None,
-    ) -> nodes.literal_block:
+        node_cls: Type[nodes.Element] = nodes.literal_block,
+    ) -> nodes.Element:
         """Create a literal block with syntax highlighting.
 
         This mimics the behaviour of the `code-block` directive.
@@ -450,19 +452,19 @@ def create_highlighted_code_block(
         Note, this function does not add the literal block to the document.
         """
         if self.sphinx_env is not None:
-            node = nodes.literal_block(text, text, language=lexer_name)
+            node = node_cls(text, text, language=lexer_name or "none")
             if number_lines:
                 node["linenos"] = True
                 if lineno_start != 1:
                     node["highlight_args"] = {"linenostart": lineno_start}
         else:
-            node = nodes.literal_block(
+            node = node_cls(
                 text, classes=["code"] + ([lexer_name] if lexer_name else [])
             )
             try:
                 lex_tokens = Lexer(
                     text,
-                    lexer_name,
+                    lexer_name or "",
                     "short"
                     if self.config.get("myst_highlight_code_blocks", True)
                     else "none",
@@ -476,7 +478,7 @@ def create_highlighted_code_block(
                         if value is not None
                     },
                 )
-                lex_tokens = Lexer(text, lexer_name, "none")
+                lex_tokens = Lexer(text, lexer_name or "", "none")
 
             if number_lines:
                 lex_tokens = NumberLines(
@@ -497,10 +499,7 @@ def create_highlighted_code_block(
         return node
 
     def render_code_block(self, token: SyntaxTreeNode) -> None:
-        # this should never have a language, since it is just indented text, however,
-        # creating a literal_block with no language will raise a warning in sphinx
         lexer = token.info.split()[0] if token.info else None
-        lexer = lexer or "none"
         node = self.create_highlighted_code_block(
             token.content,
             lexer,
diff --git a/tests/test_renderers/fixtures/docutil_syntax_elements.md b/tests/test_renderers/fixtures/docutil_syntax_elements.md
index 8fd46488..91add67c 100644
--- a/tests/test_renderers/fixtures/docutil_syntax_elements.md
+++ b/tests/test_renderers/fixtures/docutil_syntax_elements.md
@@ -127,7 +127,7 @@ Block Code:
     foo
 .
 <document source="notset">
-    <literal_block classes="code none" xml:space="preserve">
+    <literal_block classes="code" xml:space="preserve">
         foo
 .