https://github.com/nguoidungkhongdinhdanh/mwtp

A parser for MediaWiki titles
https://github.com/nguoidungkhongdinhdanh/mwtp

mediawiki parser

Last synced: about 1 month ago
JSON representation

A parser for MediaWiki titles

• Host: GitHub
• URL: https://github.com/nguoidungkhongdinhdanh/mwtp
• Owner: NguoiDungKhongDinhDanh
• License: gpl-3.0
• Created: 2023-10-17T16:05:51.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-15T10:47:33.000Z (10 months ago)
• Last Synced: 2024-12-17T05:47:19.163Z (about 1 month ago)
• Topics: mediawiki, parser
• Language: Python
• Homepage: https://mwtp.readthedocs.io
• Size: 123 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# MediaWikiTitleParser

![Documentation status](https://readthedocs.org/projects/mwtp/badge/?version=latest)

![Tests](https://github.com/NguoiDungKhongDinhDanh/mwtp/actions/workflows/tests.yaml/badge.svg)

![License](https://img.shields.io/pypi/l/mwtp.svg)

![Supported versions](https://img.shields.io/pypi/pyversions/mwtp.svg)

MWTP is a parser for MediaWiki titles. Its logic is partly derived from

[mediawiki.Title][1], and hence is licensed under GNU GPL.

It works as simple as follows:

```python

from mwtp import TitleParser as Parser

parser = Parser(namespaces_data, namespace_aliases)

title = parser.parse(' _ FoO: this/is A__/talk page _ ')

print(repr(title))

# Title('Thảo luận:This/is A /talk page')

```

`namespaces_data` and `namespace_aliases` can be obtained by

making a query to [a wiki's API][2] with

`action=query&meta=siteinfo&siprop=namespaces|namespacealiases`:

```python

namespaces_data = {

  '0': { 'id': 0, 'case': 'first-letter', 'name': '',          ...: ... },

  '1': { 'id': 1, 'case': 'first-letter', 'name': 'Thảo luận', ...: ... },

  ...: ...

}

```

```python

namespace_aliases = [

  { 'id': 1, 'alias': 'Foo' },

  ...

]

```

Note that the following format (`&formatversion=1`) is not supported.

Always use `&formatversion=2` or `&formatversion=latest`.

```python

namespaces_data = {

  '0': { 'id': 0, 'case': 'first-letter', '*': '',          ...: ... },

  '1': { 'id': 1, 'case': 'first-letter', '*': 'Thảo luận', ...: ... },

  ...: ...

}

namespace_aliases = [

  { 'id': 1, '*': 'Foo' },

  ...

]

```

For more information, see [the documentation][3].

[1]: https://github.com/wikimedia/mediawiki/tree/c237f0548845662759bfcc6419cec9ca02d03c18/resources/src/mediawiki.Title

[2]: https://www.mediawiki.org/wiki/Special:ApiSandbox#action=query&meta=siteinfo&siprop=namespaces%7Cnamespacealiases

[3]: https://mwtp.readthedocs.io/