mkdocs-include-markdown-plugin 6.2.2__py3-none-any.whl → 7.0.0__py3-none-any.whl

mkdocs_include_markdown_plugin/config.py

@@ -17,7 +17,7 @@ class PluginConfig(Config):  # noqa: D101
     preserve_includer_indent = MkType(bool, default=True)
     dedent = MkType(bool, default=False)
     trailing_newlines = MkType(bool, default=True)
-    comments = MkType(bool, default=True)
+    comments = MkType(bool, default=False)
     rewrite_relative_urls = MkType(bool, default=True)
     heading_offset = MkType(int, default=0)
     start = Optional(MkType(str))

mkdocs_include_markdown_plugin/process.py

@@ -114,7 +114,7 @@ MARKDOWN_LINK_DEFINITION_REGEX = re.compile(
 )
 
 
-def transform_p_by_p_skipping_codeblocks(
+def transform_p_by_p_skipping_codeblocks(  # noqa: PLR0912, PLR0915
         markdown: str,
         func: Callable[[str], str],
 ) -> str:
@@ -128,45 +128,80 @@ def transform_p_by_p_skipping_codeblocks(
     _current_fcodeblock_delimiter = ''
 
     # inside indented codeblock
-    _inside_icodeblock = False
+    _maybe_icodeblock_lines: list[str] = []
+    _previous_line_was_empty = False
 
     lines, current_paragraph = ([], '')
 
     def process_current_paragraph() -> None:
         lines.extend(func(current_paragraph).splitlines(keepends=True))
 
+    # The next implementation takes into account that indented code
+    # blocks must be surrounded by newlines as per the CommonMark
+    # specification. See https://spec.commonmark.org/0.28/#indented-code-blocks
+    #
+    # However, note that ambiguities with list items are not handled.
+
     for line in io.StringIO(markdown):
-        if not _current_fcodeblock_delimiter and not _inside_icodeblock:
+        if not _current_fcodeblock_delimiter:
             lstripped_line = line.lstrip()
             if (
                 lstripped_line.startswith('```')
                 or lstripped_line.startswith('~~~')
             ):
                 _current_fcodeblock_delimiter = lstripped_line[:3]
-                if current_paragraph:
-                    process_current_paragraph()
-                    current_paragraph = ''
+                process_current_paragraph()
+                current_paragraph = ''
                 lines.append(line)
-            elif (
-                line.replace('\t', '    ').replace('\r\n', '\n')
-                == '    \n'
-            ):
-                _inside_icodeblock = True
-                if current_paragraph:
+            elif line.startswith('    '):
+                if not lstripped_line or _maybe_icodeblock_lines:
+                    # maybe enter indented codeblock
+                    _maybe_icodeblock_lines.append(line)
+                else:
+                    current_paragraph += line
+            elif _maybe_icodeblock_lines:
+                process_current_paragraph()
+                current_paragraph = ''
+                if not _previous_line_was_empty:
+                    # wasn't an indented code block
+                    for line_ in _maybe_icodeblock_lines:
+                        current_paragraph += line_
+                    _maybe_icodeblock_lines = []
+                    current_paragraph += line
                     process_current_paragraph()
                     current_paragraph = ''
-                lines.append(line)
+                else:
+                    # exit indented codeblock
+                    for line_ in _maybe_icodeblock_lines:
+                        lines.append(line_)
+                    _maybe_icodeblock_lines = []
+                    lines.append(line)
             else:
                 current_paragraph += line
+            _previous_line_was_empty = not lstripped_line
         else:
             lines.append(line)
-            if _current_fcodeblock_delimiter:
-                if line.lstrip().startswith(_current_fcodeblock_delimiter):
-                    _current_fcodeblock_delimiter = ''
-            elif not line.startswith('    ') and not line.startswith('\t'):
-                _inside_icodeblock = False
-
-    process_current_paragraph()
+            lstripped_line = line.lstrip()
+            if lstripped_line.startswith(_current_fcodeblock_delimiter):
+                _current_fcodeblock_delimiter = ''
+            _previous_line_was_empty = not lstripped_line
+
+    if _maybe_icodeblock_lines:
+        if not _previous_line_was_empty:
+            # at EOF
+            process_current_paragraph()
+            current_paragraph = ''
+            for line_ in _maybe_icodeblock_lines:
+                current_paragraph += line_
+            process_current_paragraph()
+            current_paragraph = ''
+        else:
+            process_current_paragraph()
+            current_paragraph = ''
+            for line_ in _maybe_icodeblock_lines:
+                lines.append(line_)
+    else:
+        process_current_paragraph()
 
     return ''.join(lines)
 
@@ -180,7 +215,7 @@ def transform_line_by_line_skipping_codeblocks(
     Skip fenced codeblock lines, where the transformation never is applied.
 
     Indented codeblocks are not taken into account because in the practice
-    this function is never used for transformations on indented lines. See
+    this function is only used for transformations of heading prefixes. See
     the PR https://github.com/mondeja/mkdocs-include-markdown-plugin/pull/95
     to recover the implementation handling indented codeblocks.
     """
@@ -269,6 +304,7 @@ def rewrite_relative_urls(
             functools.partial(found_href, url_group_index=2),
             paragraph,
         )
+
     return transform_p_by_p_skipping_codeblocks(
         markdown,
         transform,

{mkdocs_include_markdown_plugin-6.2.2.dist-info → mkdocs_include_markdown_plugin-7.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocs-include-markdown-plugin
-Version: 6.2.2
+Version: 7.0.0
 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
@@ -17,7 +17,6 @@ Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
@@ -27,7 +26,7 @@ Classifier: Topic :: Documentation
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Text Processing :: Markup :: Markdown
-Requires-Python: >=3.8
+Requires-Python: >=3.9
 Requires-Dist: mkdocs>=1.4
 Requires-Dist: wcmatch
 Provides-Extra: cache
@@ -204,10 +203,10 @@ content to include.
   are rewritten to work correctly in their new location. Possible values are
   `true` and `false`.
 - <a name="include-markdown_comments" href="#include-markdown_comments">#</a>
-  **comments** (_true_): When this option is enabled (default), the content to
-  include is wrapped by `<!-- BEGIN INCLUDE -->` and `<!-- END INCLUDE -->`
-  comments which help to identify that the content has been included. Possible
-  values are `true` and `false`.
+  **comments** (_false_): When this option is enabled, the content to include
+  is wrapped by `<!-- BEGIN INCLUDE -->` and `<!-- END INCLUDE -->` comments
+  which help to identify that the content has been included. Possible values
+  are `true` and `false`.
 - <a name="include-markdown_heading-offset" href="#include-markdown_heading-offset">#</a>
   **heading-offset** (0): Increases or decreases the Markdown headings depth
   by this number. Only supports number sign (`#`) heading syntax. Accepts
@@ -229,7 +228,7 @@ content to include.
     start='<!--\n\ttable-start\n-->'
     end='<!--\n\ttable-end\n-->'
     rewrite-relative-urls=false
-    comments=false
+    comments=true
 %}
 ```
 

{mkdocs_include_markdown_plugin-6.2.2.dist-info → mkdocs_include_markdown_plugin-7.0.0.dist-info}/RECORD

@@ -1,15 +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/config.py,sha256=GezwaOHzZ3eDayweFEEG0b7PuWFIqiBBn-XMXrP0U3Q,862
 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/process.py,sha256=DLbq_Alj1_XSKbTxLHl9IRxEO3XBNmavgksJJuwnwlY,17210
 mkdocs_include_markdown_plugin/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocs_include_markdown_plugin-6.2.2.dist-info/METADATA,sha256=wDrrPZPZ8gpPTNFZTLjHUIirYKnewCwb3AzhOI6WSig,12142
-mkdocs_include_markdown_plugin-6.2.2.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-mkdocs_include_markdown_plugin-6.2.2.dist-info/entry_points.txt,sha256=WEL5m7sw5ZMBwmdOs5S_9mGoZfLCaUDPkDKw7CUk16Q,96
-mkdocs_include_markdown_plugin-6.2.2.dist-info/licenses/LICENSE,sha256=OunyKlPxiuvLB3ENbo2nyV-OPndkwzyZ5Gzwei0ofbc,11365
-mkdocs_include_markdown_plugin-6.2.2.dist-info/RECORD,,
+mkdocs_include_markdown_plugin-7.0.0.dist-info/METADATA,sha256=h1gJX1qFKDa3dB2kkqz-bE0SWrpVZ5qRIsfhW19mdhQ,12082
+mkdocs_include_markdown_plugin-7.0.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+mkdocs_include_markdown_plugin-7.0.0.dist-info/entry_points.txt,sha256=WEL5m7sw5ZMBwmdOs5S_9mGoZfLCaUDPkDKw7CUk16Q,96
+mkdocs_include_markdown_plugin-7.0.0.dist-info/licenses/LICENSE,sha256=OunyKlPxiuvLB3ENbo2nyV-OPndkwzyZ5Gzwei0ofbc,11365
+mkdocs_include_markdown_plugin-7.0.0.dist-info/RECORD,,