jenkins-bot submitted this change.
[PEP8] rename transliteration.transliterator to Transliterator
Change-Id: I5fb4b651360e32f4d65d07f2d5c35e494cb6c28f
---
M ROADMAP.rst
M pywikibot/userinterfaces/terminal_interface_base.py
M pywikibot/userinterfaces/transliteration.py
3 files changed, 21 insertions(+), 4 deletions(-)
diff --git a/ROADMAP.rst b/ROADMAP.rst
index 5c244b1..65f3950 100644
--- a/ROADMAP.rst
+++ b/ROADMAP.rst
@@ -28,9 +28,11 @@
Breaking changes and code cleanups
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+* ``userinterfaces.transliteration.transliterator`` was renamed to :class:`Transliterator
+ <userinterfaces.transliteration.Transliterator>`
* ``pywikibot.BaseSite`` and ``pywikibotAPISite`` were dropped. :func:`pywikibot.Site` has to be used to create a
:mod:`site` object.
-* ``next`` parameter of :meth:`userinterfaces.transliteration.transliterator.transliterate` was renamed to ``succ``
+* ``next`` parameter of :meth:`userinterfaces.transliteration.Transliterator.transliterate` was renamed to ``succ``
* ``type`` parameter of :meth:`site.APISite.protectedpages()<pywikibot.site._generators.GeneratorsMixin.protectedpages>`
was renamed to ``protect_type``
* ``all`` parameter of :meth:`site.APISite.namespace()<pywikibot.site._apisite.APISite.namespace>` was renamed to
@@ -65,6 +67,8 @@
Deprecations
------------
+* 9.0.0: ``userinterfaces.transliteration.transliterator`` was renamed to :class:`Transliterator
+ <userinterfaces.transliteration.Transliterator>`
* 9.0.0: ``next`` parameter of :meth:`userinterfaces.transliteration.transliterator.transliterate` was renamed to
``succ``
* 9.0.0: ``type`` parameter of :meth:`site.APISite.protectedpages()
diff --git a/pywikibot/userinterfaces/terminal_interface_base.py b/pywikibot/userinterfaces/terminal_interface_base.py
index 83f7f4a..fb76bf3 100644
--- a/pywikibot/userinterfaces/terminal_interface_base.py
+++ b/pywikibot/userinterfaces/terminal_interface_base.py
@@ -30,7 +30,7 @@
from pywikibot.userinterfaces._interface_base import ABUIC
-transliterator = transliteration.transliterator(config.console_encoding)
+transliterator = transliteration.Transliterator(config.console_encoding)
#: Colors supported by Pywikibot
colors = [
diff --git a/pywikibot/userinterfaces/transliteration.py b/pywikibot/userinterfaces/transliteration.py
index 0bbc083..4ad1d85 100644
--- a/pywikibot/userinterfaces/transliteration.py
+++ b/pywikibot/userinterfaces/transliteration.py
@@ -6,7 +6,7 @@
#
from __future__ import annotations
-from pywikibot.tools import deprecate_arg
+from pywikibot.tools import ModuleDeprecationWrapper, deprecate_arg
#: Non latin digits used by the framework
@@ -1100,7 +1100,7 @@
_trans.update({char: str(i) for i, char in enumerate(digits)})
-class transliterator: # noqa: N801
+class Transliterator:
"""Class to transliterating text."""
@@ -1150,3 +1150,7 @@
elif char == 'ຫ':
result = '' if next in 'ງຍນຣລຼຼວ' else 'h'
return result
+
+
+wrapper = ModuleDeprecationWrapper(__name__)
+wrapper.add_deprecated_attr('transliterator', Transliterator, since='9.0.0')
To view, visit change 994673. To unsubscribe, or for help writing mail filters, visit settings.