mkdocs-include-markdown-plugin 6.2.0__py3-none-any.whl → 6.2.1__py3-none-any.whl

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

{mkdocs_include_markdown_plugin-6.2.0.dist-info → mkdocs_include_markdown_plugin-6.2.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocs-include-markdown-plugin
-Version: 6.2.0
+Version: 6.2.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
@@ -43,6 +43,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 +195,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 +286,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 +331,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.1.dist-info/RECORD

@@ -0,0 +1,15 @@
+mkdocs_include_markdown_plugin/__init__.py,sha256=ByOde15RQSHlZTmkepPSzIt0GzUIv_-GKORFDnxnOmc,193
+mkdocs_include_markdown_plugin/cache.py,sha256=fFm2kU3ONoE2euo0rHC8DOBmV-ubX6BsfHe9hVFeRf4,2880
+mkdocs_include_markdown_plugin/config.py,sha256=CTP5xhdZwPKuee3urDLOjanV93uhHHAL8XZ3L6_2HIE,861
+mkdocs_include_markdown_plugin/directive.py,sha256=K0-lnw5AOwwLv0MShGydhhZQrS_07w-sizcQCuivGSY,9313
+mkdocs_include_markdown_plugin/event.py,sha256=37x21rRdIDsZDkUZjxb-IgxHy1olZ7yxqTxFedPlAFU,24001
+mkdocs_include_markdown_plugin/files_watcher.py,sha256=hu-63u8syl00mXP59vP_iqD7T1R9iU9JjiZOHDV5fas,298
+mkdocs_include_markdown_plugin/logger.py,sha256=nl63G4IJSt5mEYHbObuh7BmmowSv-aa1l_v9I257570,230
+mkdocs_include_markdown_plugin/plugin.py,sha256=PfpU2nrc2jlAtbVg5-c6GiK2GSwkFPEos5zvbGkONOo,3812
+mkdocs_include_markdown_plugin/process.py,sha256=3TT0Zkv-IWAloDuuLpcw-SR62lRQyxzDk_K8heFJl58,15669
+mkdocs_include_markdown_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocs_include_markdown_plugin-6.2.1.dist-info/METADATA,sha256=cDV5V0sFOKUvmvnJuvzNQTMJz8AO0Gtb2iKtfkwq4L8,12097
+mkdocs_include_markdown_plugin-6.2.1.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
+mkdocs_include_markdown_plugin-6.2.1.dist-info/entry_points.txt,sha256=WEL5m7sw5ZMBwmdOs5S_9mGoZfLCaUDPkDKw7CUk16Q,96
+mkdocs_include_markdown_plugin-6.2.1.dist-info/licenses/LICENSE,sha256=OunyKlPxiuvLB3ENbo2nyV-OPndkwzyZ5Gzwei0ofbc,11365
+mkdocs_include_markdown_plugin-6.2.1.dist-info/RECORD,,

mkdocs_include_markdown_plugin-6.2.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-mkdocs_include_markdown_plugin/__init__.py,sha256=ByOde15RQSHlZTmkepPSzIt0GzUIv_-GKORFDnxnOmc,193
-mkdocs_include_markdown_plugin/cache.py,sha256=2CAVNwDUHilY1-x1VMLw33hxv76z1wcpid22jTyoJyI,2784
-mkdocs_include_markdown_plugin/config.py,sha256=CTP5xhdZwPKuee3urDLOjanV93uhHHAL8XZ3L6_2HIE,861
-mkdocs_include_markdown_plugin/directive.py,sha256=F2SZufY8jN8uCinT87TE8RtbOsz6gIdj7fZ3h850wXg,9348
-mkdocs_include_markdown_plugin/event.py,sha256=MMYxGBOi6TK3FO0-m_kSynr2YG0tGL2C-rHycZ1gzfY,23883
-mkdocs_include_markdown_plugin/files_watcher.py,sha256=hu-63u8syl00mXP59vP_iqD7T1R9iU9JjiZOHDV5fas,298
-mkdocs_include_markdown_plugin/logger.py,sha256=nl63G4IJSt5mEYHbObuh7BmmowSv-aa1l_v9I257570,230
-mkdocs_include_markdown_plugin/plugin.py,sha256=PfpU2nrc2jlAtbVg5-c6GiK2GSwkFPEos5zvbGkONOo,3812
-mkdocs_include_markdown_plugin/process.py,sha256=t1uJO2dJH5Zw_TtIcGbWDwphEwVdiY65x7Zhx0s3oLc,15596
-mkdocs_include_markdown_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocs_include_markdown_plugin-6.2.0.dist-info/METADATA,sha256=udwqISg4sK7zi7g3HotFcV84MHK5XPdhEseC9V8UA54,11885
-mkdocs_include_markdown_plugin-6.2.0.dist-info/WHEEL,sha256=zEMcRr9Kr03x1ozGwg5v9NQBKn3kndp6LSoSlVg-jhU,87
-mkdocs_include_markdown_plugin-6.2.0.dist-info/entry_points.txt,sha256=WEL5m7sw5ZMBwmdOs5S_9mGoZfLCaUDPkDKw7CUk16Q,96
-mkdocs_include_markdown_plugin-6.2.0.dist-info/licenses/LICENSE,sha256=OunyKlPxiuvLB3ENbo2nyV-OPndkwzyZ5Gzwei0ofbc,11365
-mkdocs_include_markdown_plugin-6.2.0.dist-info/RECORD,,