Fix lint issues

Signed-off-by: Liran Funaro <liran.funaro@gmail.com>

Author: liran-funaro

sphinx_markdown_builder/contexts.py

@@ -383,15 +383,15 @@ def make(self):
 _ContextT = TypeVar("_ContextT", bound=SubContext)
 
 Translator = Callable[[Any, Any], Dict[str, Any]]
-DEFAULT_TRANSLATOR: Translator = lambda _node, _elem: {}
+default_translator: Translator = lambda _node, _elem: {}
 
 
 class PushContext(Generic[_ContextT]):  # pylint: disable=too-few-public-methods
     def __init__(
         self,
         ctx: Type[_ContextT],
         *args,
-        translator: Translator = DEFAULT_TRANSLATOR,
+        translator: Translator = default_translator,
         **kwargs,
     ):
         self.ctx = ctx
@@ -405,10 +405,10 @@ def create(self, node, element_key) -> _ContextT:
         return self.ctx(*self.args, **kwargs)
 
 
-ItalicContext = PushContext(WrappedContext, "*")  # _ is more restrictive
-StrongContext = PushContext(WrappedContext, "**")  # _ is more restrictive
-SubscriptContext = PushContext(WrappedContext, "<sub>", "</sub>")
-DocInfoContext = PushContext(
+ITALIC_CONTEXT = PushContext(WrappedContext, "*")  # _ is more restrictive
+STRONG_CONTEXT = PushContext(WrappedContext, "**")  # _ is more restrictive
+SUBSCRIPT_CONTEXT = PushContext(WrappedContext, "<sub>", "</sub>")
+DOC_INFO_CONTEXT = PushContext(
     MetaContext,
     translator=lambda _node, elem: {"name": f"{elem}: "},
 )

sphinx_markdown_builder/translator.py

@@ -34,16 +34,16 @@
 from sphinx_markdown_builder.contexts import (
     CommaSeparatedContext,
     ContextStatus,
-    DocInfoContext,
+    DOC_INFO_CONTEXT,
     IndentContext,
-    ItalicContext,
+    ITALIC_CONTEXT,
     ListMarker,
     MetaContext,
     PushContext,
-    StrongContext,
+    STRONG_CONTEXT,
     SubContext,
     SubContextParams,
-    SubscriptContext,
+    SUBSCRIPT_CONTEXT,
     TableContext,
     TitleContext,
     UniqueString,
@@ -63,18 +63,18 @@
 # Defines context items, skip, or None (keep processing sub-tree).
 PREDEFINED_ELEMENTS: Dict[str, Union[PushContext, SKIP, None]] = dict(  # pylint: disable=use-dict-literal
     # Doctree elements for which Markdown element is <prefix><content><suffix>
-    emphasis=ItalicContext,
-    strong=StrongContext,
-    subscript=SubscriptContext,
-    superscript=SubscriptContext,
-    desc_annotation=ItalicContext,
-    literal_strong=StrongContext,
-    literal_emphasis=ItalicContext,
+    emphasis=ITALIC_CONTEXT,
+    strong=STRONG_CONTEXT,
+    subscript=SUBSCRIPT_CONTEXT,
+    superscript=SUBSCRIPT_CONTEXT,
+    desc_annotation=ITALIC_CONTEXT,
+    literal_strong=STRONG_CONTEXT,
+    literal_emphasis=ITALIC_CONTEXT,
     field_name=PushContext(WrappedContext, "**", ":**"),  # e.g 'returns', 'parameters'
     # Doc info elements
-    docinfo=DocInfoContext,
-    docinfo_item=DocInfoContext,
-    **dict.fromkeys(DOC_INFO_FIELDS, DocInfoContext),
+    docinfo=DOC_INFO_CONTEXT,
+    docinfo_item=DOC_INFO_CONTEXT,
+    **dict.fromkeys(DOC_INFO_FIELDS, DOC_INFO_CONTEXT),
     authors=None,  # not used: visit_author is called anyway for each author.
     # Doctree elements to skip subtree
     autosummary_toc=SKIP,

tests/test_builder.py

@@ -1,6 +1,7 @@
 """
 Integration tests for the markdown builder
 """
+
 import os
 import shutil
 import stat
@@ -98,6 +99,15 @@ def test_builder_access_issue(flags: Iterable[str], build_path: str):
         _chmod_output(build_path, lambda mode: mode | flag)
 
 
+def _has_suffix_in_path(path: str, suffix: str) -> bool:
+    """Checks that at least one file with the given suffix exists"""
+    for root, dirs, files in os.walk(path):
+        for file in files:
+            if file.endswith(suffix):
+                return True
+    return False
+
+
 def test_custom_file_suffix():
     """Test that markdown_file_suffix configuration generates files with correct suffix"""
     build_path = os.path.join(BUILD_PATH, "test_suffix")
@@ -112,16 +122,7 @@ def test_custom_file_suffix():
     assert os.path.exists(markdown_dir), f"Markdown output directory not found: {markdown_dir}"
 
     # Check that at least one file with the custom suffix exists
-    found_custom_suffix = False
-    for root, dirs, files in os.walk(markdown_dir):
-        for file in files:
-            if file.endswith(suffix):
-                found_custom_suffix = True
-                break
-        if found_custom_suffix:
-            break
-
-    assert found_custom_suffix, f"No files with suffix '{suffix}' found in {markdown_dir}"
+    assert _has_suffix_in_path(markdown_dir, suffix), f"No files with suffix '{suffix}' found in {markdown_dir}"
 
     # Clean up
     _rm_build_path(build_path)