jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1195365?usp=email )
Change subject: Doc: Update ROADMAP.rst and AUTHORS.rst
......................................................................
Doc: Update ROADMAP.rst and AUTHORS.rst
Change-Id: Ice50404436e8c0e313fbd7ee7438dbbaf71be5e0
---
M AUTHORS.rst
M ROADMAP.rst
M docs/changelog.rst
3 files changed, 99 insertions(+), 79 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/AUTHORS.rst b/AUTHORS.rst
index fa3bf8b..6fbbb27 100644
--- a/AUTHORS.rst
+++ b/AUTHORS.rst
@@ -295,6 +295,7 @@
::
+ Sanjai Siddharthan
Serio Santoro
Scot Wilcoxon
Shardul C
diff --git a/ROADMAP.rst b/ROADMAP.rst
index 62efaeb..be4cfa4 100644
--- a/ROADMAP.rst
+++ b/ROADMAP.rst
@@ -1,93 +1,31 @@
Current Release Changes
=======================
-* Positional arguments of :func:`daemonize()<daemonize.daemonize>` are
deprecated and must
- be given as keyword arguments.
-* Return :meth:`bot.BaseBot.userPut` result with
:meth:`AutomaticTWSummaryBot.put_current()
- <bot.AutomaticTWSummaryBot.put_current>` method
* :meth:`Family.interwiki_replacements<family.Family.interwiki_replacements>`
is deprecated;
use :attr:`Family.code_aliases<family.Family.code_aliases>` instead.
+* The first parameter of :meth:`Transliterator.transliterate
+ <userinterfaces.transliteration.Transliterator.transliterate>` is positional
only
+ whereas *prev* and *succ* parameters are keyword only. The
:class:`Transliterator
+ <userinterfaces.transliteration.Transliterator>` was improved.
+* Show user-agent with :mod:`version<pywikibot.scripts.version>` script
(:phab:`T406458`)
+* Positional arguments of :func:`daemonize()<daemonize.daemonize>` are
deprecated and must
+ be given as keyword arguments.
+* i18n updates.
+* Return :meth:`bot.BaseBot.userPut` result from
:meth:`AutomaticTWSummaryBot.put_current()
+ <bot.AutomaticTWSummaryBot.put_current>` method
Deprecations
============
-Pending removal in Pywikibot 13
--------------------------------
+This section lists features, methods, parameters, or attributes that are
deprecated
+and scheduled for removal in future Pywikibot releases.
-* 10.6.0:
:meth:`Family.interwiki_replacements<family.Family.interwiki_replacements>` is
deprecated;
- use :attr:`Family.code_aliases<family.Family.code_aliases>` instead.
-* 10.6.0: Positional arguments of :func:`daemonize()<daemonize.daemonize>` are
deprecated and must
- be given as keyword arguments.
-* 10.5.0: Accessing the fallback '*' keys in 'languages', 'namespaces',
'namespacealiases', and
- 'skins' properties of
:attr:`APISite.siteinfo<pywikibot.site._apisite.APISite.siteinfo>` are
- deprecated and will be removed.
-* 10.5.0: The methods :meth:`APISite.protection_types()
- <pywikibot.site._apisite.APISite.protection_types>` and
:meth:`APISite.protection_levels()
- <pywikibot.site._apisite.APISite.protection_levels>` are deprecated.
- :attr:`APISite.restrictions<pywikibot.site._apisite.APISite.restrictions>`
should be used instead.
-* 10.4.0: Require all parameters of :meth:`Site.allpages()
- <pywikibot.site._generators.GeneratorsMixin.allpages>` except *start* to be
keyword arguments.
-* 10.4.0: Positional arguments of :class:`pywikibot.Coordinate` are deprecated
and must be given as
- keyword arguments.
-* 10.3.0: :meth:`throttle.Throttle.getDelay` and
:meth:`throttle.Throttle.setDelays` were renamed to
- :meth:`get_delay()<throttle.Throttle.get_delay>` and :meth:`set_delays()
- <throttle.Throttle.set_delays>`; the old methods will be removed
(:phab:`T289318`)
-* 10.3.0: :attr:`throttle.Throttle.next_multiplicity` attribute is unused and
will be removed
- (:phab:`T289318`)
-* 10.3.0: *requestsize* parameter of :class:`throttle.Throttle` call is
deprecated and will be
- dropped (:phab:`T289318`)
-* 10.3.0: :func:`textlib.to_latin_digits` will be removed in favour of
- :func:`textlib.to_ascii_digits`, ``NON_LATIN_DIGITS`` of
:mod:`userinterfaces.transliteration`
- will be removed in favour of ``NON_ASCII_DIGITS`` (:phab:`T398146#10958283`)
-* 10.2.0: :mod:`tools.threading.RLock<tools.threading>` is deprecated and
moved to :mod:`backports`
- module. The :meth:`backports.RLock.count` method is also deprecated. For
Python 3.14+ use ``RLock``
- from Python library ``threading`` instead. (:phab:`T395182`)
-* 10.1.0: *revid* and *date* parameters of :meth:`Page.authorship()
- <page._toolforge.WikiBlameMixin.authorship>` were dropped
-* 10.0.0: *last_id* of :class:`comms.eventstreams.EventStreams` was renamed to
*last_event_id*
- (:phab:`T309380`)
-* 10.0.0: 'millenia' argument for *precision* parameter of
:class:`pywikibot.WbTime` is deprecated;
- 'millennium' must be used instead
-* 10.0.0: *includeredirects* parameter of
:func:`pagegenerators.AllpagesPageGenerator` and
- :func:`pagegenerators.PrefixingPageGenerator` is deprecated and should be
replaced by *filterredir*
+Deprecated items may still work in the current release but are no longer
recommended for use.
+Users should update their code according to the recommended alternatives.
-
-Pending removal in Pywikibot 12
--------------------------------
-
-* 9.6.0:
:meth:`BaseSite.languages()<pywikibot.site._basesite.BaseSite.languages>` will
be removed in
- favour of :attr:`BaseSite.codes<pywikibot.site._basesite.BaseSite.codes>`
-* 9.5.0:
:meth:`DataSite.getPropertyType()<pywikibot.site._datasite.DataSite.getPropertyType>`
will be removed
- in favour of
:meth:`DataSite.get_property_type()<pywikibot.site._datasite.DataSite.get_property_type>`
-* 9.3.0: :meth:`page.BasePage.userName` and :meth:`page.BasePage.isIpEdit` are
deprecated in favour of
- ``user`` or ``anon`` attributes of :attr:`page.BasePage.latest_revision`
property
-* 9.3.0: *botflag* parameter of :meth:`Page.save()<page.BasePage.save>`,
:meth:`Page.put()
- <page.BasePage.put>`, :meth:`Page.touch()<page.BasePage.touch>` and
- :meth:`Page.set_redirect_target()<page.Page.set_redirect_target>` was
renamed to *bot*
-* 9.2.0: All parameters of :meth:`Page.templates<page.BasePage.templates>` and
- :meth:`Page.itertemplates()<page.BasePage.itertemplates>` must be given as
keyworded arguments
-* 9.2.0: Imports of :mod:`logging` functions from the :mod:`bot` module are
deprecated and will be desupported
-* 9.2.0: *total* argument in ``-logevents`` pagegenerators option is
deprecated;
- use ``-limit`` instead (:phab:`T128981`)
-* 9.0.0: The *content* parameter of :meth:`proofreadpage.IndexPage.page_gen`
is deprecated and will be
- ignored (:phab:`T358635`)
-* 9.0.0: ``next`` parameter of
:meth:`userinterfaces.transliteration.Transliterator.transliterate` was
- renamed to ``succ``
-* 9.0.0: ``userinterfaces.transliteration.transliterator`` object was renamed
to :class:`Transliterator
- <userinterfaces.transliteration.Transliterator>`
-* 9.0.0: The ``type`` parameter of :meth:`site.APISite.protectedpages()
- <pywikibot.site._generators.GeneratorsMixin.protectedpages>` was renamed to
``protect_type``
-* 9.0.0: The ``all`` parameter of :meth:`site.APISite.namespace()
- <pywikibot.site._apisite.APISite.namespace>` was renamed to ``all_ns``
-* 9.0.0: ``filter`` parameter of :func:`date.dh` was renamed to ``filter_func``
-* 9.0.0: ``dict`` parameter of :class:`data.api.OptionSet` was renamed to
``data``
-* 9.0.0: :func:`pywikibot.version.get_toolforge_hostname` is deprecated with
no replacement
-* 9.0.0: ``allrevisions`` parameter of :class:`xmlreader.XmpDump` is
deprecated, use ``revisions`` instead
- (:phab:`T340804`)
-* 9.0.0: ``iteritems`` method of :class:`data.api.Request` will be removed in
favour of ``items``
-* 9.0.0: ``SequenceOutputter.output()`` is deprecated in favour of the
- :attr:`tools.formatter.SequenceOutputter.out` property
+Pywikibot follows a clear deprecation policy: features are typically
deprecated in one release and
+removed in in the third subsequent major release, remaining available for the
two releases in between.
Pending removal in Pywikibot 11
@@ -127,3 +65,84 @@
attribute
* 8.0.0: The :meth:`Page.editTime()<page.BasePage.editTime>` method is
deprecated and should be
replaced by the
:attr:`Page.latest_revision.timestamp<page.BasePage.latest_revision>` attribute
+
+
+Pending removal in Pywikibot 12
+-------------------------------
+
+* 9.6.0:
:meth:`BaseSite.languages()<pywikibot.site._basesite.BaseSite.languages>` will
be removed in
+ favour of :attr:`BaseSite.codes<pywikibot.site._basesite.BaseSite.codes>`
+* 9.5.0:
:meth:`DataSite.getPropertyType()<pywikibot.site._datasite.DataSite.getPropertyType>`
will be removed
+ in favour of
:meth:`DataSite.get_property_type()<pywikibot.site._datasite.DataSite.get_property_type>`
+* 9.3.0: :meth:`page.BasePage.userName` and :meth:`page.BasePage.isIpEdit` are
deprecated in favour of
+ ``user`` or ``anon`` attributes of :attr:`page.BasePage.latest_revision`
property
+* 9.3.0: *botflag* parameter of :meth:`Page.save()<page.BasePage.save>`,
:meth:`Page.put()
+ <page.BasePage.put>`, :meth:`Page.touch()<page.BasePage.touch>` and
+ :meth:`Page.set_redirect_target()<page.Page.set_redirect_target>` was
renamed to *bot*
+* 9.2.0: All parameters of :meth:`Page.templates<page.BasePage.templates>` and
+ :meth:`Page.itertemplates()<page.BasePage.itertemplates>` must be given as
keyworded arguments
+* 9.2.0: Imports of :mod:`logging` functions from the :mod:`bot` module are
deprecated and will be desupported
+* 9.2.0: *total* argument in ``-logevents`` pagegenerators option is
deprecated;
+ use ``-limit`` instead (:phab:`T128981`)
+* 9.0.0: The *content* parameter of :meth:`proofreadpage.IndexPage.page_gen`
is deprecated and will be
+ ignored (:phab:`T358635`)
+* 9.0.0: ``next`` parameter of
:meth:`userinterfaces.transliteration.Transliterator.transliterate` was
+ renamed to ``succ``
+* 9.0.0: ``userinterfaces.transliteration.transliterator`` object was renamed
to :class:`Transliterator
+ <userinterfaces.transliteration.Transliterator>`
+* 9.0.0: The ``type`` parameter of :meth:`site.APISite.protectedpages()
+ <pywikibot.site._generators.GeneratorsMixin.protectedpages>` was renamed to
``protect_type``
+* 9.0.0: The ``all`` parameter of :meth:`site.APISite.namespace()
+ <pywikibot.site._apisite.APISite.namespace>` was renamed to ``all_ns``
+* 9.0.0: ``filter`` parameter of :func:`date.dh` was renamed to ``filter_func``
+* 9.0.0: ``dict`` parameter of :class:`data.api.OptionSet` was renamed to
``data``
+* 9.0.0: :func:`pywikibot.version.get_toolforge_hostname` is deprecated with
no replacement
+* 9.0.0: ``allrevisions`` parameter of :class:`xmlreader.XmpDump` is
deprecated, use ``revisions`` instead
+ (:phab:`T340804`)
+* 9.0.0: ``iteritems`` method of :class:`data.api.Request` will be removed in
favour of ``items``
+* 9.0.0: ``SequenceOutputter.output()`` is deprecated in favour of the
+ :attr:`tools.formatter.SequenceOutputter.out` property
+
+
+Pending removal in Pywikibot 13
+-------------------------------
+
+* 10.6.0:
:meth:`Family.interwiki_replacements<family.Family.interwiki_replacements>` is
deprecated;
+ use :attr:`Family.code_aliases<family.Family.code_aliases>` instead.
+* Keyword argument for *char* parameter of :meth:`Transliterator.transliterate
+ <userinterfaces.transliteration.Transliterator.transliterate>` and
+ positional arguments for *prev* and *succ* parameters are deprecated.
+* 10.6.0: Positional arguments of :func:`daemonize()<daemonize.daemonize>` are
deprecated and must
+ be given as keyword arguments.
+* 10.5.0: Accessing the fallback '*' keys in 'languages', 'namespaces',
'namespacealiases', and
+ 'skins' properties of
:attr:`APISite.siteinfo<pywikibot.site._apisite.APISite.siteinfo>` are
+ deprecated and will be removed.
+* 10.5.0: The methods :meth:`APISite.protection_types()
+ <pywikibot.site._apisite.APISite.protection_types>` and
:meth:`APISite.protection_levels()
+ <pywikibot.site._apisite.APISite.protection_levels>` are deprecated.
+ :attr:`APISite.restrictions<pywikibot.site._apisite.APISite.restrictions>`
should be used instead.
+* 10.4.0: Require all parameters of :meth:`Site.allpages()
+ <pywikibot.site._generators.GeneratorsMixin.allpages>` except *start* to be
keyword arguments.
+* 10.4.0: Positional arguments of :class:`pywikibot.Coordinate` are deprecated
and must be given as
+ keyword arguments.
+* 10.3.0: :meth:`throttle.Throttle.getDelay` and
:meth:`throttle.Throttle.setDelays` were renamed to
+ :meth:`get_delay()<throttle.Throttle.get_delay>` and :meth:`set_delays()
+ <throttle.Throttle.set_delays>`; the old methods will be removed
(:phab:`T289318`)
+* 10.3.0: :attr:`throttle.Throttle.next_multiplicity` attribute is unused and
will be removed
+ (:phab:`T289318`)
+* 10.3.0: *requestsize* parameter of :class:`throttle.Throttle` call is
deprecated and will be
+ dropped (:phab:`T289318`)
+* 10.3.0: :func:`textlib.to_latin_digits` will be removed in favour of
+ :func:`textlib.to_ascii_digits`, ``NON_LATIN_DIGITS`` of
:mod:`userinterfaces.transliteration`
+ will be removed in favour of ``NON_ASCII_DIGITS`` (:phab:`T398146#10958283`)
+* 10.2.0: :mod:`tools.threading.RLock<tools.threading>` is deprecated and
moved to :mod:`backports`
+ module. The :meth:`backports.RLock.count` method is also deprecated. For
Python 3.14+ use ``RLock``
+ from Python library ``threading`` instead. (:phab:`T395182`)
+* 10.1.0: *revid* and *date* parameters of :meth:`Page.authorship()
+ <page._toolforge.WikiBlameMixin.authorship>` were dropped
+* 10.0.0: *last_id* of :class:`comms.eventstreams.EventStreams` was renamed to
*last_event_id*
+ (:phab:`T309380`)
+* 10.0.0: 'millenia' argument for *precision* parameter of
:class:`pywikibot.WbTime` is deprecated;
+ 'millennium' must be used instead
+* 10.0.0: *includeredirects* parameter of
:func:`pagegenerators.AllpagesPageGenerator` and
+ :func:`pagegenerators.PrefixingPageGenerator` is deprecated and should be
replaced by *filterredir*
diff --git a/docs/changelog.rst b/docs/changelog.rst
index de64526..5a6a5ba 100644
--- a/docs/changelog.rst
+++ b/docs/changelog.rst
@@ -2,7 +2,7 @@
Change log
**********
-What is new with Pywikibot |release|? What are the main changes of older
version?
+New features, improvements, and fixes in Pywikibot |release|.
.. include:: ../ROADMAP.rst
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1195365?usp=email
To unsubscribe, or for help writing mail filters, visit
https://gerrit.wikimedia.org/r/settings?usp=email
Gerrit-MessageType: merged
Gerrit-Project: pywikibot/core
Gerrit-Branch: master
Gerrit-Change-Id: Ice50404436e8c0e313fbd7ee7438dbbaf71be5e0
Gerrit-Change-Number: 1195365
Gerrit-PatchSet: 2
Gerrit-Owner: Xqt <[email protected]>
Gerrit-Reviewer: Xqt <[email protected]>
Gerrit-Reviewer: jenkins-bot
_______________________________________________
Pywikibot-commits mailing list -- [email protected]
To unsubscribe send an email to [email protected]
