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.
 
 
 
 

352 regels
15 KiB

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