Refactor

Author: mondeja

src/mkdocs_include_markdown_plugin/event.py

@@ -28,6 +28,11 @@
 )
 from mkdocs_include_markdown_plugin.files_watcher import FilesWatcher
 from mkdocs_include_markdown_plugin.logger import logger
+from mkdocs_include_markdown_plugin.placeholders import (
+    escape_placeholders,
+    save_placeholder,
+    unescape_placeholders,
+)
 
 
 if TYPE_CHECKING:  # pragma: no cover
@@ -46,40 +51,6 @@
     )
 
 
-# Placeholders (taken from Python-Markdown)
-STX = '\u0002'
-''' "Start of Text" marker for placeholder templates. '''
-ETX = '\u0003'
-''' "End of Text" marker for placeholder templates. '''
-INLINE_PLACEHOLDER_PREFIX = f'{STX}klzzwxh:'
-
-
-def build_placeholder(num: int) -> str:
-    """Return a placeholder."""
-    return f'{INLINE_PLACEHOLDER_PREFIX}{num}{ETX}'
-
-
-def escape_placeholders(text: str) -> str:
-    """Escape placeholders in the given text."""
-    return text.replace(STX, f'\\{STX}').replace(ETX, f'\\{ETX}')
-
-
-def unescape_placeholders(text: str) -> str:
-    """Unescape placeholders in the given text."""
-    return text.replace(f'\\{STX}', STX).replace(f'\\{ETX}', ETX)
-
-
-def save_placeholder(
-        placeholders_contents: list[tuple[str, str]],
-        text_to_include: str,
-) -> str:
-    """Save the included text and return the placeholder."""
-    inclusion_index = len(placeholders_contents)
-    placeholder = build_placeholder(inclusion_index)
-    placeholders_contents.append((placeholder, text_to_include))
-    return placeholder
-
-
 @dataclass
 class Settings:  # noqa: D101
     exclude: list[str] | None

src/mkdocs_include_markdown_plugin/placeholders.py

@@ -0,0 +1,37 @@
+"""Module for placeholders processing."""
+
+# Placeholders (taken from Python-Markdown)
+from __future__ import annotations
+
+
+STX = '\u0002'
+''' "Start of Text" marker for placeholder templates. '''
+ETX = '\u0003'
+''' "End of Text" marker for placeholder templates. '''
+INLINE_PLACEHOLDER_PREFIX = f'{STX}klzzwxh:'
+
+
+def build_placeholder(num: int) -> str:
+    """Return a placeholder."""
+    return f'{INLINE_PLACEHOLDER_PREFIX}{num}{ETX}'
+
+
+def escape_placeholders(text: str) -> str:
+    """Escape placeholders in the given text."""
+    return text.replace(STX, f'\\{STX}').replace(ETX, f'\\{ETX}')
+
+
+def unescape_placeholders(text: str) -> str:
+    """Unescape placeholders in the given text."""
+    return text.replace(f'\\{STX}', STX).replace(f'\\{ETX}', ETX)
+
+
+def save_placeholder(
+        placeholders_contents: list[tuple[str, str]],
+        text_to_include: str,
+) -> str:
+    """Save the included text and return the placeholder."""
+    inclusion_index = len(placeholders_contents)
+    placeholder = build_placeholder(inclusion_index)
+    placeholders_contents.append((placeholder, text_to_include))
+    return placeholder

tests/test_unit/test_include_markdown.py

@@ -2,10 +2,8 @@
 
 import pytest
 
-from mkdocs_include_markdown_plugin.event import (
-    build_placeholder,
-    on_page_markdown,
-)
+from mkdocs_include_markdown_plugin.event import on_page_markdown
+from mkdocs_include_markdown_plugin.placeholders import build_placeholder
 
 
 @pytest.mark.parametrize(