jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/525056 ) Change subject: [FEAT] Add WikibaseEntity.editEntity and others ...................................................................... [FEAT] Add WikibaseEntity.editEntity and others Change-Id: I6da98c6fbe48d41a61bd55c66112fce085d9cf23 --- M pywikibot/page.py 1 file changed, 53 insertions(+), 16 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/page.py b/pywikibot/page.py index ed72160..7094040 100644 --- a/pywikibot/page.py +++ b/pywikibot/page.py @@ -3798,6 +3798,33 @@ """ return {} + def toJSON(self, diffto=None): + """ + Create JSON suitable for Wikibase API. + + When diffto is provided, JSON representing differences + to the provided data is created. + + @param diffto: JSON containing entity data + @type diffto: dict + + @rtype: dict + """ + return {} + + @classmethod + def _normalizeData(cls, data): + """ + Helper function to expand data into the Wikibase API structure. + + @param data: The dict to normalize + @type data: dict + + @return: the altered dict from parameter data. + @rtype: dict + """ + return {} + def exists(self): """ Determine if an entity exists in the data repository. @@ -3840,6 +3867,28 @@ raise pywikibot.NoWikibaseEntity(self) return {} + def editEntity(self, data=None, **kwargs): + """ + Edit an entity using Wikibase wbeditentity API. + + @param data: Data to be saved + @type data: dict, or None to save the current content of the entity. + """ + if data is None: + data = self.toJSON(diffto=getattr(self, '_content', None)) + else: + data = self._normalizeData(data) + + updates = self.repo.editEntity(self, data, **kwargs) + + # the attribute may have been unset in ItemPage + if getattr(self, 'id', '-1') == '-1': + self.__init__(self.repo, updates['entity']['id']) + + self._content = updates['entity'] + self.get() + return updates + def concept_uri(self): """ Return the full concept URI. @@ -4229,6 +4278,7 @@ @return: the altered dict from parameter data. @rtype: dict """ + WikibaseEntity._normalizeData(data) for prop in ('labels', 'descriptions'): if prop not in data: continue @@ -4290,24 +4340,10 @@ else: baserevid = None - if data is None: - data = self.toJSON( - diffto=(self._content if hasattr(self, '_content') else None)) - else: - data = WikibasePage._normalizeData(data) - - updates = self.repo.editEntity(self, data, - baserevid=baserevid, **kwargs) + updates = super(WikibasePage, self).editEntity( + data, baserevid=baserevid, **kwargs) self.latest_revision_id = updates['entity']['lastrevid'] - # todo: this variable is specific to ItemPage - lazy_loading_id = not hasattr(self, 'id') and hasattr(self, '_site') - if lazy_loading_id or self.id == '-1': - self.__init__(self.site, title=updates['entity']['id']) - - self._content = updates['entity'] - self.get() - def editLabels(self, labels, **kwargs): """ Edit entity labels. @@ -4794,6 +4830,7 @@ with a value for 'site' and 'title'. """ data = {} + # todo: move to _normalizeData for obj in sitelinks: if isinstance(obj, Page): db_name = self.getdbName(obj.site) -- To view, visit https://gerrit.wikimedia.org/r/525056 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I6da98c6fbe48d41a61bd55c66112fce085d9cf23 Gerrit-Change-Number: 525056 Gerrit-PatchSet: 9 Gerrit-Owner: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Lokal Profil <andre.costa(a)wikimedia.se> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot (75)