jenkins-bot has submitted this change. (
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1319951?usp=email )
Change subject: Deprecate BasePage.getOldVersion
......................................................................
Deprecate BasePage.getOldVersion
BasePage.getOldVersion is only a convenience wrapper around get_revision.
Deprecate it in favor of get_revision(oldid, content=True).text.
Migrate revertbot and page tests to use get_revision directly.
Bug: T433799
Change-Id: I5611fdf480518de2d541982738fd5ef86ef357ec
---
M pywikibot/page/_basepage.py
M scripts/revertbot.py
M tests/page_tests.py
3 files changed, 8 insertions(+), 7 deletions(-)
Approvals:
Xqt: Looks good to me, approved
jenkins-bot: Verified
diff --git a/pywikibot/page/_basepage.py b/pywikibot/page/_basepage.py
index 196fea9..8067897 100644
--- a/pywikibot/page/_basepage.py
+++ b/pywikibot/page/_basepage.py
@@ -458,8 +458,6 @@
"""Return an old revision of this page.
.. version-added:: 9.6
- .. seealso:: :meth:`getOldVersion`
-
:param oldid: The revid of the revision desired.
:param content: If True, retrieve the content of the revision
@@ -470,11 +468,14 @@
self.site.loadrevisions(self, content=content, revids=oldid)
return self._revisions[oldid]
- def getOldVersion(self, oldid, force: bool = False) -> str:
+ @deprecated('get_revision(oldid, content=True).text', since='11.7.0')
+ def getOldVersion(self, oldid: int, force: bool = False) -> str:
"""Return text of an old revision of this page.
.. version-changed:: 10.0
The unused parameter *get_redirect* was removed.
+ .. version-deprecated:: 11.7
+ Use ``get_revision(oldid, content=True).text`` instead.
.. seealso:: :meth:`get_revision`
:param oldid: The revid of the revision desired.
diff --git a/scripts/revertbot.py b/scripts/revertbot.py
index 6434c2a..2fc2df0 100755
--- a/scripts/revertbot.py
+++ b/scripts/revertbot.py
@@ -145,7 +145,7 @@
comment += ': ' + self.opt.comment
old = page.text
- page.text = page.getOldVersion(rev.revid)
+ page.text = page.get_revision(rev.revid, content=True).text
pywikibot.showDiff(old, page.text)
page.save(comment)
return comment
diff --git a/tests/page_tests.py b/tests/page_tests.py
index 2aef677..0660f19 100755
--- a/tests/page_tests.py
+++ b/tests/page_tests.py
@@ -300,13 +300,13 @@
self.assertIsInstance(mainpage.oldest_revision.timestamp,
pywikibot.Timestamp)
- def test_old_version(self) -> None:
- """Test page.getOldVersion()."""
+ def test_get_revision_content(self) -> None:
+ """Test page.get_revision() with content."""
mainpage = self.get_mainpage()
revid = mainpage.oldest_revision.revid
self.assertIsNone(mainpage.oldest_revision.text)
self.assertIsNone(mainpage._revisions[revid].text)
- text = mainpage.getOldVersion(revid)
+ text = mainpage.get_revision(revid, content=True).text
self.assertEqual(
text[:53], "'''[[Welcome, newcomers|Welcome]] to [[Wikipedia]]'''")
self.assertEqual(text, mainpage._revisions[revid].text)
--
To view, visit
https://gerrit.wikimedia.org/r/c/pywikibot/core/+/1319951?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: I5611fdf480518de2d541982738fd5ef86ef357ec
Gerrit-Change-Number: 1319951
Gerrit-PatchSet: 1
Gerrit-Owner: Mahveotm <[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]