mkdocs-include-markdown-plugin 7.1.6__tar.gz → 7.1.8__tar.gz

{mkdocs_include_markdown_plugin-7.1.6 → mkdocs_include_markdown_plugin-7.1.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocs-include-markdown-plugin
-Version: 7.1.6
+Version: 7.1.8
 Summary: Mkdocs Markdown includer plugin.
 Project-URL: Source, https://github.com/mondeja/mkdocs-include-markdown-plugin
 Project-URL: Documentation, https://github.com/mondeja/mkdocs-include-markdown-plugin#documentation

{mkdocs_include_markdown_plugin-7.1.6 → mkdocs_include_markdown_plugin-7.1.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-include-markdown-plugin"
-version = "7.1.6"
+version = "7.1.8"
 description = "Mkdocs Markdown includer plugin."
 readme = "README.md"
 license = "Apache-2.0"

{mkdocs_include_markdown_plugin-7.1.6 → mkdocs_include_markdown_plugin-7.1.8}/src/mkdocs_include_markdown_plugin/cache.py

@@ -78,7 +78,7 @@ def get_cache_directory(cache_dir: str) -> str | None:
         return None
 
     try:
-        from platformdirs import user_data_dir
+        from platformdirs import user_data_dir  # noqa: PLC0415
     except ImportError:  # pragma: no cover
         return None
     else:

{mkdocs_include_markdown_plugin-7.1.6 → mkdocs_include_markdown_plugin-7.1.8}/src/mkdocs_include_markdown_plugin/directive.py

@@ -208,7 +208,7 @@ def parse_filename_argument(
 
 def parse_string_argument(match: re.Match[str] | None) -> str | None:
     """Return the string argument matched by ``match``."""
-    if match is None:
+    if match is None:  # pragma: no cover
         return None
     value = match[1]
     if value is None:

{mkdocs_include_markdown_plugin-7.1.6 → mkdocs_include_markdown_plugin-7.1.8}/src/mkdocs_include_markdown_plugin/event.py

@@ -28,10 +28,15 @@ from mkdocs_include_markdown_plugin.directive import (
 )
 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
-    from typing import Literal, TypedDict
+    from typing import TypedDict
 
     from mkdocs.structure.pages import Page
 
@@ -46,23 +51,6 @@ if TYPE_CHECKING:  # pragma: no cover
     )
 
 
-# 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,
-        directive: Literal['include', 'include-markdown'],
-) -> str:
-    """Return a placeholder."""
-    directive_prefix = 'im' if directive == 'include-markdown' else 'i'
-    return f'{INLINE_PLACEHOLDER_PREFIX}{directive_prefix}{num}{ETX}'
-
-
 @dataclass
 class Settings:  # noqa: D101
     exclude: list[str] | None
@@ -98,8 +86,8 @@ def get_file_content(  # noqa: PLR0913, PLR0915
     else:
         settings_ignore_paths = []
 
-    new_found_include_contents: list[tuple[str, str]] = []
-    new_found_include_markdown_contents: list[tuple[str, str]] = []
+    markdown = escape_placeholders(markdown)
+    placeholders_contents: list[tuple[str, str]] = []
 
     def found_include_tag(  # noqa: PLR0912, PLR0915
             match: re.Match[str],
@@ -311,11 +299,7 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     f' {readable_files_to_include}',
                 )
 
-        nonlocal new_found_include_contents
-        include_index = len(new_found_include_contents)
-        placeholder = build_placeholder(include_index, 'include')
-        new_found_include_contents.append((placeholder, text_to_include))
-        return placeholder
+        return save_placeholder(placeholders_contents, text_to_include)
 
     def found_include_markdown_tag(  # noqa: PLR0912, PLR0915
             match: re.Match[str],
@@ -436,27 +420,30 @@ def get_file_content(  # noqa: PLR0913, PLR0915
             offset_match = ARGUMENT_REGEXES['heading-offset']().search(
                 arguments_string,
             )
-            if offset_match:
-                offset_raw_value = offset_match[1]
-                if offset_raw_value == '':
-                    location = process.file_lineno_message(
-                        page_src_path, docs_dir, directive_lineno(),
-                    )
-                    raise PluginError(
-                        "Invalid empty 'heading-offset' argument in"
-                        f" 'include-markdown' directive at {location}",
-                    )
-                try:
-                    offset = int(offset_raw_value)
-                except ValueError:
-                    location = process.file_lineno_message(
-                        page_src_path, docs_dir, directive_lineno(),
-                    )
-                    raise PluginError(
-                        f"Invalid 'heading-offset' argument"
-                        f" '{offset_raw_value}' in 'include-markdown'"
-                        f" directive at {location}",
-                    ) from None
+            try:
+                # Here None[1] would raise a TypeError
+                offset_raw_value = offset_match[1]  # type: ignore
+            except (IndexError, TypeError):  # pragma: no cover
+                offset_raw_value = ''
+            if offset_raw_value == '':
+                location = process.file_lineno_message(
+                    page_src_path, docs_dir, directive_lineno(),
+                )
+                raise PluginError(
+                    "Invalid empty 'heading-offset' argument in"
+                    f" 'include-markdown' directive at {location}",
+                )
+            try:
+                offset = int(offset_raw_value)
+            except ValueError:
+                location = process.file_lineno_message(
+                    page_src_path, docs_dir, directive_lineno(),
+                )
+                raise PluginError(
+                    f"Invalid 'heading-offset' argument"
+                    f" '{offset_raw_value}' in 'include-markdown'"
+                    f" directive at {location}",
+                ) from None
 
         bool_options, invalid_bool_args = parse_bool_options(
             [
@@ -604,15 +591,7 @@ def get_file_content(  # noqa: PLR0913, PLR0915
                     f' {readable_files_to_include}',
                 )
 
-        nonlocal new_found_include_markdown_contents
-        markdown_include_index = len(new_found_include_markdown_contents)
-        placeholder = build_placeholder(
-            markdown_include_index, 'include-markdown',
-        )
-        new_found_include_markdown_contents.append(
-            (placeholder, text_to_include),
-        )
-        return placeholder
+        return save_placeholder(placeholders_contents, text_to_include)
 
     # Replace contents by placeholders
     markdown = tags['include-markdown'].sub(
@@ -625,11 +604,9 @@ def get_file_content(  # noqa: PLR0913, PLR0915
     )
 
     # Replace placeholders by contents
-    for placeholder, text in new_found_include_contents:
-        markdown = markdown.replace(placeholder, text, 1)
-    for placeholder, text in new_found_include_markdown_contents:
+    for placeholder, text in placeholders_contents:
         markdown = markdown.replace(placeholder, text, 1)
-    return markdown
+    return unescape_placeholders(markdown)
 
 
 def on_page_markdown(

mkdocs_include_markdown_plugin-7.1.8/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

{mkdocs_include_markdown_plugin-7.1.6 → mkdocs_include_markdown_plugin-7.1.8}/src/mkdocs_include_markdown_plugin/process.py

@@ -33,7 +33,7 @@ if TYPE_CHECKING:  # pragma: no cover
 # previous to Python3.11. Also, these nested brackets can be recursive in the
 # Perl implementation but this doesn't seem possible in Python, the current
 # implementation only reaches two levels.
-MARKDOWN_LINK_REGEX = re.compile(  # noqa: DUO138
+MARKDOWN_LINK_REGEX = re.compile(
     r'''
         (                 # wrap whole match in $1
           (?<!!)          # don't match images - negative lookbehind
@@ -427,17 +427,19 @@ def filter_inclusions(  # noqa: PLR0912
 def _transform_negative_offset_func_factory(
         offset: int,
 ) -> Callable[[str], str]:
-    heading_prefix = '#' * abs(offset)
+    abs_offset = abs(offset)
 
     def transform(line: str) -> str:
         try:
             if line[0] != '#':
                 return line
         except IndexError:  # pragma: no cover
+            # Note for pragma: all lines include a newline
+            # so this exception is never raised in tests.
             return line
-        if line.startswith(heading_prefix):
-            return heading_prefix + line.lstrip('#')
-        return '#' + line.lstrip('#')
+        stripped_line = line.lstrip('#')
+        new_n_headings = max(len(line) - len(stripped_line) - abs_offset, 1)
+        return '#' * new_n_headings + stripped_line
 
     return transform
 
@@ -449,11 +451,11 @@ def _transform_positive_offset_func_factory(
 
     def transform(line: str) -> str:
         try:
-            prefix = line[0]
+            if line[0] != '#':
+                return line
         except IndexError:  # pragma: no cover
             return line
-        else:
-            return heading_prefix + line if prefix == '#' else line
+        return heading_prefix + line
 
     return transform
 
@@ -608,7 +610,7 @@ def read_url(
         encoding: str = 'utf-8',
 ) -> Any:
     """Read an HTTP location and return its content."""
-    from urllib.request import Request, urlopen
+    from urllib.request import Request, urlopen  # noqa: PLC0415
 
     if http_cache is not None:
         cached_content = http_cache.get_(url, encoding)