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.
 
 
 
 
 

342 lines
15 KiB

  1. Changelog
  2. =========
  3. v0.6
  4. ----
  5. Unreleased
  6. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.5.4...develop>`__):
  7. - Added support for Python 3.8.
  8. - Updated Wikicode.matches() to recognize underscores as being equivalent
  9. to spaces. (`#216 <https://github.com/earwig/mwparserfromhell/issues/216>`_)
  10. - Fixed a rare parsing bug involving deeply nested style tags.
  11. (`#224 <https://github.com/earwig/mwparserfromhell/issues/224>`_)
  12. v0.5.4
  13. ------
  14. `Released May 15, 2019 <https://github.com/earwig/mwparserfromhell/tree/v0.5.4>`_
  15. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.5.3...v0.5.4>`__):
  16. - Fixed an unlikely crash in the C tokenizer when interrupted while parsing
  17. a heading.
  18. v0.5.3
  19. ------
  20. `Released March 30, 2019 <https://github.com/earwig/mwparserfromhell/tree/v0.5.3>`_
  21. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.5.2...v0.5.3>`__):
  22. - Fixed manual construction of Node objects, previously unsupported.
  23. (`#214 <https://github.com/earwig/mwparserfromhell/issues/214>`_)
  24. - Fixed :class:`.Wikicode` transformation methods (:meth:`.Wikicode.replace`,
  25. :meth:`.Wikicode.remove`, etc.) when passed an empty section as an argument.
  26. (`#212 <https://github.com/earwig/mwparserfromhell/issues/212>`_)
  27. - Fixed the parser getting stuck inside malformed tables.
  28. (`#206 <https://github.com/earwig/mwparserfromhell/issues/206>`_)
  29. v0.5.2
  30. ------
  31. `Released November 1, 2018 <https://github.com/earwig/mwparserfromhell/tree/v0.5.2>`_
  32. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.5.1...v0.5.2>`__):
  33. - Dropped support for end-of-life Python versions 2.6, 3.2, 3.3.
  34. (`#199 <https://github.com/earwig/mwparserfromhell/issues/199>`_,
  35. `#204 <https://github.com/earwig/mwparserfromhell/pull/204>`_)
  36. - Fixed signals getting stuck inside the C tokenizer until parsing finishes,
  37. in pathological cases.
  38. (`#206 <https://github.com/earwig/mwparserfromhell/issues/206>`_)
  39. - Fixed `<wbr>` not being considered a single-only tag.
  40. (`#200 <https://github.com/earwig/mwparserfromhell/pull/200>`_)
  41. - Fixed a C tokenizer crash on Python 3.7 when compiled with assertions.
  42. (`#208 <https://github.com/earwig/mwparserfromhell/issues/208>`_)
  43. - Cleaned up some minor documentation issues.
  44. (`#207 <https://github.com/earwig/mwparserfromhell/pull/207>`_)
  45. v0.5.1
  46. ------
  47. `Released March 3, 2018 <https://github.com/earwig/mwparserfromhell/tree/v0.5.1>`_
  48. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.5...v0.5.1>`__):
  49. - Improved behavior when adding parameters to templates (via
  50. :meth:`.Template.add`) with poorly formatted whitespace conventions.
  51. (`#185 <https://github.com/earwig/mwparserfromhell/issues/185>`_)
  52. - Fixed the parser getting stuck in deeply nested HTML tags with unclosed,
  53. quoted attributes.
  54. (`#190 <https://github.com/earwig/mwparserfromhell/issues/190>`_)
  55. v0.5
  56. ----
  57. `Released June 23, 2017 <https://github.com/earwig/mwparserfromhell/tree/v0.5>`_
  58. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.4.4...v0.5>`__):
  59. - Added :meth:`.Wikicode.contains` to determine whether a :class:`.Node` or
  60. :class:`.Wikicode` object is contained within another :class:`.Wikicode`
  61. object.
  62. - Added :meth:`.Wikicode.get_ancestors` and :meth:`.Wikicode.get_parent` to
  63. find all ancestors and the direct parent of a :class:`.Node`, respectively.
  64. - Fixed a long-standing performance issue with deeply nested, invalid syntax
  65. (`issue #42 <https://github.com/earwig/mwparserfromhell/issues/42>`_). The
  66. parser should be much faster on certain complex pages. The "max cycle"
  67. restriction has also been removed, so some situations where templates at the
  68. end of a page were being skipped are now resolved.
  69. - Made :meth:`Template.remove(keep_field=True) <.Template.remove>` behave more
  70. reasonably when the parameter is already empty.
  71. - Added the *keep_template_params* argument to :meth:`.Wikicode.strip_code`.
  72. If *True*, then template parameters will be preserved in the output.
  73. - :class:`.Wikicode` objects can now be pickled properly (fixed infinite
  74. recursion error on incompletely-constructed :class:`.StringMixIn`
  75. subclasses).
  76. - Fixed :meth:`.Wikicode.matches`\ 's behavior on iterables besides lists and
  77. tuples.
  78. - Fixed ``len()`` sometimes raising ``ValueError`` on empty node lists.
  79. - Fixed a rare parsing bug involving self-closing tags inside the attributes of
  80. unpaired tags.
  81. - Fixed release script after changes to PyPI.
  82. v0.4.4
  83. ------
  84. `Released December 30, 2016 <https://github.com/earwig/mwparserfromhell/tree/v0.4.4>`_
  85. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.4.3...v0.4.4>`__):
  86. - Added support for Python 3.6.
  87. - Fixed parsing bugs involving:
  88. - wikitables nested in templates;
  89. - wikitable error recovery when unable to recurse;
  90. - templates nested in template parameters before other parameters.
  91. - Fixed parsing file-like objects.
  92. - Made builds deterministic.
  93. - Documented caveats.
  94. v0.4.3
  95. ------
  96. `Released October 29, 2015 <https://github.com/earwig/mwparserfromhell/tree/v0.4.3>`_
  97. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.4.2...v0.4.3>`__):
  98. - Added Windows binaries for Python 3.5.
  99. - Fixed edge cases involving wikilinks inside of external links and vice versa.
  100. - Fixed a C tokenizer crash when a keyboard interrupt happens while parsing.
  101. v0.4.2
  102. ------
  103. `Released July 30, 2015 <https://github.com/earwig/mwparserfromhell/tree/v0.4.2>`__
  104. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.4.1...v0.4.2>`__):
  105. - Fixed setup script not including header files in releases.
  106. - Fixed Windows binary uploads.
  107. v0.4.1
  108. ------
  109. `Released July 30, 2015 <https://github.com/earwig/mwparserfromhell/tree/v0.4.1>`__
  110. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.4...v0.4.1>`__):
  111. - The process for building Windows binaries has been fixed, and these should be
  112. distributed along with new releases. Windows users can now take advantage of
  113. C speedups without having a compiler of their own.
  114. - Added support for Python 3.5.
  115. - ``<`` and ``>`` are now disallowed in wikilink titles and template names.
  116. This includes when denoting tags, but not comments.
  117. - Fixed the behavior of *preserve_spacing* in :meth:`.Template.add` and
  118. *keep_field* in :meth:`.Template.remove` on parameters with hidden keys.
  119. - Removed :meth:`._ListProxy.detach`. :class:`.SmartList`\ s now use weak
  120. references and their children are garbage-collected properly.
  121. - Fixed parser bugs involving:
  122. - templates with completely blank names;
  123. - templates with newlines and comments.
  124. - Heavy refactoring and fixes to the C tokenizer, including:
  125. - corrected a design flaw in text handling, allowing for substantial speed
  126. improvements when parsing long strings of plain text;
  127. - implemented new Python 3.3
  128. `PEP 393 <https://www.python.org/dev/peps/pep-0393/>`_ Unicode APIs.
  129. - Fixed various bugs in :class:`.SmartList`, including one that was causing
  130. memory issues on 64-bit builds of Python 2 on Windows.
  131. - Fixed some bugs in the release scripts.
  132. v0.4
  133. ----
  134. `Released May 23, 2015 <https://github.com/earwig/mwparserfromhell/tree/v0.4>`_
  135. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.3.3...v0.4>`__):
  136. - The parser now falls back on pure Python mode if C extensions cannot be
  137. built. This fixes an issue that prevented some Windows users from installing
  138. the parser.
  139. - Added support for parsing wikicode tables (patches by David Winegar).
  140. - Added a script to test for memory leaks in :file:`scripts/memtest.py`.
  141. - Added a script to do releases in :file:`scripts/release.sh`.
  142. - *skip_style_tags* can now be passed to :func:`mwparserfromhell.parse()
  143. <.parse_anything>` (previously, only :meth:`.Parser.parse` allowed it).
  144. - The *recursive* argument to :class:`Wikicode's <.Wikicode>` :meth:`.filter`
  145. methods now accepts a third option, ``RECURSE_OTHERS``, which recurses over
  146. all children except instances of *forcetype* (for example,
  147. ``code.filter_templates(code.RECURSE_OTHERS)`` returns all un-nested
  148. templates).
  149. - The parser now understands HTML tag attributes quoted with single quotes.
  150. When setting a tag attribute's value, quotes will be added if necessary. As
  151. part of this, :class:`.Attribute`\ 's :attr:`~.Attribute.quoted` attribute
  152. has been changed to :attr:`~.Attribute.quotes`, and is now either a string or
  153. ``None``.
  154. - Calling :meth:`.Template.remove` with a :class:`.Parameter` object that is
  155. not part of the template now raises :exc:`ValueError` instead of doing
  156. nothing.
  157. - :class:`.Parameter`\ s with non-integer keys can no longer be created with
  158. *showkey=False*, nor have the value of this attribute be set to *False*
  159. later.
  160. - :meth:`._ListProxy.destroy` has been changed to :meth:`._ListProxy.detach`,
  161. and now works in a more useful way.
  162. - If something goes wrong while parsing, :exc:`.ParserError` will now be
  163. raised. Previously, the parser would produce an unclear :exc:`.BadRoute`
  164. exception or allow an incorrect node tree to be build.
  165. - Fixed parser bugs involving:
  166. - nested tags;
  167. - comments in template names;
  168. - tags inside of ``<nowiki>`` tags.
  169. - Added tests to ensure that parsed trees convert back to wikicode without
  170. unintentional modifications.
  171. - Added support for a :envvar:`NOWEB` environment variable, which disables a
  172. unit test that makes a web call.
  173. - Test coverage has been improved, and some minor related bugs have been fixed.
  174. - Updated and fixed some documentation.
  175. v0.3.3
  176. ------
  177. `Released April 22, 2014 <https://github.com/earwig/mwparserfromhell/tree/v0.3.3>`_
  178. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.3.2...v0.3.3>`__):
  179. - Added support for Python 2.6 and 3.4.
  180. - :meth:`.Template.has` is now passed *ignore_empty=False* by default
  181. instead of *True*. This fixes a bug when adding parameters to templates with
  182. empty fields, **and is a breaking change if you rely on the default
  183. behavior.**
  184. - The *matches* argument of :class:`Wikicode's <.Wikicode>` :meth:`.filter`
  185. methods now accepts a function (taking one argument, a :class:`.Node`, and
  186. returning a bool) in addition to a regex.
  187. - Re-added *flat* argument to :meth:`.Wikicode.get_sections`, fixed the order
  188. in which it returns sections, and made it faster.
  189. - :meth:`.Wikicode.matches` now accepts a tuple or list of
  190. strings/:class:`.Wikicode` objects instead of just a single string or
  191. :class:`.Wikicode`.
  192. - Given the frequency of issues with the (admittedly insufficient) tag parser,
  193. there's a temporary *skip_style_tags* argument to :meth:`~.Parser.parse` that
  194. ignores ``''`` and ``'''`` until these issues are corrected.
  195. - Fixed a parser bug involving nested wikilinks and external links.
  196. - C code cleanup and speed improvements.
  197. v0.3.2
  198. ------
  199. `Released September 1, 2013 <https://github.com/earwig/mwparserfromhell/tree/v0.3.2>`_
  200. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.3.1...v0.3.2>`__):
  201. - Added support for Python 3.2 (along with current support for 3.3 and 2.7).
  202. - Renamed :meth:`.Template.remove`\ 's first argument from *name* to *param*,
  203. which now accepts :class:`.Parameter` objects in addition to parameter name
  204. strings.
  205. v0.3.1
  206. ------
  207. `Released August 29, 2013 <https://github.com/earwig/mwparserfromhell/tree/v0.3.1>`_
  208. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.3...v0.3.1>`__):
  209. - Fixed a parser bug involving URLs nested inside other markup.
  210. - Fixed some typos.
  211. v0.3
  212. ----
  213. `Released August 24, 2013 <https://github.com/earwig/mwparserfromhell/tree/v0.3>`_
  214. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.2...v0.3>`__):
  215. - Added complete support for HTML :class:`Tags <.Tag>`, including forms like
  216. ``<ref>foo</ref>``, ``<ref name="bar"/>``, and wiki-markup tags like bold
  217. (``'''``), italics (``''``), and lists (``*``, ``#``, ``;`` and ``:``).
  218. - Added support for :class:`.ExternalLink`\ s (``http://example.com/`` and
  219. ``[http://example.com/ Example]``).
  220. - :class:`Wikicode's <.Wikicode>` :meth:`.filter` methods are now passed
  221. *recursive=True* by default instead of *False*. **This is a breaking change
  222. if you rely on any filter() methods being non-recursive by default.**
  223. - Added a :meth:`.matches` method to :class:`.Wikicode` for page/template name
  224. comparisons.
  225. - The *obj* param of :meth:`.Wikicode.insert_before`, :meth:`.insert_after`,
  226. :meth:`~.Wikicode.replace`, and :meth:`~.Wikicode.remove` now accepts
  227. :class:`.Wikicode` objects and strings representing parts of wikitext,
  228. instead of just nodes. These methods also make all possible substitutions
  229. instead of just one.
  230. - Renamed :meth:`.Template.has_param` to :meth:`~.Template.has` for consistency
  231. with :class:`.Template`\ 's other methods; :meth:`.has_param` is now an
  232. alias.
  233. - The C tokenizer extension now works on Python 3 in addition to Python 2.7.
  234. - Various bugfixes, internal changes, and cleanup.
  235. v0.2
  236. ----
  237. `Released June 20, 2013 <https://github.com/earwig/mwparserfromhell/tree/v0.2>`_
  238. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.1.1...v0.2>`__):
  239. - The parser now fully supports Python 3 in addition to Python 2.7.
  240. - Added a C tokenizer extension that is significantly faster than its Python
  241. equivalent. It is enabled by default (if available) and can be toggled by
  242. setting :attr:`mwparserfromhell.parser.use_c` to a boolean value.
  243. - Added a complete set of unit tests covering parsing and wikicode
  244. manipulation.
  245. - Renamed :meth:`.filter_links` to :meth:`.filter_wikilinks` (applies to
  246. :meth:`.ifilter` as well).
  247. - Added filter methods for :class:`Arguments <.Argument>`,
  248. :class:`Comments <.Comment>`, :class:`Headings <.Heading>`, and
  249. :class:`HTMLEntities <.HTMLEntity>`.
  250. - Added *before* param to :meth:`.Template.add`; renamed *force_nonconformity*
  251. to *preserve_spacing*.
  252. - Added *include_lead* param to :meth:`.Wikicode.get_sections`.
  253. - Removed *flat* param from :meth:`.get_sections`.
  254. - Removed *force_no_field* param from :meth:`.Template.remove`.
  255. - Added support for Travis CI.
  256. - Added note about Windows build issue in the README.
  257. - The tokenizer will limit itself to a realistic recursion depth to prevent
  258. errors and unreasonably long parse times.
  259. - Fixed how some nodes' attribute setters handle input.
  260. - Fixed multiple bugs in the tokenizer's handling of invalid markup.
  261. - Fixed bugs in the implementation of :class:`.SmartList` and
  262. :class:`.StringMixIn`.
  263. - Fixed some broken example code in the README; other copyedits.
  264. - Other bugfixes and code cleanup.
  265. v0.1.1
  266. ------
  267. `Released September 21, 2012 <https://github.com/earwig/mwparserfromhell/tree/v0.1.1>`_
  268. (`changes <https://github.com/earwig/mwparserfromhell/compare/v0.1...v0.1.1>`__):
  269. - Added support for :class:`Comments <.Comment>` (``<!-- foo -->``) and
  270. :class:`Wikilinks <.Wikilink>` (``[[foo]]``).
  271. - Added corresponding :meth:`.ifilter_links` and :meth:`.filter_links` methods
  272. to :class:`.Wikicode`.
  273. - Fixed a bug when parsing incomplete templates.
  274. - Fixed :meth:`.strip_code` to affect the contents of headings.
  275. - Various copyedits in documentation and comments.
  276. v0.1
  277. ----
  278. `Released August 23, 2012 <https://github.com/earwig/mwparserfromhell/tree/v0.1>`_:
  279. - Initial release.