Resolve conflict between code and docs in BasePage.getDeletedRevision
Closed, ResolvedPublicBUG REPORT
Actions

Assigned To

Authored By

	binbot
	Mar 7 2023, 2:04 PM

Description

Steps to replicate the issue (needs admin rights, try on a wiki where you are admin):

import pywikibot
site = pywikibot.Site('wikipedia:hu')
page = pywikibot.Page(site, '2023')
print(type(page.getDeletedRevision('2023-01-30T19:11:36Z', content=True)))
print(page.getDeletedRevision('2023-01-30T19:11:36Z', content=True).keys())

What happens?:

<class 'dict'>
dict_keys(['revid', 'user', 'timestamp', 'slots', 'comment'])

What should have happened instead?:
https://doc.wikimedia.org/pywikibot/master/_modules/pywikibot/page/_basepage.html#BasePage.getDeletedRevision says:
return: a list of [date, editor, comment, text, restoration marker]. text will be None, unless content is True (or has been retrieved earlier).

This is a dictionary, no text (although available from slots), no marker, instead slots. Documentation and working code should be in accordance.

Software version (skip for WMF-hosted wikis like Wikipedia): 8.0.0

Details

Related Changes in Gerrit:

	Subject	Repo	Branch	Lines +/-
	[doc] Fix documentation of Page.getDeletedRevision()	pywikibot/core	master	+32 -6

Customize query in gerrit

Related Objects
Search...

		Status	Subtype	Assigned	Task
		Open		binbot	T330855 Create Pywikibot cookbook
		Resolved	BUG REPORT	Xqt	T331422 Resolve conflict between code and docs in BasePage.getDeletedRevision

Event Timeline

binbot created this task.Mar 7 2023, 2:04 PM

Restricted Application added subscribers: pywikibot-bugs-list, Aklapper. · View Herald TranscriptMar 7 2023, 2:04 PM

binbot updated the task description. (Show Details)Mar 7 2023, 2:06 PM

binbot mentioned this in T330855: Create Pywikibot cookbook.Mar 7 2023, 2:08 PM

binbot added a parent task: T330855: Create Pywikibot cookbook.Mar 7 2023, 2:11 PM

Xqt claimed this task.Mar 8 2023, 5:23 PM

Xqt triaged this task as Low priority.

binbot updated the task description. (Show Details)Mar 8 2023, 5:43 PM

Xqt removed Xqt as the assignee of this task.Mar 31 2023, 11:04 AM

Xqt subscribed.

Xqt added a project: TestMe.Mar 23 2025, 1:33 PM

An empty list is given if no deleted revisions are found:

import pywikibot
site = pywikibot.Site('wikipedia:de')
page = pywikibot.Page(site, '2023')
site = pywikibot.Site('wikipedia:de', user='Xqt')
page = pywikibot.Page(site, '2023')
page.getDeletedRevision('2023-01-30T19:11:36Z')
[]

If an item is found, a dict is returned like

{'revid': 216107158, 'parentid': 216107091, 'user': '87.147.178.162', 'anon': '', 'timestamp': '2021-10-04T12:24:34Z', 'comment': 'SLA'}

The result is changed since the first Pywikibot core release (implemented by @russblau) but the documentation is from compat. I propose to change the documentation according to the result.

Change #1150499 had a related patch set uploaded (by Xqt; author: Xqt):

[pywikibot/core@master] [doc] Fix documentation of Page.getDeletedRevision()

https://gerrit.wikimedia.org/r/1150499

gerritbot added a project: Patch-For-Review.May 26 2025, 7:34 AM

Xqt claimed this task.May 26 2025, 7:35 AM

Xqt removed a project: TestMe.

Xqt moved this task from Backlog to Needs Review on the Pywikibot board.

Change #1150499 merged by jenkins-bot:

[pywikibot/core@master] [doc] Fix documentation of Page.getDeletedRevision()

https://gerrit.wikimedia.org/r/1150499

Maintenance_bot removed a project: Patch-For-Review.May 28 2025, 6:31 PM

Xqt closed this task as Resolved.May 29 2025, 6:14 AM