A Python parser for MediaWiki wikicode https://mwparserfromhell.readthedocs.io/
Não pode escolher mais do que 25 tópicos Os tópicos devem começar com uma letra ou um número, podem incluir traços ('-') e podem ter até 35 caracteres.

README.rst 8.0 KiB

há 12 anos
há 11 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
há 12 anos
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218
  1. mwparserfromhell
  2. ================
  3. .. image:: https://img.shields.io/travis/earwig/mwparserfromhell/develop.svg
  4. :alt: Build Status
  5. :target: https://travis-ci.org/earwig/mwparserfromhell
  6. .. image:: https://img.shields.io/coveralls/earwig/mwparserfromhell/develop.svg
  7. :alt: Coverage Status
  8. :target: https://coveralls.io/r/earwig/mwparserfromhell
  9. **mwparserfromhell** (the *MediaWiki Parser from Hell*) is a Python package
  10. that provides an easy-to-use and outrageously powerful parser for MediaWiki_
  11. wikicode. It supports Python 3.4+.
  12. Developed by Earwig_ with contributions from `Σ`_, Legoktm_, and others.
  13. Full documentation is available on ReadTheDocs_. Development occurs on GitHub_.
  14. Installation
  15. ------------
  16. The easiest way to install the parser is through the `Python Package Index`_;
  17. you can install the latest release with ``pip install mwparserfromhell``
  18. (`get pip`_). Make sure your pip is up-to-date first, especially on Windows.
  19. Alternatively, get the latest development version::
  20. git clone https://github.com/earwig/mwparserfromhell.git
  21. cd mwparserfromhell
  22. python setup.py install
  23. You can run the comprehensive unit testing suite with
  24. ``python -m unittest discover``.
  25. Usage
  26. -----
  27. Normal usage is rather straightforward (where ``text`` is page text):
  28. >>> import mwparserfromhell
  29. >>> wikicode = mwparserfromhell.parse(text)
  30. ``wikicode`` is a ``mwparserfromhell.Wikicode`` object, which acts like an
  31. ordinary ``str`` object with some extra methods.
  32. For example:
  33. >>> text = "I has a template! {{foo|bar|baz|eggs=spam}} See it?"
  34. >>> wikicode = mwparserfromhell.parse(text)
  35. >>> print(wikicode)
  36. I has a template! {{foo|bar|baz|eggs=spam}} See it?
  37. >>> templates = wikicode.filter_templates()
  38. >>> print(templates)
  39. ['{{foo|bar|baz|eggs=spam}}']
  40. >>> template = templates[0]
  41. >>> print(template.name)
  42. foo
  43. >>> print(template.params)
  44. ['bar', 'baz', 'eggs=spam']
  45. >>> print(template.get(1).value)
  46. bar
  47. >>> print(template.get("eggs").value)
  48. spam
  49. Since nodes can contain other nodes, getting nested templates is trivial:
  50. >>> text = "{{foo|{{bar}}={{baz|{{spam}}}}}}"
  51. >>> mwparserfromhell.parse(text).filter_templates()
  52. ['{{foo|{{bar}}={{baz|{{spam}}}}}}', '{{bar}}', '{{baz|{{spam}}}}', '{{spam}}']
  53. You can also pass ``recursive=False`` to ``filter_templates()`` and explore
  54. templates manually. This is possible because nodes can contain additional
  55. ``Wikicode`` objects:
  56. >>> code = mwparserfromhell.parse("{{foo|this {{includes a|template}}}}")
  57. >>> print(code.filter_templates(recursive=False))
  58. ['{{foo|this {{includes a|template}}}}']
  59. >>> foo = code.filter_templates(recursive=False)[0]
  60. >>> print(foo.get(1).value)
  61. this {{includes a|template}}
  62. >>> print(foo.get(1).value.filter_templates()[0])
  63. {{includes a|template}}
  64. >>> print(foo.get(1).value.filter_templates()[0].get(1).value)
  65. template
  66. Templates can be easily modified to add, remove, or alter params. ``Wikicode``
  67. objects can be treated like lists, with ``append()``, ``insert()``,
  68. ``remove()``, ``replace()``, and more. They also have a ``matches()`` method
  69. for comparing page or template names, which takes care of capitalization and
  70. whitespace:
  71. >>> text = "{{cleanup}} '''Foo''' is a [[bar]]. {{uncategorized}}"
  72. >>> code = mwparserfromhell.parse(text)
  73. >>> for template in code.filter_templates():
  74. ... if template.name.matches("Cleanup") and not template.has("date"):
  75. ... template.add("date", "July 2012")
  76. ...
  77. >>> print(code)
  78. {{cleanup|date=July 2012}} '''Foo''' is a [[bar]]. {{uncategorized}}
  79. >>> code.replace("{{uncategorized}}", "{{bar-stub}}")
  80. >>> print(code)
  81. {{cleanup|date=July 2012}} '''Foo''' is a [[bar]]. {{bar-stub}}
  82. >>> print(code.filter_templates())
  83. ['{{cleanup|date=July 2012}}', '{{bar-stub}}']
  84. You can then convert ``code`` back into a regular ``str`` object (for
  85. saving the page!) by calling ``str()`` on it:
  86. >>> text = str(code)
  87. >>> print(text)
  88. {{cleanup|date=July 2012}} '''Foo''' is a [[bar]]. {{bar-stub}}
  89. >>> text == code
  90. True
  91. Limitations
  92. -----------
  93. While the MediaWiki parser generates HTML and has access to the contents of
  94. templates, among other things, mwparserfromhell acts as a direct interface to
  95. the source code only. This has several implications:
  96. * Syntax elements produced by a template transclusion cannot be detected. For
  97. example, imagine a hypothetical page ``"Template:End-bold"`` that contained
  98. the text ``</b>``. While MediaWiki would correctly understand that
  99. ``<b>foobar{{end-bold}}`` translates to ``<b>foobar</b>``, mwparserfromhell
  100. has no way of examining the contents of ``{{end-bold}}``. Instead, it would
  101. treat the bold tag as unfinished, possibly extending further down the page.
  102. * Templates adjacent to external links, as in ``http://example.com{{foo}}``,
  103. are considered part of the link. In reality, this would depend on the
  104. contents of the template.
  105. * When different syntax elements cross over each other, as in
  106. ``{{echo|''Hello}}, world!''``, the parser gets confused because this cannot
  107. be represented by an ordinary syntax tree. Instead, the parser will treat the
  108. first syntax construct as plain text. In this case, only the italic tag would
  109. be properly parsed.
  110. **Workaround:** Since this commonly occurs with text formatting and text
  111. formatting is often not of interest to users, you may pass
  112. *skip_style_tags=True* to ``mwparserfromhell.parse()``. This treats ``''``
  113. and ``'''`` as plain text.
  114. A future version of mwparserfromhell may include multiple parsing modes to
  115. get around this restriction more sensibly.
  116. Additionally, the parser lacks awareness of certain wiki-specific settings:
  117. * `Word-ending links`_ are not supported, since the linktrail rules are
  118. language-specific.
  119. * Localized namespace names aren't recognized, so file links (such as
  120. ``[[File:...]]``) are treated as regular wikilinks.
  121. * Anything that looks like an XML tag is treated as a tag, even if it is not a
  122. recognized tag name, since the list of valid tags depends on loaded MediaWiki
  123. extensions.
  124. Integration
  125. -----------
  126. ``mwparserfromhell`` is used by and originally developed for EarwigBot_;
  127. ``Page`` objects have a ``parse`` method that essentially calls
  128. ``mwparserfromhell.parse()`` on ``page.get()``.
  129. If you're using Pywikibot_, your code might look like this:
  130. .. code-block:: python
  131. import mwparserfromhell
  132. import pywikibot
  133. def parse(title):
  134. site = pywikibot.Site()
  135. page = pywikibot.Page(site, title)
  136. text = page.get()
  137. return mwparserfromhell.parse(text)
  138. If you're not using a library, you can parse any page with the following
  139. Python 3 code (using the API_ and the requests_ library):
  140. .. code-block:: python
  141. import mwparserfromhell
  142. import requests
  143. API_URL = "https://en.wikipedia.org/w/api.php"
  144. def parse(title):
  145. params = {
  146. "action": "query",
  147. "prop": "revisions",
  148. "rvprop": "content",
  149. "rvslots": "main",
  150. "rvlimit": 1,
  151. "titles": title,
  152. "format": "json",
  153. "formatversion": "2",
  154. }
  155. headers = {"User-Agent": "My-Bot-Name/1.0"}
  156. req = requests.get(API_URL, headers=headers, params=params)
  157. res = req.json()
  158. revision = res["query"]["pages"][0]["revisions"][0]
  159. text = revision["slots"]["main"]["content"]
  160. return mwparserfromhell.parse(text)
  161. .. _MediaWiki: https://www.mediawiki.org
  162. .. _ReadTheDocs: https://mwparserfromhell.readthedocs.io
  163. .. _Earwig: https://en.wikipedia.org/wiki/User:The_Earwig
  164. .. _Σ: https://en.wikipedia.org/wiki/User:%CE%A3
  165. .. _Legoktm: https://en.wikipedia.org/wiki/User:Legoktm
  166. .. _GitHub: https://github.com/earwig/mwparserfromhell
  167. .. _Python Package Index: https://pypi.org/
  168. .. _get pip: https://pypi.org/project/pip/
  169. .. _Word-ending links: https://www.mediawiki.org/wiki/Help:Links#linktrail
  170. .. _EarwigBot: https://github.com/earwig/earwigbot
  171. .. _Pywikibot: https://www.mediawiki.org/wiki/Manual:Pywikibot
  172. .. _API: https://www.mediawiki.org/wiki/API:Main_page
  173. .. _requests: https://2.python-requests.org