Skip to content

Commit 3d6d402

Browse files
xqtxqt
committed
doc: Update ROADMAP.rst and CHANGELOG.rst
Change-Id: I8ccd50a16ae2ab2a63405f1ce61053d508e56abc
1 parent f3d3f23 commit 3d6d402

File tree

2 files changed

+90
-49
lines changed

2 files changed

+90
-49
lines changed

‎ROADMAP.rst‎

Lines changed: 80 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,118 @@
11
Current Release Changes
22
=======================
33

4+
* Refactor the :class:`throttle.Trottle` class (:phab:`T289318`)
5+
* L10N-Updates: add language aliases for ``gsw``, ``sgs``, ``vro``, ``rup`` and ``lzh``
6+
to :class:`family.WikimediaFamily` family class
7+
(:phab:`T399411`, :phab:`T399438`, :phab:`T399444`, :phab:`T399693`, :phab:`T399697` )
8+
* Refactor HTML removal logic in :func:`textlib.removeHTMLParts` using :class:`textlib.GetDataHTML`
9+
parser; *removetags* parameter was introduced to remove specified tag blocks (:phab:`T399378`)
10+
* Refactor :class:`echo.Notification` and fix :meth:`mark_as_read()<echo.Notification.mark_as_read>`
11+
method (:phab:`T398770`)
12+
* Update beta domains in family files from beta.wmflabs.org to beta.wmcloud.org (:phab:`T289318`)
413
* ``textlib.to_latin_digits()`` was renamed to :func:`textlib.to_ascii_digits` (:phab:`T398146#10958283`),
5-
``NON_LATIN_DIGITS`` of :mod:`userinterfaces.transliteration` was renamed to ``NON_ASCII_DIGITS``.
6-
* Add -cookies option to :mod:`login<pywikibot.scripts.login>` script to login with cookies files only
7-
* Create a Site using :func:`pywikibot.Site` constructor with a given url even if the url ends with
8-
a slash (:phab:`T396592`)
14+
``NON_LATIN_DIGITS`` of :mod:`userinterfaces.transliteration` was renamed to ``NON_ASCII_DIGITS``
15+
* Add -cookies option to the :mod:`login<pywikibot.scripts.login>` script to log in with cookies
16+
files only
17+
* Create a Site using the :func:`pywikibot.Site` constructor with a given url even if the URL, even
18+
if it ends with a slash (:phab:`T396592`)
919
* Remove hard-coded error messages from :meth:`login.LoginManager.login` and use API response instead
10-
* Add additional informations to :meth:`Site.login()<pywikibot.site._apisite.APISite.login>` error message (:phab:`T395670`)
20+
* Add additional information to :meth:`Site.login()<pywikibot.site._apisite.APISite.login>`
21+
error message (:phab:`T395670`)
1122
* i18n updates
1223

13-
Current Deprecations
14-
====================
24+
Deprecations
25+
============
1526

16-
* 10.3.0: ``textlib.to_latin_digits()`` will be removed in favour of :func:`textlib.to_ascii_digits`,
17-
``NON_LATIN_DIGITS`` of :mod:`userinterfaces.transliteration` will be removed in favour of ``NON_ASCII_DIGITS``.
27+
Pending removal in Pywikibot 13
28+
-------------------------------
29+
30+
* 10.3.0: :meth:`throttle.Trottle.getDelay` and :meth:`throttle.Trottle.setDelays` were renamed; the
31+
old methods will be removed (:phab:`T289318`)
32+
* 10.3.0: :attr:`throttle.Trottle.next_multiplicity` attribute is unused and will be removed
33+
(:phab:`T289318`)
34+
* 10.3.0: *requestsize* parameter of :class:`throttle.Trottle` call is deprecated and will be
35+
dropped (:phab:`T289318`)
36+
* 10.3.0: :func:`textlib.to_latin_digits` will be removed in favour of
37+
:func:`textlib.to_ascii_digits`, ``NON_LATIN_DIGITS`` of :mod:`userinterfaces.transliteration`
38+
will be removed in favour of ``NON_ASCII_DIGITS`` (:phab:`T398146#10958283`)
1839
* 10.2.0: :mod:`tools.threading.RLock<tools.threading>` is deprecated and moved to :mod:`backports`
1940
module. The :meth:`backports.RLock.count` method is also deprecated. For Python 3.14+ use ``RLock``
2041
from Python library ``threading`` instead. (:phab:`T395182`)
2142
* 10.1.0: *revid* and *date* parameters of :meth:`Page.authorship()
2243
<page._toolforge.WikiBlameMixin.authorship>` were dropped
23-
* 10.0.0: *last_id* of :class:`comms.eventstreams.EventStreams` was renamed to *last_event_id* (:phab:`T309380`)
44+
* 10.0.0: *last_id* of :class:`comms.eventstreams.EventStreams` was renamed to *last_event_id*
45+
(:phab:`T309380`)
2446
* 10.0.0: 'millenia' argument for *precision* parameter of :class:`pywikibot.WbTime` is deprecated;
25-
'millennium' must be used instead.
47+
'millennium' must be used instead
2648
* 10.0.0: *includeredirects* parameter of :func:`pagegenerators.AllpagesPageGenerator` and
2749
:func:`pagegenerators.PrefixingPageGenerator` is deprecated and should be replaced by *filterredir*
50+
51+
52+
Pending removal in Pywikibot 12
53+
-------------------------------
54+
2855
* 9.6.0: :meth:`BaseSite.languages()<pywikibot.site._basesite.BaseSite.languages>` will be removed in
2956
favour of :attr:`BaseSite.codes<pywikibot.site._basesite.BaseSite.codes>`
3057
* 9.5.0: :meth:`DataSite.getPropertyType()<pywikibot.site._datasite.DataSite.getPropertyType>` will be removed
3158
in favour of :meth:`DataSite.get_property_type()<pywikibot.site._datasite.DataSite.get_property_type>`
3259
* 9.3.0: :meth:`page.BasePage.userName` and :meth:`page.BasePage.isIpEdit` are deprecated in favour of
3360
``user`` or ``anon`` attributes of :attr:`page.BasePage.latest_revision` property
34-
* 9.2.0: Imports of :mod:`logging` functions from :mod:`bot` module is deprecated and will be desupported
61+
* 9.2.0: Imports of :mod:`logging` functions from the :mod:`bot` module are deprecated and will be desupported
3562
* 9.2.0: *total* argument in ``-logevents`` pagegenerators option is deprecated;
3663
use ``-limit`` instead (:phab:`T128981`)
3764
* 9.0.0: The *content* parameter of :meth:`proofreadpage.IndexPage.page_gen` is deprecated and will be
3865
ignored (:phab:`T358635`)
39-
* 9.0.0: ``userinterfaces.transliteration.transliterator`` was renamed to :class:`Transliterator
40-
<userinterfaces.transliteration.Transliterator>`
41-
* 9.0.0: ``next`` parameter of :meth:`userinterfaces.transliteration.transliterator.transliterate` was
66+
* 9.0.0: ``next`` parameter of :meth:`userinterfaces.transliteration.Transliterator.transliterate` was
4267
renamed to ``succ``
43-
* 9.0.0: ``type`` parameter of :meth:`site.APISite.protectedpages()
68+
* 9.0.0: ``userinterfaces.transliteration.transliterator`` object was renamed to :class:`Transliterator
69+
<userinterfaces.transliteration.Transliterator>`
70+
* 9.0.0: The ``type`` parameter of :meth:`site.APISite.protectedpages()
4471
<pywikibot.site._generators.GeneratorsMixin.protectedpages>` was renamed to ``protect_type``
45-
* 9.0.0: ``all`` parameter of :meth:`site.APISite.namespace()<pywikibot.site._apisite.APISite.namespace>`
46-
was renamed to ``all_ns``
72+
* 9.0.0: The ``all`` parameter of :meth:`site.APISite.namespace()
73+
<pywikibot.site._apisite.APISite.namespace>` was renamed to ``all_ns``
4774
* 9.0.0: ``filter`` parameter of :func:`date.dh` was renamed to ``filter_func``
4875
* 9.0.0: ``dict`` parameter of :class:`data.api.OptionSet` was renamed to ``data``
49-
* 9.0.0: ``pywikibot.version.get_toolforge_hostname()`` is deprecated without replacement
76+
* 9.0.0: :func:`pywikibot.version.get_toolforge_hostname` is deprecated with no replacement
5077
* 9.0.0: ``allrevisions`` parameter of :class:`xmlreader.XmpDump` is deprecated, use ``revisions`` instead
5178
(:phab:`T340804`)
5279
* 9.0.0: ``iteritems`` method of :class:`data.api.Request` will be removed in favour of ``items``
53-
* 9.0.0: ``SequenceOutputter.output()`` is deprecated in favour of :attr:`tools.formatter.SequenceOutputter.out`
54-
property
80+
* 9.0.0: ``SequenceOutputter.output()`` is deprecated in favour of the
81+
:attr:`tools.formatter.SequenceOutputter.out` property
5582

5683

5784
Pending removal in Pywikibot 11
5885
-------------------------------
5986

60-
* 8.4.0: *modules_only_mode* parameter of :class:`data.api.ParamInfo`, its *paraminfo_keys* class attribute
61-
and its preloaded_modules property will be removed
62-
* 8.4.0: *dropdelay* and *releasepid* attributes of :class:`throttle.Throttle` will be removed
63-
in favour of *expiry* class attribute
64-
* 8.2.0: :func:`tools.itertools.itergroup` will be removed in favour of :func:`backports.batched`
65-
* 8.2.0: *normalize* parameter of :meth:`WbTime.toTimestr` and :meth:`WbTime.toWikibase` will be removed
66-
* 8.1.0: Dependency of :exc:`exceptions.NoSiteLinkError` from :exc:`exceptions.NoPageError` will be removed
67-
* 8.1.0: ``exceptions.Server414Error`` is deprecated in favour of :exc:`exceptions.Client414Error`
68-
* 8.0.0: :meth:`Timestamp.clone()<pywikibot.time.Timestamp.clone>` method is deprecated
69-
in favour of ``Timestamp.replace()`` method.
70-
* 8.0.0: :meth:`family.Family.maximum_GET_length` method is deprecated in favour of
71-
:ref:`config.maximum_GET_length<Account Settings>` (:phab:`T325957`)
72-
* 8.0.0: ``addOnly`` parameter of :func:`textlib.replaceLanguageLinks` and
73-
:func:`textlib.replaceCategoryLinks` are deprecated in favour of ``add_only``
74-
* 8.0.0: :class:`textlib.TimeStripper` regex attributes ``ptimeR``, ``ptimeznR``, ``pyearR``, ``pmonthR``,
75-
``pdayR`` are deprecated in favour of ``patterns`` attribute which is a
76-
:class:`textlib.TimeStripperPatterns`.
77-
* 8.0.0: :class:`textlib.TimeStripper` ``groups`` attribute is deprecated in favour of ``textlib.TIMEGROUPS``
78-
* 8.0.0: :meth:`LoginManager.get_login_token<login.ClientLoginManager.get_login_token>` was
79-
replaced by ``login.ClientLoginManager.site.tokens['login']``
80-
* 8.0.0: ``data.api.LoginManager()`` is deprecated in favour of :class:`login.ClientLoginManager`
81-
* 8.0.0: :meth:`APISite.messages()<pywikibot.site._apisite.APISite.messages>` method is deprecated in
82-
favour of :attr:`userinfo['messages']<pywikibot.site._apisite.APISite.userinfo>`
83-
* 8.0.0: :meth:`Page.editTime()<page.BasePage.editTime>` method is deprecated and should be replaced by
84-
:attr:`Page.latest_revision.timestamp<page.BasePage.latest_revision>`
87+
* 8.4.0: The *modules_only_mode* parameter in the :class:`data.api.ParamInfo` class, its
88+
*paraminfo_keys* class attribute, and its ``preloaded_modules`` property will be removed
89+
* 8.4.0: The *dropdelay* and *releasepid* attributes of the :class:`throttle.Throttle` class will be
90+
removed in favour of the *expiry* class attribute
91+
* 8.2.0: The :func:`tools.itertools.itergroup` function will be removed in favour of the
92+
:func:`backports.batched` function
93+
* 8.2.0: The *normalize* parameter in the :meth:`WbTime.toTimestr` and :meth:`WbTime.toWikibase`
94+
methods will be removed
95+
* 8.1.0: The inheritance of the :exc:`exceptions.NoSiteLinkError` exception from
96+
:exc:`exceptions.NoPageError` will be removed
97+
* 8.1.0: The ``exceptions.Server414Error`` exception is deprecated in favour of the
98+
:exc:`exceptions.Client414Error` exception
99+
* 8.0.0: The :meth:`Timestamp.clone()<pywikibot.time.Timestamp.clone>` method is deprecated in
100+
favour of the ``Timestamp.replace()`` method
101+
* 8.0.0: The :meth:`family.Family.maximum_GET_length` method is deprecated in favour of the
102+
:ref:`config.maximum_GET_length<Account Settings>` configuration option (:phab:`T325957`)
103+
* 8.0.0: The ``addOnly`` parameter in the :func:`textlib.replaceLanguageLinks` and
104+
:func:`textlib.replaceCategoryLinks` functions is deprecated in favour of ``add_only``
105+
* 8.0.0: The regex attributes ``ptimeR``, ``ptimeznR``, ``pyearR``, ``pmonthR``, and ``pdayR`` of
106+
the :class:`textlib.TimeStripper` class are deprecated in favour of the ``patterns`` attribute,
107+
which is a :class:`textlib.TimeStripperPatterns` object
108+
* 8.0.0: The ``groups`` attribute of the :class:`textlib.TimeStripper` class is deprecated in favour
109+
of the :data:`textlib.TIMEGROUPS` constant
110+
* 8.0.0: The :meth:`LoginManager.get_login_token<login.ClientLoginManager.get_login_token>` method
111+
has been replaced by ``login.ClientLoginManager.site.tokens['login']``
112+
* 8.0.0: The ``data.api.LoginManager()`` constructor is deprecated in favour of the
113+
:class:`login.ClientLoginManager` class
114+
* 8.0.0: The :meth:`APISite.messages()<pywikibot.site._apisite.APISite.messages>` method is
115+
deprecated in favour of the :attr:`userinfo['messages']<pywikibot.site._apisite.APISite.userinfo>`
116+
attribute
117+
* 8.0.0: The :meth:`Page.editTime()<page.BasePage.editTime>` method is deprecated and should be
118+
replaced by the :attr:`Page.latest_revision.timestamp<page.BasePage.latest_revision>` attribute

‎scripts/CHANGELOG.rst‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,13 +9,20 @@ Scripts Changelog
99
archivebot
1010
^^^^^^^^^^
1111

12-
* Use wikidata items for archive header templates (:phab:`T396399`)
12+
* Use Wikidata items for archive header templates (:phab:`T396399`)
13+
14+
interwiki
15+
^^^^^^^^^
16+
17+
* Ignore :exc:`exceptions.SectionError` in :meth:`interwiki.Subject.page_empty_check` and treat it
18+
as an empty page (:phab:`T398983`)
19+
* Show a warning if no username is configured for a site (:phab:`T135228`)
1320

1421
redirect
1522
^^^^^^^^
1623

17-
* Try one more move to fix redirect targets (:phab:`T396473`)
18-
* Don't fix broken redirects if namespace of source and target are different (:phab:`T396456`)
24+
* Attempt an additional move to fix redirect targets (:phab:`T396473`)
25+
* Do not fix broken redirects if the source and target namespaces differ (:phab:`T396456`)
1926

2027

2128
10.2.0

0 commit comments

Comments
 (0)