pull_request(list): prevent extra p tags inside list items

mkdcomments.py

@@ -10,12 +10,9 @@
 class CommentsExtension(Extension):
     def extendMarkdown(self, md):
         md.registerExtension(self)
-        md.preprocessors.register(
-            CommentMunger(md), "comment_munger", 21)
-        md.preprocessors.register(
-            CommentRemover(md), "comment_remover", 19)
-        md.postprocessors.register(
-            RawCommentReplacer(md), "raw_comment_replacer", 29)
+        md.preprocessors.register(CommentMunger(md), "comment_munger", 21)
+        md.preprocessors.register(CommentRemover(md), "comment_remover", 19)
+        md.postprocessors.register(RawCommentReplacer(md), "raw_comment_replacer", 29)
 
 
 class CommentMunger(Preprocessor):
@@ -58,7 +55,25 @@ def _unmultiliner(self, line):
 
 class RawCommentReplacer(Postprocessor):
     def run(self, text):
-        return re.sub(PREFIX_PLACEHOLDER, '<!---', text)
+        # Restore the placeholder
+        text = re.sub(PREFIX_PLACEHOLDER, '<!---', text)
+
+        # Remove unwanted <p> tags around list items.
+        # See issue #8 for details.
+        text = re.sub(r'<li>\s*<p>(.*?)</p>\s*</li>', r'<li>\1</li>', text)
+
+        # Preserve comments inside <pre> tags
+        text = self._preserve_comments_in_pre(text)
+
+        return text
+
+    def _preserve_comments_in_pre(self, text):
+        """Preserve comments within <pre> tags."""
+        return re.sub(r'(<pre>.*?</pre>)', self._replace_placeholder, text, flags=re.DOTALL)
+
+    def _replace_placeholder(self, match):
+        """Replace the placeholder back to HTML comment."""
+        return match.group(0).replace(PREFIX_PLACEHOLDER, '<!---')
 
 
 def makeExtension(*args, **kwargs):

test/test_comments.py

@@ -1,4 +1,3 @@
-import re
 import pathlib
 import unittest
 import textwrap
@@ -75,6 +74,62 @@ def test_multiline_ending_and_beginning_on_same_line(self):
             <p>more text</p>"""
         self.assertExpectedMarkdown(md_input, expected_result)
 
+    def test_comments_between_list_items(self):
+        """Test the case where a comment between items inside the list.
+
+        See issue #8 for details."""
+        md_input = """\
+        1. Kira first
+        <!--- Kira comment -->
+        1. Kira second
+        1. Kira third
+        """
+        expected_result = """\
+        <ol>
+        <li>Kira first</li>
+        <li>Kira second</li>
+        <li>Kira third</li>
+        </ol>"""
+        self.assertExpectedMarkdown(md_input, expected_result)
+
+    def test_comments_between_list_items_with_blank_lines(self):
+        """Test the case where a comment and blank lines between items inside the list."""
+        md_input = """\
+        1. Kira first
+
+        <!--- Kira comment -->
+
+        1. Kira second
+        1. Kira third
+        """
+        expected_result = """\
+        <ol>
+        <li>Kira first</li>
+        <li>Kira second</li>
+        <li>Kira third</li>
+        </ol>"""
+        self.assertExpectedMarkdown(md_input, expected_result)
+
+    def test_multiline_comments_between_list_items(self):
+        """Test the case where a multiline comment and blank lines between the items inside the list."""
+        md_input = """\
+        1. Kira first
+
+        <!--- Kira
+        multiline
+        comment -->
+
+        1. Kira second
+        1. Kira third
+        """
+        expected_result = """\
+        <ol>
+        <li>Kira first</li>
+        <li>Kira second</li>
+        <li>Kira third</li>
+        </ol>"""
+        self.assertExpectedMarkdown(md_input, expected_result)
+
     def test_comments_in_html(self):
         """ See issue #2. """
         md_input = """\