A Python parser for MediaWiki wikicode https://mwparserfromhell.readthedocs.io/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 

349 lines
15 KiB

  1. # -*- coding: utf-8 -*-
  2. #
  3. # Copyright (C) 2012-2014 Ben Kurtovic <ben.kurtovic@gmail.com>
  4. #
  5. # Permission is hereby granted, free of charge, to any person obtaining a copy
  6. # of this software and associated documentation files (the "Software"), to deal
  7. # in the Software without restriction, including without limitation the rights
  8. # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  9. # copies of the Software, and to permit persons to whom the Software is
  10. # furnished to do so, subject to the following conditions:
  11. #
  12. # The above copyright notice and this permission notice shall be included in
  13. # all copies or substantial portions of the Software.
  14. #
  15. # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16. # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17. # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  18. # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19. # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  20. # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  21. # SOFTWARE.
  22. from __future__ import unicode_literals
  23. try:
  24. import unittest2 as unittest
  25. except ImportError:
  26. import unittest
  27. from mwparserfromhell.compat import str
  28. from mwparserfromhell.nodes import Tag, Template, Text
  29. from mwparserfromhell.nodes.extras import Attribute
  30. from ._test_tree_equality import TreeEqualityTestCase, wrap, wraptext
  31. agen = lambda name, value: Attribute(wraptext(name), wraptext(value))
  32. agennv = lambda name: Attribute(wraptext(name))
  33. agennq = lambda name, value: Attribute(wraptext(name), wraptext(value), None)
  34. agenp = lambda name, v, a, b, c: Attribute(wraptext(name), v, '"', a, b, c)
  35. agenpnv = lambda name, a, b, c: Attribute(wraptext(name), None, '"', a, b, c)
  36. class TestTag(TreeEqualityTestCase):
  37. """Test cases for the Tag node."""
  38. def test_unicode(self):
  39. """test Tag.__unicode__()"""
  40. node1 = Tag(wraptext("ref"))
  41. node2 = Tag(wraptext("span"), wraptext("foo"),
  42. [agen("style", "color: red;")])
  43. node3 = Tag(wraptext("ref"),
  44. attrs=[agennq("name", "foo"),
  45. agenpnv("some_attr", " ", "", "")],
  46. self_closing=True)
  47. node4 = Tag(wraptext("br"), self_closing=True, padding=" ")
  48. node5 = Tag(wraptext("br"), self_closing=True, implicit=True)
  49. node6 = Tag(wraptext("br"), self_closing=True, invalid=True,
  50. implicit=True)
  51. node7 = Tag(wraptext("br"), self_closing=True, invalid=True,
  52. padding=" ")
  53. node8 = Tag(wraptext("hr"), wiki_markup="----", self_closing=True)
  54. node9 = Tag(wraptext("i"), wraptext("italics!"), wiki_markup="''")
  55. self.assertEqual("<ref></ref>", str(node1))
  56. self.assertEqual('<span style="color: red;">foo</span>', str(node2))
  57. self.assertEqual("<ref name=foo some_attr/>", str(node3))
  58. self.assertEqual("<br />", str(node4))
  59. self.assertEqual("<br>", str(node5))
  60. self.assertEqual("</br>", str(node6))
  61. self.assertEqual("</br />", str(node7))
  62. self.assertEqual("----", str(node8))
  63. self.assertEqual("''italics!''", str(node9))
  64. def test_children(self):
  65. """test Tag.__children__()"""
  66. # <ref>foobar</ref>
  67. node1 = Tag(wraptext("ref"), wraptext("foobar"))
  68. # '''bold text'''
  69. node2 = Tag(wraptext("b"), wraptext("bold text"), wiki_markup="'''")
  70. # <img id="foo" class="bar" selected />
  71. node3 = Tag(wraptext("img"),
  72. attrs=[agen("id", "foo"), agen("class", "bar"),
  73. agennv("selected")],
  74. self_closing=True, padding=" ")
  75. gen1 = node1.__children__()
  76. gen2 = node2.__children__()
  77. gen3 = node3.__children__()
  78. self.assertEqual(node1.tag, next(gen1))
  79. self.assertEqual(node3.tag, next(gen3))
  80. self.assertEqual(node3.attributes[0].name, next(gen3))
  81. self.assertEqual(node3.attributes[0].value, next(gen3))
  82. self.assertEqual(node3.attributes[1].name, next(gen3))
  83. self.assertEqual(node3.attributes[1].value, next(gen3))
  84. self.assertEqual(node3.attributes[2].name, next(gen3))
  85. self.assertEqual(node1.contents, next(gen1))
  86. self.assertEqual(node2.contents, next(gen2))
  87. self.assertEqual(node1.closing_tag, next(gen1))
  88. self.assertRaises(StopIteration, next, gen1)
  89. self.assertRaises(StopIteration, next, gen2)
  90. self.assertRaises(StopIteration, next, gen3)
  91. def test_strip(self):
  92. """test Tag.__strip__()"""
  93. node1 = Tag(wraptext("i"), wraptext("foobar"))
  94. node2 = Tag(wraptext("math"), wraptext("foobar"))
  95. node3 = Tag(wraptext("br"), self_closing=True)
  96. for a in (True, False):
  97. for b in (True, False):
  98. self.assertEqual("foobar", node1.__strip__(a, b))
  99. self.assertEqual(None, node2.__strip__(a, b))
  100. self.assertEqual(None, node3.__strip__(a, b))
  101. def test_showtree(self):
  102. """test Tag.__showtree__()"""
  103. output = []
  104. getter, marker = object(), object()
  105. get = lambda code: output.append((getter, code))
  106. mark = lambda: output.append(marker)
  107. node1 = Tag(wraptext("ref"), wraptext("text"),
  108. [agen("name", "foo"), agennv("selected")])
  109. node2 = Tag(wraptext("br"), self_closing=True, padding=" ")
  110. node3 = Tag(wraptext("br"), self_closing=True, invalid=True,
  111. implicit=True, padding=" ")
  112. node1.__showtree__(output.append, get, mark)
  113. node2.__showtree__(output.append, get, mark)
  114. node3.__showtree__(output.append, get, mark)
  115. valid = [
  116. "<", (getter, node1.tag), (getter, node1.attributes[0].name),
  117. " = ", marker, (getter, node1.attributes[0].value),
  118. (getter, node1.attributes[1].name), ">", (getter, node1.contents),
  119. "</", (getter, node1.closing_tag), ">", "<", (getter, node2.tag),
  120. "/>", "</", (getter, node3.tag), ">"]
  121. self.assertEqual(valid, output)
  122. def test_tag(self):
  123. """test getter/setter for the tag attribute"""
  124. tag = wraptext("ref")
  125. node = Tag(tag, wraptext("text"))
  126. self.assertIs(tag, node.tag)
  127. self.assertIs(tag, node.closing_tag)
  128. node.tag = "span"
  129. self.assertWikicodeEqual(wraptext("span"), node.tag)
  130. self.assertWikicodeEqual(wraptext("span"), node.closing_tag)
  131. self.assertEqual("<span>text</span>", node)
  132. def test_contents(self):
  133. """test getter/setter for the contents attribute"""
  134. contents = wraptext("text")
  135. node = Tag(wraptext("ref"), contents)
  136. self.assertIs(contents, node.contents)
  137. node.contents = "text and a {{template}}"
  138. parsed = wrap([Text("text and a "), Template(wraptext("template"))])
  139. self.assertWikicodeEqual(parsed, node.contents)
  140. self.assertEqual("<ref>text and a {{template}}</ref>", node)
  141. def test_attributes(self):
  142. """test getter for the attributes attribute"""
  143. attrs = [agen("name", "bar")]
  144. node1 = Tag(wraptext("ref"), wraptext("foo"))
  145. node2 = Tag(wraptext("ref"), wraptext("foo"), attrs)
  146. self.assertEqual([], node1.attributes)
  147. self.assertIs(attrs, node2.attributes)
  148. def test_wiki_markup(self):
  149. """test getter/setter for the wiki_markup attribute"""
  150. node = Tag(wraptext("i"), wraptext("italic text"))
  151. self.assertIs(None, node.wiki_markup)
  152. node.wiki_markup = "''"
  153. self.assertEqual("''", node.wiki_markup)
  154. self.assertEqual("''italic text''", node)
  155. node.wiki_markup = False
  156. self.assertFalse(node.wiki_markup)
  157. self.assertEqual("<i>italic text</i>", node)
  158. def test_self_closing(self):
  159. """test getter/setter for the self_closing attribute"""
  160. node = Tag(wraptext("ref"), wraptext("foobar"))
  161. self.assertFalse(node.self_closing)
  162. node.self_closing = True
  163. self.assertTrue(node.self_closing)
  164. self.assertEqual("<ref/>", node)
  165. node.self_closing = 0
  166. self.assertFalse(node.self_closing)
  167. self.assertEqual("<ref>foobar</ref>", node)
  168. def test_invalid(self):
  169. """test getter/setter for the invalid attribute"""
  170. node = Tag(wraptext("br"), self_closing=True, implicit=True)
  171. self.assertFalse(node.invalid)
  172. node.invalid = True
  173. self.assertTrue(node.invalid)
  174. self.assertEqual("</br>", node)
  175. node.invalid = 0
  176. self.assertFalse(node.invalid)
  177. self.assertEqual("<br>", node)
  178. def test_implicit(self):
  179. """test getter/setter for the implicit attribute"""
  180. node = Tag(wraptext("br"), self_closing=True)
  181. self.assertFalse(node.implicit)
  182. node.implicit = True
  183. self.assertTrue(node.implicit)
  184. self.assertEqual("<br>", node)
  185. node.implicit = 0
  186. self.assertFalse(node.implicit)
  187. self.assertEqual("<br/>", node)
  188. def test_padding(self):
  189. """test getter/setter for the padding attribute"""
  190. node = Tag(wraptext("ref"), wraptext("foobar"))
  191. self.assertEqual("", node.padding)
  192. node.padding = " "
  193. self.assertEqual(" ", node.padding)
  194. self.assertEqual("<ref >foobar</ref>", node)
  195. node.padding = None
  196. self.assertEqual("", node.padding)
  197. self.assertEqual("<ref>foobar</ref>", node)
  198. self.assertRaises(ValueError, setattr, node, "padding", True)
  199. def test_closing_tag(self):
  200. """test getter/setter for the closing_tag attribute"""
  201. tag = wraptext("ref")
  202. node = Tag(tag, wraptext("foobar"))
  203. self.assertIs(tag, node.closing_tag)
  204. node.closing_tag = "ref {{ignore me}}"
  205. parsed = wrap([Text("ref "), Template(wraptext("ignore me"))])
  206. self.assertWikicodeEqual(parsed, node.closing_tag)
  207. self.assertEqual("<ref>foobar</ref {{ignore me}}>", node)
  208. def test_wiki_style_separator(self):
  209. """test getter/setter for wiki_style_separator attribute"""
  210. node = Tag(wraptext("table"), wraptext("\n"))
  211. self.assertIs(None, node.wiki_style_separator)
  212. node.wiki_style_separator = "|"
  213. self.assertEqual("|", node.wiki_style_separator)
  214. node.wiki_markup = "{"
  215. self.assertEqual("{|\n{", node)
  216. node2 = Tag(wraptext("table"), wraptext("\n"), wiki_style_separator="|")
  217. self.assertEqual("|", node.wiki_style_separator)
  218. def test_closing_wiki_markup(self):
  219. """test getter/setter for closing_wiki_markup attribute"""
  220. node = Tag(wraptext("table"), wraptext("\n"))
  221. self.assertIs(None, node.closing_wiki_markup)
  222. node.wiki_markup = "{|"
  223. self.assertEqual("{|", node.closing_wiki_markup)
  224. node.closing_wiki_markup = "|}"
  225. self.assertEqual("|}", node.closing_wiki_markup)
  226. self.assertEqual("{|\n|}", node)
  227. node.wiki_markup = False
  228. self.assertFalse(node.closing_wiki_markup)
  229. self.assertEqual("<table>\n</table>", node)
  230. node2 = Tag(wraptext("table"), wraptext("\n"), wiki_markup="{|",
  231. closing_wiki_markup="|}")
  232. self.assertEqual("|}", node2.closing_wiki_markup)
  233. def test_has(self):
  234. """test Tag.has()"""
  235. node = Tag(wraptext("ref"), wraptext("cite"), [agen("name", "foo")])
  236. self.assertTrue(node.has("name"))
  237. self.assertTrue(node.has(" name "))
  238. self.assertTrue(node.has(wraptext("name")))
  239. self.assertFalse(node.has("Name"))
  240. self.assertFalse(node.has("foo"))
  241. attrs = [agen("id", "foo"), agenp("class", "bar", " ", "\n", "\n"),
  242. agen("foo", "bar"), agenpnv("foo", " ", " \n ", " \t")]
  243. node2 = Tag(wraptext("div"), attrs=attrs, self_closing=True)
  244. self.assertTrue(node2.has("id"))
  245. self.assertTrue(node2.has("class"))
  246. self.assertTrue(node2.has(attrs[1].pad_first + str(attrs[1].name) +
  247. attrs[1].pad_before_eq))
  248. self.assertTrue(node2.has(attrs[3]))
  249. self.assertTrue(node2.has(str(attrs[3])))
  250. self.assertFalse(node2.has("idclass"))
  251. self.assertFalse(node2.has("id class"))
  252. self.assertFalse(node2.has("id=foo"))
  253. def test_get(self):
  254. """test Tag.get()"""
  255. attrs = [agen("name", "foo")]
  256. node = Tag(wraptext("ref"), wraptext("cite"), attrs)
  257. self.assertIs(attrs[0], node.get("name"))
  258. self.assertIs(attrs[0], node.get(" name "))
  259. self.assertIs(attrs[0], node.get(wraptext("name")))
  260. self.assertRaises(ValueError, node.get, "Name")
  261. self.assertRaises(ValueError, node.get, "foo")
  262. attrs = [agen("id", "foo"), agenp("class", "bar", " ", "\n", "\n"),
  263. agen("foo", "bar"), agenpnv("foo", " ", " \n ", " \t")]
  264. node2 = Tag(wraptext("div"), attrs=attrs, self_closing=True)
  265. self.assertIs(attrs[0], node2.get("id"))
  266. self.assertIs(attrs[1], node2.get("class"))
  267. self.assertIs(attrs[1], node2.get(
  268. attrs[1].pad_first + str(attrs[1].name) + attrs[1].pad_before_eq))
  269. self.assertIs(attrs[3], node2.get(attrs[3]))
  270. self.assertIs(attrs[3], node2.get(str(attrs[3])))
  271. self.assertIs(attrs[3], node2.get(" foo"))
  272. self.assertRaises(ValueError, node2.get, "idclass")
  273. self.assertRaises(ValueError, node2.get, "id class")
  274. self.assertRaises(ValueError, node2.get, "id=foo")
  275. def test_add(self):
  276. """test Tag.add()"""
  277. node = Tag(wraptext("ref"), wraptext("cite"))
  278. node.add("name", "value")
  279. node.add("name", "value", quotes=None)
  280. node.add("name", "value", quotes="'")
  281. node.add("name")
  282. node.add(1, False)
  283. node.add("style", "{{foobar}}")
  284. node.add("name", "value", '"', "\n", " ", " ")
  285. attr1 = ' name="value"'
  286. attr2 = " name=value"
  287. attr3 = " name='value'"
  288. attr4 = " name"
  289. attr5 = ' 1="False"'
  290. attr6 = ' style="{{foobar}}"'
  291. attr7 = '\nname = "value"'
  292. self.assertEqual(attr1, node.attributes[0])
  293. self.assertEqual(attr2, node.attributes[1])
  294. self.assertEqual(attr3, node.attributes[2])
  295. self.assertEqual(attr4, node.attributes[3])
  296. self.assertEqual(attr5, node.attributes[4])
  297. self.assertEqual(attr6, node.attributes[5])
  298. self.assertEqual(attr7, node.attributes[6])
  299. self.assertEqual(attr7, node.get("name"))
  300. self.assertWikicodeEqual(wrap([Template(wraptext("foobar"))]),
  301. node.attributes[5].value)
  302. self.assertEqual("".join(("<ref", attr1, attr2, attr3, attr4, attr5,
  303. attr6, attr7, ">cite</ref>")), node)
  304. self.assertRaises(ValueError, node.add, "name", "foo", quotes="bar")
  305. self.assertRaises(ValueError, node.add, "name", "a bc d", quotes=None)
  306. def test_remove(self):
  307. """test Tag.remove()"""
  308. attrs = [agen("id", "foo"), agenp("class", "bar", " ", "\n", "\n"),
  309. agen("foo", "bar"), agenpnv("foo", " ", " \n ", " \t")]
  310. node = Tag(wraptext("div"), attrs=attrs, self_closing=True)
  311. node.remove("class")
  312. self.assertEqual('<div id="foo" foo="bar" foo \n />', node)
  313. node.remove("foo")
  314. self.assertEqual('<div id="foo"/>', node)
  315. self.assertRaises(ValueError, node.remove, "foo")
  316. node.remove("id")
  317. self.assertEqual('<div/>', node)
  318. if __name__ == "__main__":
  319. unittest.main(verbosity=2)