mkdocs-include-markdown-plugin 6.2.0__tar.gz → 6.2.2__tar.gz

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocs-include-markdown-plugin
-Version: 6.2.0
+Version: 6.2.2
 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
@@ -22,13 +22,14 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Text Processing :: Markup :: Markdown
 Requires-Python: >=3.8
 Requires-Dist: mkdocs>=1.4
-Requires-Dist: wcmatch<9,>=8
+Requires-Dist: wcmatch
 Provides-Extra: cache
 Requires-Dist: platformdirs; extra == 'cache'
 Description-Content-Type: text/markdown
@@ -43,6 +44,7 @@ Description-Content-Type: text/markdown
 [![License][license-image]][license-link]
 [![Tests][tests-image]][tests-link]
 [![Coverage status][coverage-image]][coverage-link]
+[![Downloads][downloads-image]][downloads-link]
 
 <!-- mdpo-enable -->
 
@@ -194,8 +196,8 @@ content to include.
   **recursive** (_true_): When this option is disabled, included files are not
   processed for recursive includes. Possible values are `true` and `false`.
 - <a name="include-markdown_encoding" href="#include-markdown_encoding">#</a>
-  **encoding** (_utf-8_): Specify the encoding of the included file.
-  If not defined `utf-8` will be used.
+  **encoding** (_'utf-8'_): Specify the encoding of the included file.
+  If not defined `'utf-8'` will be used.
 - <a name="include-markdown_rewrite-relative-urls" href="#include-markdown_rewrite-relative-urls">#</a>
   **rewrite-relative-urls** (_true_): When this option is enabled (default),
   Markdown links and images in the content that are specified by a relative URL
@@ -285,8 +287,8 @@ Includes the content of a file or a group of files.
   **recursive** (_true_): When this option is disabled, included files are not
   processed for recursive includes. Possible values are `true` and `false`.
 - <a name="include_encoding" href="#include_encoding">#</a>
-  **encoding** (_utf-8_): Specify the encoding of the included file.
-  If not defined `utf-8` will be used.
+  **encoding** (_'utf-8'_): Specify the encoding of the included file.
+  If not defined `'utf-8'` will be used.
 
 ##### Examples
 
@@ -330,6 +332,8 @@ Includes the content of a file or a group of files.
 [coverage-link]: https://app.codecov.io/gh/mondeja/mkdocs-include-markdown-plugin
 [license-image]: https://img.shields.io/pypi/l/mkdocs-include-markdown-plugin?color=light-green&logo=apache&logoColor=white
 [license-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/LICENSE
+[downloads-image]: https://img.shields.io/pypi/dm/mkdocs-include-markdown-plugin
+[downloads-link]: https://pepy.tech/project/mkdocs-include-markdown-plugin
 [platformdirs]: https://pypi.org/project/platformdirs/
 [cibuildwheel-470]: https://github.com/pypa/cibuildwheel/issues/470
 [cibuildwheel-475]: https://github.com/pypa/cibuildwheel/pull/475

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/README.md

@@ -8,6 +8,7 @@
 [![License][license-image]][license-link]
 [![Tests][tests-image]][tests-link]
 [![Coverage status][coverage-image]][coverage-link]
+[![Downloads][downloads-image]][downloads-link]
 
 <!-- mdpo-enable -->
 
@@ -159,8 +160,8 @@ content to include.
   **recursive** (_true_): When this option is disabled, included files are not
   processed for recursive includes. Possible values are `true` and `false`.
 - <a name="include-markdown_encoding" href="#include-markdown_encoding">#</a>
-  **encoding** (_utf-8_): Specify the encoding of the included file.
-  If not defined `utf-8` will be used.
+  **encoding** (_'utf-8'_): Specify the encoding of the included file.
+  If not defined `'utf-8'` will be used.
 - <a name="include-markdown_rewrite-relative-urls" href="#include-markdown_rewrite-relative-urls">#</a>
   **rewrite-relative-urls** (_true_): When this option is enabled (default),
   Markdown links and images in the content that are specified by a relative URL
@@ -250,8 +251,8 @@ Includes the content of a file or a group of files.
   **recursive** (_true_): When this option is disabled, included files are not
   processed for recursive includes. Possible values are `true` and `false`.
 - <a name="include_encoding" href="#include_encoding">#</a>
-  **encoding** (_utf-8_): Specify the encoding of the included file.
-  If not defined `utf-8` will be used.
+  **encoding** (_'utf-8'_): Specify the encoding of the included file.
+  If not defined `'utf-8'` will be used.
 
 ##### Examples
 
@@ -295,6 +296,8 @@ Includes the content of a file or a group of files.
 [coverage-link]: https://app.codecov.io/gh/mondeja/mkdocs-include-markdown-plugin
 [license-image]: https://img.shields.io/pypi/l/mkdocs-include-markdown-plugin?color=light-green&logo=apache&logoColor=white
 [license-link]: https://github.com/mondeja/mkdocs-include-markdown-plugin/blob/master/LICENSE
+[downloads-image]: https://img.shields.io/pypi/dm/mkdocs-include-markdown-plugin
+[downloads-link]: https://pepy.tech/project/mkdocs-include-markdown-plugin
 [platformdirs]: https://pypi.org/project/platformdirs/
 [cibuildwheel-470]: https://github.com/pypa/cibuildwheel/issues/470
 [cibuildwheel-475]: https://github.com/pypa/cibuildwheel/pull/475

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-include-markdown-plugin"
-version = "6.2.0"
+version = "6.2.2"
 description = "Mkdocs Markdown includer plugin."
 readme = "README.md"
 license = "Apache-2.0"
@@ -19,12 +19,13 @@ classifiers = [
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12"
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
 ]
 keywords = ["markdown", "mkdocs", "includer", "plugin"]
 dependencies = [
   "mkdocs>=1.4",
-  "wcmatch>=8,<9"
+  "wcmatch"
 ]
 
 [[project.authors]]
@@ -73,7 +74,7 @@ matrix-name-format = "{variable}-{value}"
 dependencies = ["pytest~=7.0", "coverage~=6.4", "covdefaults"]
 
 [[tool.hatch.envs.tests.matrix]]
-python = ["py38", "py39", "py310", "py311", "py312"]
+python = ["py38", "py39", "py310", "py311", "py312", "py313"]
 mkdocs = ["1.4.0", "1.4.3", "1.5.0", "1.5.3", "1.6.0"]
 cache = ["yes", "no"]
 
@@ -104,9 +105,9 @@ targets = [{ file = "pyproject.toml" }]
 [tool.project-config]
 cache = "2 days"
 style = [
-  "gh://mondeja/project-config-styles@v5.2.1/base/pre-commit/md2po2md.json5",
-  "gh://mondeja/project-config-styles@v5.2.1/python/base.json5",
-  "gh://mondeja/project-config-styles@v5.2.1/python/mypy.json5",
+  "gh://mondeja/project-config-styles@v5.3/base/pre-commit/md2po2md.json5",
+  "gh://mondeja/project-config-styles@v5.3/python/base.json5",
+  "gh://mondeja/project-config-styles@v5.3/python/mypy.json5",
 ]
 
 [tool.coverage.run]
@@ -203,7 +204,7 @@ extra-standard-library = [
 
 [tool.mypy]
 strict = true
-python_version = "3.11"
+python_version = "3.12"
 allow_untyped_calls = true
 allow_any_generics = true
 

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/src/mkdocs_include_markdown_plugin/cache.py

@@ -39,24 +39,24 @@ class Cache:
             hashlib.sha3_512(url.encode()).digest(),
         ).decode('utf-8')
 
-    def read_file(self, fpath: str) -> str:  # noqa: D102
-        with open(fpath, encoding='utf-8') as f:
+    def read_file(self, fpath: str, encoding: str = 'utf-8') -> str:  # noqa: D102
+        with open(fpath, encoding=encoding) as f:
             return f.read().split('\n', 1)[1]
 
-    def get_(self, url: str) -> str | None:  # noqa: D102
+    def get_(self, url: str, encoding: str = 'utf-8') -> str | None:  # noqa: D102
         key = self.generate_unique_key_from_url(url)
         fpath = os.path.join(self.cache_dir, key)
         if os.path.isfile(fpath):
             creation_time = self.get_creation_time_from_fpath(fpath)
             if time.time() < creation_time + self.expiration_seconds:
-                return self.read_file(fpath)
+                return self.read_file(fpath, encoding=encoding)
             os.remove(fpath)
         return None
 
-    def set_(self, url: str, value: str) -> None:  # noqa: D102
+    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='utf-8') as f:
+        with open(fpath, 'w', encoding=encoding) as f:
             f.write(f'{int(time.time())}\n')
             f.write(value)
 

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/src/mkdocs_include_markdown_plugin/directive.py

@@ -52,7 +52,7 @@ SINGLE_QUOTED_STR_RE = r"([^']|(?<=\\)')+"
 # and "$CLOSING_TAG" will be replaced by the effective opening and
 # closing tags in the `on_config` plugin event.
 INCLUDE_TAG_RE = rf'''
-    (?P<_includer_indent>[ \t\f\v\w{re.escape(string.punctuation)}]*?)$OPENING_TAG
+    (?P<_includer_indent>[ \t\w\\.]*?)$OPENING_TAG
     \s*
     include
     \s+
@@ -171,7 +171,7 @@ def create_include_tag(
     """Create a regex pattern to match an inclusion tag directive.
 
     Replaces the substrings '$OPENING_TAG' and '$CLOSING_TAG' from
-    INCLUDE_TAG_REGEX by the effective tag.
+    INCLUDE_TAG_RE by the effective tag.
     """
     return re.compile(
         INCLUDE_TAG_RE.replace(' include', f' {tag}').replace(

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/src/mkdocs_include_markdown_plugin/event.py

@@ -230,7 +230,9 @@ def get_file_content(  # noqa: PLR0913, PLR0915
         expected_but_any_found = [start is not None, end is not None]
         for file_path in file_paths_to_include:
             if process.is_url(filename):
-                new_text_to_include = process.read_url(file_path, http_cache)
+                new_text_to_include = process.read_url(
+                    file_path, http_cache, encoding,
+                )
             else:
                 new_text_to_include = process.read_file(file_path, encoding)
 
@@ -481,7 +483,9 @@ def get_file_content(  # noqa: PLR0913, PLR0915
         text_to_include = ''
         for file_path in file_paths_to_include:
             if process.is_url(filename):
-                new_text_to_include = process.read_url(file_path, http_cache)
+                new_text_to_include = process.read_url(
+                    file_path, http_cache, encoding,
+                )
             else:
                 new_text_to_include = process.read_file(file_path, encoding)
 
@@ -587,9 +591,11 @@ def get_file_content(  # noqa: PLR0913, PLR0915
         nonlocal new_found_include_markdown_contents
         markdown_include_index = len(new_found_include_markdown_contents)
         placeholder = build_placeholder(
-            markdown_include_index, 'include-markdown')
+            markdown_include_index, 'include-markdown',
+        )
         new_found_include_markdown_contents.append(
-            (placeholder, text_to_include))
+            (placeholder, text_to_include),
+        )
         return placeholder
 
     # Replace contents by placeholders

{mkdocs_include_markdown_plugin-6.2.0 → mkdocs_include_markdown_plugin-6.2.2}/src/mkdocs_include_markdown_plugin/process.py

@@ -443,16 +443,20 @@ def read_file(file_path: str, encoding: str) -> str:
         return f.read()
 
 
-def read_url(url: str, http_cache: Cache | None) -> Any:
+def read_url(
+        url: str,
+        http_cache: Cache | None,
+        encoding: str = 'utf-8',
+) -> Any:
     """Read an HTTP location and return its content."""
     if http_cache is not None:
-        cached_content = http_cache.get_(url)
+        cached_content = http_cache.get_(url, encoding)
         if cached_content is not None:
             return cached_content
     with urlopen(Request(url)) as response:
-        content = response.read().decode('UTF-8')
+        content = response.read().decode(encoding)
     if http_cache is not None:
-        http_cache.set_(url, content)
+        http_cache.set_(url, content, encoding)
     return content