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.

300 lines
13KB

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