Source code for scripts.illustrate_wikidata

#!/usr/bin/python3
"""
Bot to add images to Wikidata items.

The image is extracted from the page_props. For this to be available the
PageImages extension (https://www.mediawiki.org/wiki/Extension:PageImages)
needs to be installed

Usage:

    python pwb.py illustrate_wikidata <some generator>

&params;
"""
#
# (C) Pywikibot team, 2013-2022
#
# Distributed under the terms of MIT License.
#
import pywikibot
from pywikibot import WikidataBot, pagegenerators


docuReplacements = {'&params;': pagegenerators.parameterHelp}  # noqa: N816


[docs]class IllustrateRobot(WikidataBot): """A bot to add Wikidata image claims.""" def __init__(self, wdproperty: str = 'P18', **kwargs) -> None: """Initializer. :param wdproperty: The property to add. Should be of type commonsMedia """ super().__init__(**kwargs) self.wdproperty = wdproperty self.cacheSources() claim = pywikibot.Claim(self.repo, self.wdproperty) if claim.type != 'commonsMedia': raise ValueError('{} is of type {}, should be commonsMedia' .format(self.wdproperty, claim.type))
[docs] def treat_page_and_item(self, page, item) -> None: """Treat a page / item.""" pywikibot.output('Found ' + item.title()) imagename = page.properties().get('page_image_free') if not imagename: return claims = item.get().get('claims') if self.wdproperty in claims: pywikibot.output('Item {} already contains image ({})' .format(item.title(), self.wdproperty)) return newclaim = pywikibot.Claim(self.repo, self.wdproperty) commonssite = pywikibot.Site('commons') imagelink = pywikibot.Link(imagename, source=commonssite, default_namespace=6) image = pywikibot.FilePage(imagelink) if image.isRedirectPage(): image = pywikibot.FilePage(image.getRedirectTarget()) if not image.exists(): pywikibot.output("{} doesn't exist so I can't link to it" .format(image.title(as_link=True))) return newclaim.setTarget(image) # A generator might yield pages from multiple sites self.user_add_claim(item, newclaim, page.site)
[docs]def main(*args: str) -> None: """ Process command line arguments and invoke bot. If args is an empty list, sys.argv is used. :param args: command line arguments """ # Process global args and prepare generator args parser local_args = pywikibot.handle_args(args) generator_factory = pagegenerators.GeneratorFactory() wdproperty = 'P18' for arg in local_args: if arg.startswith('-property'): if len(arg) == 9: wdproperty = pywikibot.input( 'Please enter the property you want to add:') else: wdproperty = arg[10:] else: generator_factory.handle_arg(arg) generator = generator_factory.getCombinedGenerator(preload=True) if not generator: pywikibot.bot.suggest_help(missing_generator=True) return bot = IllustrateRobot(wdproperty, generator=generator) bot.run()
if __name__ == '__main__': main()