mkdocs-include-markdown-plugin 7.0.0__tar.gz → 7.0.1__tar.gz

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/.gitignore

@@ -17,5 +17,6 @@ venv*/
 .mypy_cache/
 *.so
 .prettier-cache
+/*.html
 
 site/

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocs-include-markdown-plugin
-Version: 7.0.0
+Version: 7.0.1
 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
@@ -9,8 +9,7 @@ Project-URL: Changelog, https://github.com/mondeja/mkdocs-include-markdown-plugi
 Author: Joe Rickerby
 Author-email: Álvaro Mondéjar Rubio <mondejar1994@gmail.com>
 Maintainer-email: Álvaro Mondéjar Rubio <mondejar1994@gmail.com>
-License-Expression: Apache-2.0
-License-File: LICENSE
+License: Apache-2.0
 Keywords: includer,markdown,mkdocs,plugin
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/pyproject.toml

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

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/src/mkdocs_include_markdown_plugin/cache.py

@@ -2,7 +2,6 @@
 
 from __future__ import annotations
 
-import base64
 import hashlib
 import os
 import time
@@ -29,15 +28,13 @@ class Cache:
 
     def get_creation_time_from_fpath(self, fpath: str) -> int:
         """Get creation time of an entry in the cache given its path."""
-        with open(fpath, encoding='utf-8') as f:
+        with open(fpath, 'rb') as f:
             return int(f.readline())
 
     @classmethod
     def generate_unique_key_from_url(cls, url: str) -> str:
         """Generate a unique key from an URL."""
-        return base64.urlsafe_b64encode(
-            hashlib.sha3_512(url.encode()).digest(),
-        ).decode('utf-8')
+        return hashlib.blake2b(url.encode(), digest_size=16).digest().hex()
 
     def read_file(self, fpath: str, encoding: str = 'utf-8') -> str:  # noqa: D102
         with open(fpath, encoding=encoding) as f:
@@ -56,9 +53,10 @@ class Cache:
     def set_(self, url: str, value: str, encoding: str = 'utf-8') -> None:  # noqa: D102
         key = self.generate_unique_key_from_url(url)
         fpath = os.path.join(self.cache_dir, key)
-        with open(fpath, 'w', encoding=encoding) as f:
-            f.write(f'{int(time.time())}\n')
-            f.write(value)
+        with open(fpath, 'wb') as fp:
+            now = f'{int(time.time())}\n'
+            fp.write(now.encode(encoding))
+            fp.write(value.encode(encoding))
 
     def clean(self) -> None:
         """Clean expired entries from the cache."""

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/src/mkdocs_include_markdown_plugin/directive.py

@@ -21,7 +21,7 @@ class DirectiveBoolArgument:  # noqa: D101
     regex: re.Pattern[str]
 
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from typing import Literal, TypedDict
 
     DirectiveBoolArgumentsDict = dict[str, DirectiveBoolArgument]
@@ -112,6 +112,10 @@ INCLUDE_DIRECTIVE_ARGS = {
 
 INCLUDE_MARKDOWN_DIRECTIVE_ARGS = set(ARGUMENT_REGEXES)
 
+WARN_INVALID_DIRECTIVE_ARGS_REGEX = re.compile(
+    rf'[\w-]*=[{RE_ESCAPED_PUNCTUATION}\w]*',
+)
+
 
 def warn_invalid_directive_arguments(
     arguments_string: str,
@@ -121,12 +125,14 @@ def warn_invalid_directive_arguments(
     docs_dir: str,
 ) -> None:
     """Warns about the invalid arguments passed to a directive."""
-    arg_re = re.compile(rf'[\w-]*=[{RE_ESCAPED_PUNCTUATION}\w]*')
     valid_args = (
         INCLUDE_DIRECTIVE_ARGS if directive == 'include'
         else INCLUDE_MARKDOWN_DIRECTIVE_ARGS
     )
-    for arg_value in re.findall(arg_re, arguments_string):
+    for arg_value in re.findall(
+        WARN_INVALID_DIRECTIVE_ARGS_REGEX,
+        arguments_string,
+    ):
         if arg_value.split('=', 1)[0] not in valid_args:
             location = process.file_lineno_message(
                 page_src_path, docs_dir, directive_lineno,
@@ -174,9 +180,9 @@ def create_include_tag(
     INCLUDE_TAG_RE by the effective tag.
     """
     return re.compile(
-        INCLUDE_TAG_RE.replace(' include', f' {tag}').replace(
-            '$OPENING_TAG', re.escape(opening_tag),
-        ).replace('$CLOSING_TAG', re.escape(closing_tag)),
+        INCLUDE_TAG_RE.replace(' include', f' {tag}', 1).replace(
+            '$OPENING_TAG', re.escape(opening_tag), 1,
+        ).replace('$CLOSING_TAG', re.escape(closing_tag), 1),
         flags=re.VERBOSE | re.DOTALL,
     )
 
@@ -209,7 +215,7 @@ def parse_bool_options(
     return bool_options, invalid_args
 
 
-def resolve_file_paths_to_include(
+def resolve_file_paths_to_include(  # noqa: PLR0912
     include_string: str,
     includer_page_src_path: str | None,
     docs_dir: str,
@@ -229,13 +235,11 @@ def resolve_file_paths_to_include(
             return process.filter_paths(
                 [fpath], ignore_paths,
             ), False
+
         return process.filter_paths(
-            glob.iglob(
-                os.path.normpath(include_string),
-                flags=GLOB_FLAGS,
-            ),
-            ignore_paths,
-        ), False
+            [include_string] if os.path.isfile(include_string)
+            else glob.iglob(include_string, flags=GLOB_FLAGS),
+            ignore_paths), False
 
     if process.is_relative_path(include_string):
         if includer_page_src_path is None:  # pragma: no cover
@@ -247,29 +251,33 @@ def resolve_file_paths_to_include(
         root_dir = os.path.abspath(
             os.path.dirname(includer_page_src_path),
         )
-        return process.filter_paths(
-            (
-                os.path.normpath(os.path.join(root_dir, fp))
-                for fp in glob.iglob(
-                    include_string,
-                    flags=GLOB_FLAGS,
-                    root_dir=root_dir,
-                )
-            ), ignore_paths,
-        ), False
-
-    # relative to docs_dir
-    return process.filter_paths(
-        (
-            os.path.normpath(os.path.join(docs_dir, fp))
+        paths = []
+        include_path = os.path.join(root_dir, include_string)
+        if os.path.isfile(include_path):
+            paths.append(include_path)
+        else:
             for fp in glob.iglob(
                 include_string,
                 flags=GLOB_FLAGS,
-                root_dir=docs_dir,
-            )
-        ),
-        ignore_paths,
-    ), False
+                root_dir=root_dir,
+            ):
+                paths.append(os.path.join(root_dir, fp))
+        return process.filter_paths(paths, ignore_paths), False
+
+    # relative to docs_dir
+    paths = []
+    root_dir = docs_dir
+    include_path = os.path.join(root_dir, include_string)
+    if os.path.isfile(include_path):
+        paths.append(include_path)
+    else:
+        for fp in glob.iglob(
+            include_string,
+            flags=GLOB_FLAGS,
+            root_dir=root_dir,
+        ):
+            paths.append(os.path.join(root_dir, fp))
+    return process.filter_paths(paths, ignore_paths), False
 
 
 def resolve_file_paths_to_exclude(

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/src/mkdocs_include_markdown_plugin/event.py

@@ -28,7 +28,7 @@ from mkdocs_include_markdown_plugin.files_watcher import FilesWatcher
 from mkdocs_include_markdown_plugin.logger import logger
 
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from typing import Literal, TypedDict
 
     from mkdocs.structure.pages import Page
@@ -630,8 +630,8 @@ def on_page_markdown(
         page.file.abs_src_path,
         docs_dir,
         {
-            'include': plugin._include_tag,
-            'include-markdown': plugin._include_markdown_tag,
+            'include': plugin._include_tag(),
+            'include-markdown': plugin._include_markdown_tag(),
         },
         {
             'encoding': config.encoding,

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/src/mkdocs_include_markdown_plugin/plugin.py

@@ -11,7 +11,7 @@ from mkdocs.livereload import LiveReloadServer
 from mkdocs.plugins import BasePlugin, event_priority
 
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     import re
 
     from mkdocs.config.defaults import MkDocsConfig
@@ -46,14 +46,12 @@ class IncludeMarkdownPlugin(BasePlugin[PluginConfig]):
 
         return config
 
-    @cached_property
     def _include_tag(self) -> re.Pattern[str]:
         return create_include_tag(
             self.config.opening_tag,
             self.config.closing_tag,
         )
 
-    @cached_property
     def _include_markdown_tag(self) -> re.Pattern[str]:
         return create_include_tag(
             self.config.opening_tag,

{mkdocs_include_markdown_plugin-7.0.0 → mkdocs_include_markdown_plugin-7.0.1}/src/mkdocs_include_markdown_plugin/process.py

@@ -12,7 +12,7 @@ from urllib.parse import urlparse, urlunparse
 from urllib.request import Request, urlopen
 
 
-if TYPE_CHECKING:
+if TYPE_CHECKING:  # pragma: no cover
     from typing import Any
 
     from mkdocs_include_markdown_plugin.cache import Cache
@@ -51,9 +51,9 @@ MARKDOWN_LINK_REGEX = re.compile(  # noqa: DUO138
             )
           \]
           \(             # literal paren
-            [ \t]*
+            \s*
             <?(.*?)>?    # href = $3
-            [ \t]*
+            \s*
             (            # $4
               (['"])     # quote char = $5
               (.*?)      # Title = $6
@@ -145,10 +145,7 @@ def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
     for line in io.StringIO(markdown):
         if not _current_fcodeblock_delimiter:
             lstripped_line = line.lstrip()
-            if (
-                lstripped_line.startswith('```')
-                or lstripped_line.startswith('~~~')
-            ):
+            if lstripped_line.startswith(('```', '~~~')):
                 _current_fcodeblock_delimiter = lstripped_line[:3]
                 process_current_paragraph()
                 current_paragraph = ''
@@ -226,10 +223,7 @@ def transform_line_by_line_skipping_codeblocks(
     for line in io.StringIO(markdown):
         if not _current_fcodeblock_delimiter:
             lstripped_line = line.lstrip()
-            if (
-                lstripped_line.startswith('```')
-                or lstripped_line.startswith('~~~')
-            ):
+            if lstripped_line.startswith(('```', '~~~')):
                 _current_fcodeblock_delimiter = lstripped_line[:3]
             else:
                 line = func(line)  # noqa: PLW2901
@@ -255,25 +249,23 @@ def rewrite_relative_urls(
         scheme, netloc, path, params, query, fragment = urlparse(url)
 
         # absolute or mail
-        if path.startswith('/') or scheme == 'mailto':
+        if is_relative_path(url) or path.startswith('/') or scheme == 'mailto':
             return url
 
-        trailing_slash = path.endswith('/')
-
-        path = os.path.relpath(
+        new_path = os.path.relpath(
             os.path.join(os.path.dirname(source_path), path),
             os.path.dirname(destination_path),
         )
 
         # ensure forward slashes are used, on Windows
-        path = path.replace('\\', '/').replace('//', '/')
+        new_path = new_path.replace('\\', '/').replace('//', '/')
 
-        if trailing_slash:
+        if path.endswith('/'):
             # the above operation removes a trailing slash. Add it back if it
             # was present in the input
-            path = path + '/'
+            new_path = new_path + '/'
 
-        return urlunparse((scheme, netloc, path, params, query, fragment))
+        return urlunparse((scheme, netloc, new_path, params, query, fragment))
 
     def found_href(m: re.Match[str], url_group_index: int = -1) -> str:
         match_start, match_end = m.span(0)
@@ -400,7 +392,7 @@ def _transform_positive_offset_func_factory(
 
 def increase_headings_offset(markdown: str, offset: int = 0) -> str:
     """Increases the headings depth of a snippet of Makdown content."""
-    if not offset:
+    if not offset:  # pragma: no cover
         return markdown
     return transform_line_by_line_skipping_codeblocks(
         markdown,
@@ -444,7 +436,9 @@ def filter_paths(
             continue
 
         # ignore by dirpath (relative or absolute)
-        if (os.sep).join(filepath.split(os.sep)[:-1]) in ignore_paths:
+        fp_split = filepath.split(os.sep)
+        fp_split.pop()
+        if (os.sep).join(fp_split) in ignore_paths:
             continue
 
         # ignore if is a directory
@@ -456,6 +450,8 @@ def filter_paths(
 
 def is_url(string: str) -> bool:
     """Determine if a string is an URL."""
+    if ':' not in string:  # fast path
+        return False
     try:
         result = urlparse(string)
         return all([result.scheme, result.netloc])
@@ -470,7 +466,7 @@ def is_relative_path(string: str) -> bool:
 
 def is_absolute_path(string: str) -> bool:
     """Check if a string looks like an absolute path."""
-    return os.path.isabs(string) or string.startswith((os.sep, '/'))
+    return string.startswith((os.sep, '/'))
 
 
 def read_file(file_path: str, encoding: str) -> str: