Merge pull request #269 from adamtheturtle/fix-bullet

Support nesting non-bullet items within bullets

Author: adamtheturtle

sample/index.rst

@@ -206,6 +206,53 @@ Some key features 👍:
 * Supports videos with URLs and local files
 * Supports PDFs with URLs and local files
 
+Nested Content in Bullet Lists
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+This demonstrates the new support for nesting various content types within bullet lists:
+
+* First bullet point with **bold text**
+
+  This is a paragraph nested within a bullet list item. It should work now!
+
+  .. image:: https://images.unsplash.com/photo-1506905925346-21bda4d32df4?w=400&h=300&fit=crop
+     :alt: Nested image in bullet list
+
+  * Nested bullet point
+  * Another nested bullet
+
+    * Deeply nested bullet
+
+* Second bullet point with *italic text*
+
+  Here's some code nested within a bullet list:
+
+  .. code-block:: python
+
+      """Python code."""
+
+      import sys
+
+      sys.stdout.write("Hello, world!")
+
+  And here's a note admonition nested within the bullet list:
+
+  .. note::
+
+     This is a note that's nested within a bullet list item. This should work now!
+
+* Third bullet point
+
+  This bullet point contains a table:
+
+  +----------+----------+
+  | Header 1 | Header 2 |
+  +==========+==========+
+  | Cell 1   | Cell 2   |
+  +----------+----------+
+  | Cell 3   | Cell 4   |
+  +----------+----------+
+
 Numbered Lists
 ~~~~~~~~~~~~~~
 

src/sphinx_notion/__init__.py

@@ -398,77 +398,6 @@ def _map_pygments_to_notion_language(*, pygments_lang: str) -> CodeLang:
     return language_mapping[pygments_lang.lower()]
 
 
-@beartype
-def _process_list_item_recursively(
-    *,
-    node: nodes.list_item,
-) -> list[Block]:
-    """
-    Recursively process a list item node and return a BulletedItem.
-    """
-    paragraph = node.children[0]
-    assert isinstance(paragraph, nodes.paragraph)
-    rich_text = _create_rich_text_from_children(node=paragraph)
-    block = UnoBulletedItem(text=rich_text)
-
-    assert isinstance(node, nodes.list_item)
-
-    for child in node.children[1:]:
-        if not isinstance(child, nodes.bullet_list):
-            bullet_only_msg = (
-                "The only thing Notion supports within a bullet list is a "
-                f"bullet list. Given {type(child).__name__} on line "
-                f"{child.line} in {child.source}"
-            )
-            # Ignore error which is about a type error, but we want to
-            # raise a value error because the user has not sent anything to
-            # do with types.
-            raise ValueError(bullet_only_msg)  # noqa: TRY004
-        for nested_list_item in child.children:
-            assert isinstance(nested_list_item, nodes.list_item)
-            block.append(
-                blocks=_process_list_item_recursively(
-                    node=nested_list_item,
-                )
-            )
-    return [block]
-
-
-@beartype
-def _process_numbered_list_item_recursively(
-    *,
-    node: nodes.list_item,
-) -> list[Block]:
-    """
-    Recursively process a numbered list item node and return a NumberedItem.
-    """
-    paragraph = node.children[0]
-    assert isinstance(paragraph, nodes.paragraph)
-    rich_text = _create_rich_text_from_children(node=paragraph)
-    block = UnoNumberedItem(text=rich_text)
-
-    numbered_only_msg = (
-        "The only thing Notion supports within a numbered list is a "
-        f"numbered list. Given {type(node).__name__} on line {node.line} "
-        f"in {node.source}"
-    )
-    assert isinstance(node, nodes.list_item)
-
-    for child in node.children[1:]:
-        assert isinstance(child, nodes.enumerated_list), numbered_only_msg
-        for nested_list_item in child.children:
-            assert isinstance(nested_list_item, nodes.list_item), (
-                numbered_only_msg
-            )
-
-            block.append(
-                blocks=_process_numbered_list_item_recursively(
-                    node=nested_list_item,
-                )
-            )
-    return [block]
-
-
 @singledispatch
 @beartype
 def _process_node_to_blocks(
@@ -610,15 +539,21 @@ def _(
     """
     Process bullet list nodes by creating Notion BulletedItem blocks.
     """
-    del section_level
     result: list[Block] = []
     for list_item in node.children:
         assert isinstance(list_item, nodes.list_item)
-        result.extend(
-            _process_list_item_recursively(
-                node=list_item,
+        paragraph = list_item.children[0]
+        assert isinstance(paragraph, nodes.paragraph)
+        rich_text = _create_rich_text_from_children(node=paragraph)
+        block = UnoBulletedItem(text=rich_text)
+
+        for child in list_item.children[1:]:
+            child_blocks = _process_node_to_blocks(
+                child,
+                section_level=section_level,
             )
-        )
+            block.append(blocks=child_blocks)
+        result.append(block)
     return result
 
 
@@ -632,20 +567,22 @@ def _(
     """
     Process enumerated list nodes by creating Notion NumberedItem blocks.
     """
-    del section_level
     result: list[Block] = []
-    numbered_only_msg = (
-        "The only thing Notion supports within a numbered list is a "
-        f"numbered list. Given {type(node).__name__} on line {node.line} "
-        f"in {node.source}"
-    )
     for list_item in node.children:
-        assert isinstance(list_item, nodes.list_item), numbered_only_msg
-        result.extend(
-            _process_numbered_list_item_recursively(
-                node=list_item,
+        assert isinstance(list_item, nodes.list_item)
+        paragraph = list_item.children[0]
+        assert isinstance(paragraph, nodes.paragraph)
+        rich_text = _create_rich_text_from_children(node=paragraph)
+        block = UnoNumberedItem(text=rich_text)
+
+        for child in list_item.children[1:]:
+            child_blocks = _process_node_to_blocks(
+                child,
+                section_level=section_level,
             )
-        )
+            block.append(blocks=child_blocks)
+
+        result.append(block)
     return result
 
 

tests/test_integration.py

@@ -1782,37 +1782,6 @@ def test_strikethrough_text(
     )
 
 
-def test_bullet_list_item_invalid_nested_child_error(
-    *,
-    make_app: Callable[..., SphinxTestApp],
-    tmp_path: Path,
-) -> None:
-    """
-    Bullet list items with invalid nested children raise a clear error message.
-    """
-    rst_content = """
-        * First bullet point
-
-          Some paragraph that should not be here
-
-          * Nested bullet
-    """
-
-    index_rst = tmp_path / "src" / "index.rst"
-    expected_message = (
-        r"^The only thing Notion supports within a bullet list is a "
-        r"bullet list. Given paragraph on line 3 "
-        rf"in {re.escape(pattern=str(object=index_rst))}$"
-    )
-    with pytest.raises(expected_exception=ValueError, match=expected_message):
-        _assert_rst_converts_to_notion_objects(
-            rst_content=rst_content,
-            expected_objects=[],
-            make_app=make_app,
-            tmp_path=tmp_path,
-        )
-
-
 def test_comment_ignored(
     *,
     make_app: Callable[..., SphinxTestApp],
@@ -2454,3 +2423,58 @@ def test_text_styles_and_strike(
             "sphinxnotes.strike",
         ),
     )
+
+
+def test_bullet_list_with_nested_content(
+    *,
+    make_app: Callable[..., SphinxTestApp],
+    tmp_path: Path,
+) -> None:
+    """
+    Test that bullet lists can contain nested content like paragraphs and
+    nested bullets.
+    """
+    rst_content = """
+        * First bullet point
+
+          This is a paragraph nested within a bullet list item.
+
+          * Nested bullet point
+          * Another nested bullet
+
+        * Second bullet point
+
+          Another nested paragraph.
+    """
+
+    first_bullet = UnoBulletedItem(text=text(text="First bullet point"))
+
+    nested_paragraph = UnoParagraph(
+        text=text(text="This is a paragraph nested within a bullet list item.")
+    )
+    first_bullet.append(blocks=[nested_paragraph])
+
+    nested_bullet_1 = UnoBulletedItem(text=text(text="Nested bullet point"))
+    nested_bullet_2 = UnoBulletedItem(text=text(text="Another nested bullet"))
+    first_bullet.append(blocks=[nested_bullet_1])
+    first_bullet.append(blocks=[nested_bullet_2])
+
+    second_bullet = UnoBulletedItem(text=text(text="Second bullet point"))
+
+    nested_paragraph_2 = UnoParagraph(
+        text=text(text="Another nested paragraph.")
+    )
+    second_bullet.append(blocks=[nested_paragraph_2])
+
+    expected_objects: list[Block] = [
+        first_bullet,
+        second_bullet,
+    ]
+
+    _assert_rst_converts_to_notion_objects(
+        rst_content=rst_content,
+        expected_objects=expected_objects,
+        make_app=make_app,
+        tmp_path=tmp_path,
+        extensions=("sphinx_notion",),
+    )