Merge pull request #401 from tatuylonen/list-check-functions

Create utility functions to check for lists and list items

Author: xxyzz

src/wikitextprocessor/parser.py

@@ -2496,3 +2496,19 @@ def print_tree(
     else:
         print("\n".join(parts))
         return None
+
+
+def is_list(node: WikiNode) -> bool:
+    return (
+        isinstance(node, WikiNode)
+        and node.kind == NodeKind.LIST
+        or (isinstance(node, HTMLNode) and node.tag in ("ul", "ol"))
+    )
+
+
+def is_list_item(node: WikiNode) -> bool:
+    return (
+        isinstance(node, WikiNode)
+        and node.kind == NodeKind.LIST_ITEM
+        or (isinstance(node, HTMLNode) and node.tag == "li")
+    )

tests/test_parser.py

@@ -11,6 +11,8 @@
     NodeKind,
     TemplateNode,
     WikiNode,
+    is_list,
+    is_list_item,
     print_tree,
 )
 
@@ -3279,6 +3281,76 @@ def test_pipe_in_external_link(self):
             ],
         )
 
+    def test_is_list_fn(self):
+        self.ctx.start_page("test")
+        root = self.ctx.parse(
+            """* test
+** test2
+"""
+        )
+        self.assertFalse(is_list(root))
+        main_list = root.children[0]
+        self.assertTrue(is_list(main_list))
+        item1 = main_list.children[0]
+        test_text = item1.children[0]
+        test2_list = item1.children[1]
+        self.assertFalse(is_list(item1))
+        self.assertFalse(is_list(test_text))
+        self.assertTrue(is_list(test2_list))
+
+    def test_is_list_fn_2(self):
+        self.ctx.start_page("test")
+        root = self.ctx.parse(
+            """<ul><li>test<ul><li>test2</li></ul></ul>
+"""
+        )
+        self.assertFalse(is_list(root))
+        main_list = root.children[0]
+        self.assertTrue(is_list(main_list))
+        item1 = main_list.children[0]
+        test_text = item1.children[0]
+        test2_list = item1.children[1]
+        self.assertFalse(is_list(item1))
+        self.assertFalse(is_list(test_text))
+        self.assertTrue(is_list(test2_list))
+
+    def test_is_list_item_fn(self):
+        self.ctx.start_page("test")
+        root = self.ctx.parse(
+            """* test
+** test2
+"""
+        )
+        self.assertFalse(is_list_item(root))
+        main_list = root.children[0]
+        self.assertFalse(is_list_item(main_list))
+        item1 = main_list.children[0]
+        test_text = item1.children[0]
+        test2_list = item1.children[1]
+        self.assertTrue(is_list_item(item1))
+        self.assertFalse(is_list_item(test_text))
+        self.assertFalse(is_list_item(test2_list))
+        item2 = test2_list.children[0]
+        self.assertTrue(is_list_item(item2))
+
+    def test_is_list_item_fn_2(self):
+        self.ctx.start_page("test")
+        root = self.ctx.parse(
+            """<ul><li>test<ul><li>test2</li></ul></ul>
+"""
+        )
+        self.assertFalse(is_list_item(root))
+        main_list = root.children[0]
+        self.assertFalse(is_list_item(main_list))
+        item1 = main_list.children[0]
+        test_text = item1.children[0]
+        test2_list = item1.children[1]
+        self.assertTrue(is_list_item(item1))
+        self.assertFalse(is_list_item(test_text))
+        self.assertFalse(is_list_item(test2_list))
+        item2 = test2_list.children[0]
+        self.assertTrue(is_list_item(item2))
+
 
 # XXX implement <nowiki/> marking for links, templates
 #  - https://en.wikipedia.org/wiki/Help:Wikitext#Nowiki