http://www.mediawiki.org/wiki/Special:Code/pywikipedia/11218
Revision: 11218
Author: legoktm
Date: 2013-03-18 12:23:56 +0000 (Mon, 18 Mar 2013)
Log Message:
-----------
Add support for editing Wikibase entities.
Methods were created for updating labels,
descriptions, aliases, and sitelinks.
All methods are passed through editEntity
methods in WikibasePage and DataSite.
Modified Paths:
--------------
branches/rewrite/pywikibot/page.py
branches/rewrite/pywikibot/site.py
Modified: branches/rewrite/pywikibot/page.py
===================================================================
--- branches/rewrite/pywikibot/page.py 2013-03-18 01:09:53 UTC (rev 11217)
+++ branches/rewrite/pywikibot/page.py 2013-03-18 12:23:56 UTC (rev 11218)
@@ -2184,6 +2184,7 @@
yield ImagePage(self.site, item.title().title()), \
unicode(item.timestamp()), item.comment(), item.pageid() > 0
+
class WikibasePage(Page):
"""
The base page for the Wikibase extension.
@@ -2278,13 +2279,80 @@
self.get()
return self.lastrevid
- def save(self, summary, **kwargs):
+ def __normalizeLanguages(self, data):
"""
- Save whatever we added/removed/etc.
+ Helper function to convert any site objects
+ into the language they may represent.
+ @param data The dict to check
+ @type data dict
"""
- raise NotImplementedError
+ for key in data:
+ if isinstance(key, pywikibot.site.BaseSite):
+ data[key.language()] = data[key]
+ del data[key]
+ return data
+ def __getdbName(self, site):
+ """
+ Helper function to normalize site
+ objects into dbnames
+ """
+ if isinstance(site, pywikibot.site.BaseSite):
+ return site.dbName()
+ return site
+ def editEntity(self, data, **kwargs):
+ """
+ Enables updating of entities through wbeditentity
+ This function is wrapped around by:
+ *editLabels
+ *editDescriptions
+ *editAliases
+ *ItemPage.setSitelinks
+ @param data Data to be saved
+ @type data dict
+ """
+ if hasattr(self, 'lastrevid'):
+ baserevid = self.lastrevid
+ else:
+ baserevid = None
+ updates = self.repo.editEntity(self.__defined_by(), data,
baserevid=baserevid, **kwargs)
+ self.lastrevid = updates['entity']['lastrevid']
+
+ def editLabels(self, labels, **kwargs):
+ """
+ Labels should be a dict, with the key
+ as a language or a site object. The
+ value should be the string to set it to.
+ You can set it to '' to remove the label.
+ """
+ labels = self.__normalizeLanguages(labels)
+ data = {'labels': labels}
+ self.editEntity(data, **kwargs)
+
+ def editDescriptions(self, descriptions, **kwargs):
+ """
+ Descriptions should be a dict, with the key
+ as a language or a site object. The
+ value should be the string to set it to.
+ You can set it to '' to remove the description.
+ """
+ descriptions = self.__normalizeLanguages(descriptions)
+ data = {'descriptions': descriptions}
+ self.editEntity(data, **kwargs)
+
+ def editAliases(self, aliases, **kwargs):
+ """
+ Aliases should be a dict, with the key
+ as a language or a site object. The
+ value should be a list of strings.
+ """
+ aliases = self.__normalizeLanguages(aliases)
+ data = {'aliases': aliases}
+ self.editEntity(data, **kwargs)
+
+
+
class ItemPage(WikibasePage):
def __init__(self, site, title=None):
"""
@@ -2345,21 +2413,65 @@
'claims': self.claims
}
+
def getSitelink(self, site, force=False):
"""
Returns a page object for the specific site
- site is a pywikibot.Site
+ site is a pywikibot.Site or database name
force will override caching
If the item doesn't have that language, raise NoPage
"""
if force or not hasattr(self, '_content'):
self.get(force=force)
- dbname = site.dbName()
+ dbname = self.__getdbName(site)
if not dbname in self.sitelinks:
raise pywikibot.NoPage
else:
return self.sitelinks[dbname]
+ def setSitelink(self, sitelink, **kwargs):
+ """
+ A sitelink can either be a Page object,
+ or a {'site':dbname,'title':title} dictionary.
+ """
+ self.setSitelinks([sitelink], **kwargs)
+
+ def removeSitelink(self, site, **kwargs):
+ """
+ A site can either be a Site object,
+ or it can be a dbName.
+ """
+ self.removeSitelinks([site], **kwargs)
+ def removeSitelinks(self, sites, **kwargs):
+ """
+ Sites should be a list, with values either
+ being Site objects, or dbNames.
+ """
+ data = {}
+ for site in sites:
+ site = self.__getdbName(site)
+ data[site] = {'site': site, 'title': ''}
+ self.setSitelinks(data, **kwargs)
+
+ def setSitelinks(self, sitelinks, **kwargs):
+ """
+ Sitelinks should be a list. Each item in the
+ list can either be a Page object, or a dict
+ with a value for 'site' and 'title'.
+ """
+
+ data = {}
+ for obj in sitelinks:
+ if isinstance(obj, Page):
+ dbName = self.__getdbName(obj.site)
+ data[dbName] = {'site': dbName, 'title': obj.title()}
+ else:
+ #TODO: Do some verification here
+ dbName = obj['site']
+ data[dbName] = obj
+ data = {'sitelinks': data}
+ self.editEntity(data, **kwargs)
+
def addClaim(self, claim, bot=True):
"""
Adds the claim to the item
Modified: branches/rewrite/pywikibot/site.py
===================================================================
--- branches/rewrite/pywikibot/site.py 2013-03-18 01:09:53 UTC (rev 11217)
+++ branches/rewrite/pywikibot/site.py 2013-03-18 12:23:56 UTC (rev 11218)
@@ -3334,6 +3334,20 @@
raise pywikibot.data.api.APIError, data['errors']
return data['entities']
+ def editEntity(self, identification, data, **kwargs):
+ params = dict(**identification)
+ params['action'] = 'wbeditentity'
+ if 'baserevid' in kwargs and kwargs['baserevid']:
+ params['baserevid'] = kwargs['baserevid']
+ params['token'] = self.token(pywikibot.Page(self, u'Main Page'),
'edit') # Use a dummy page
+ for arg in kwargs:
+ if arg in ['bot', 'clear', 'data', 'exclude', 'summary']:
+ params[arg] = kwargs[arg]
+ params['data'] = json.dumps(data)
+ req = api.Request(site=self, **params)
+ data = req.submit()
+ return data
+
def addClaim(self, item, claim, bot=True):
params = dict(action='wbcreateclaim',
_______________________________________________
Pywikipedia-svn mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/pywikipedia-svn
