Property migrator.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Property migrator\n",
    "\n",
    "The point of this tool is to try to migrate instances of Q1 P2 Q3 / P4 Q5 for given P2 and P4, and replace P4 with another P6. See [the Wikidata discussion on P794 (\"as\")](https://www.wikidata.org/wiki/Wikidata:Requests_for_comment/Close-out_of_statements_formerly_using_P794) for context.\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 8,
   "metadata": {},
   "outputs": [
    {
     "name": "stderr",
     "output_type": "stream",
     "text": [
      "Retrieving 3 pages from wikidata:wikidata.\n"
     ]
    },
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "Now working on  Q1062055   Forretress\n",
      "Forretress Pokédex / Pokémon browser number [none] of Almia Pokémon Browser change to catalog !\n",
      "Changing to catalog\n",
      "Forretress Pokédex / Pokémon browser number [none] of Oblivia Pokémon Browser change to catalog !\n",
      "Changing to catalog\n",
      "Forretress Pokédex / Pokémon browser number [none] of Oblivia past Pokémon browser change to catalog !\n",
      "Changing to catalog\n",
      "Now working on  Q1062028   Ariados\n",
      "Ariados Pokédex / Pokémon browser number [none] of Fiore Pokémon browser change to catalog !\n",
      "Changing to catalog\n",
      "Ariados Pokédex / Pokémon browser number [none] of Almia Pokémon Browser change to catalog !\n",
      "Changing to catalog\n",
      "Ariados Pokédex / Pokémon browser number [none] of Oblivia Pokémon Browser change to catalog !\n",
      "Changing to catalog\n",
      "Now working on  Q1069898   Pelipper\n",
      "Pelipper Pokédex / Pokémon browser number [none] of Fiore Pokémon browser change to catalog !\n",
      "Changing to catalog\n",
      "Pelipper Pokédex / Pokémon browser number [none] of Almia Pokémon Browser change to catalog !\n",
      "Changing to catalog\n",
      "Pelipper Pokédex / Pokémon browser number [none] of Oblivia Pokémon Browser change to catalog !\n",
      "Changing to catalog\n",
      "Pelipper Pokédex / Pokémon browser number [none] of Oblivia past Pokémon browser change to catalog !\n",
      "Changing to catalog\n",
      "All done, thanks for using! We edited 10 qualifiers.\n"
     ]
    }
   ],
   "source": [
    "#input vars\n",
    "main_property = 'P1685'\n",
    "qualifier_property = 'P642'\n",
    "new_qualifier_property = 'P972'\n",
    "allowed_qualifier_targets = {} #leave empty for everything to be processed; change to format {'Q1234', 'Q5678'} if you want to limit the targets to be operated on\n",
    "\n",
    "limit = 1000\n",
    "\n",
    "logFileName = 'migrator1log.txt'\n",
    "\n",
    "edit_summary = qualifier_property + ' is no longer used with ' + main_property + '; migrating' + main_property + '/' + qualifier_property + ' to ' + '/' + new_qualifier_property\n",
    "no_promptbox = 1 #set to 1 to operate on entire query automatically, 0 to prompt once per item\n",
    "\n",
    "# query_filename = 'qualifier_migrate.rq'\n",
    "QUERY = \"\"\"SELECT DISTINCT ?item ?itemLabel ?property ?propertyLabel ?value ?asObject ?asObjectLabel\n",
    "WHERE\n",
    "{\n",
    "  wd:\"\"\" + main_property + \"\"\" wikibase:claim ?p .\n",
    "  ?prop pq:\"\"\" + qualifier_property + \"\"\" ?asObject .\n",
    "  hint:Query hint:optimizer \"None\" .\t\n",
    "  ?item ?p ?prop . \n",
    "  ?property wikibase:claim ?p .  \n",
    "  ?property wikibase:statementProperty ?ps .\n",
    "  ?prop ?ps ?value .\n",
    "  SERVICE wikibase:label { bd:serviceParam wikibase:language \"en,bg\"  }    \n",
    "}\n",
    "ORDER BY ASC(?value) \n",
    "LIMIT \"\"\" + str(limit)\n",
    "\n",
    "#start of actual script\n",
    "import pywikibot\n",
    "from pywikibot import pagegenerators as pg\n",
    "\n",
    "import datetime\n",
    "\n",
    "site = pywikibot.Site(\"wikidata\", \"wikidata\")\n",
    "wikidata_site = site #compatibility stuff\n",
    "repo = site.data_repository()    \n",
    "\n",
    "def getLabelFromObject(WDObject):\n",
    "    item_dict = WDObject.get()\n",
    "    item_label = False\n",
    "    if 'labels' in item_dict:\n",
    "        if 'en' in item_dict['labels']:\n",
    "            item_label = item_dict['labels']['en']\n",
    "    label = item_label\n",
    "    if (label):\n",
    "        return label\n",
    "    else:\n",
    "        return WDObject.getID()\n",
    "\n",
    "def getLabelFromWDID(ID): #works for properties only. need separate function for items. why why why\n",
    "    site = pywikibot.Site(\"wikidata\", \"wikidata\")\n",
    "    repo = site.data_repository()\n",
    "    item = pywikibot.PropertyPage(repo, ID)\n",
    "    return getLabelFromObject(item)\n",
    "\n",
    "main_property_label = getLabelFromWDID(main_property)\n",
    "qualifier_property_label = getLabelFromWDID(qualifier_property)\n",
    "new_qualifier_property_label = getLabelFromWDID(new_qualifier_property)\n",
    "\n",
    "#replaced by including SPARQL inside this program\n",
    "#with open(query_filename, 'r') as query_file:\n",
    "#    QUERY = query_file.read()\n",
    "\n",
    "generator = pg.WikidataSPARQLPageGenerator(QUERY, site=wikidata_site)\n",
    "generator = site.preloadpages(generator, pageprops=True)\n",
    "\n",
    "break_flag = 0\n",
    "edit_count = 0\n",
    "\n",
    "f = open(logFileName, 'a')\n",
    "print(datetime.datetime.now(), file=f)\n",
    "\n",
    "for item in generator:\n",
    "    #operate on the most recent one for testing\n",
    "    item_dict = item.get()\n",
    "    item_label = getLabelFromObject(item)\n",
    "            \n",
    "    print('Now working on ', item.getID(), ' ', item_label)#, 'Ready? (\"yes\" to go, \"break\" to stop)')\n",
    "    print(item.getID(), file=f)\n",
    "\n",
    "    for claim_object in item_dict['claims'][main_property]:\n",
    "        claim_target = claim_object.getTarget()\n",
    "        claim_target_label = getLabelFromObject(claim_target) if type(claim_target) ==pywikibot.page.ItemPage else '[none]'\n",
    "        \n",
    "        if qualifier_property in claim_object.qualifiers:\n",
    "            for qualifier_object in claim_object.qualifiers[qualifier_property]:\n",
    "                qualifier_target = qualifier_object.getTarget()\n",
    "                if (len(allowed_qualifier_targets) > 0 and \n",
    "                    qualifier_target.getID() not in allowed_qualifier_targets):\n",
    "                    continue\n",
    "                    \n",
    "                qualifier_target_label = getLabelFromObject(qualifier_target) if type(qualifier_target) == pywikibot.page.ItemPage else '[none]'\n",
    "                    \n",
    "                print(item_label, main_property_label, claim_target_label, \n",
    "                      qualifier_property_label, qualifier_target_label, \n",
    "                      'change to', new_qualifier_property_label, '!')\n",
    "\n",
    "                acceptable_prompt_set = {'y', 'yes', 'n', 'no', 'break'}\n",
    "                promptbox = ''\n",
    "                if (no_promptbox == 1):\n",
    "                    promptbox = 'yes'\n",
    "                while (promptbox not in acceptable_prompt_set):\n",
    "                    promptbox = input()  #becomes automatic if set to 'y'\n",
    "\n",
    "                if promptbox == 'y' or promptbox == 'yes':\n",
    "                    qualifier_dict = qualifier_object.toJSON()\n",
    "                    qualifier_dict['property'] =  new_qualifier_property #set up the qualifier change\n",
    "                    print('Changing to', new_qualifier_property_label)\n",
    "                    new_qualifier_object = qualifier_object.qualifierFromJSON(site = wikidata_site, data = qualifier_dict)\n",
    "                    claim_object.addQualifier(new_qualifier_object, summary=edit_summary)\n",
    "                    edit_count = edit_count + 1\n",
    "\n",
    "                elif promptbox == 'n' or promptbox == 'no':\n",
    "                    print('Skipped')\n",
    "                    \n",
    "                elif promptbox == 'break':\n",
    "                    break_flag = 1\n",
    "                    break\n",
    "\n",
    "        if break_flag == 1:\n",
    "            break\n",
    "    if break_flag == 1:\n",
    "        break\n",
    "\n",
    "print('All done, thanks for using! We edited', edit_count, 'qualifiers.')\n",
    "f.close()"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 7,
   "metadata": {},
   "outputs": [
    {
     "name": "stdout",
     "output_type": "stream",
     "text": [
      "SELECT DISTINCT ?item ?itemLabel ?property ?propertyLabel ?value ?asObject ?asObjectLabel\n",
      "WHERE\n",
      "{\n",
      "  wd:P1685 wikibase:claim ?p .\n",
      "  ?prop pq:P642 ?asObject .\n",
      "  hint:Query hint:optimizer \"None\" .\t\n",
      "  ?item ?p ?prop . \n",
      "  ?property wikibase:claim ?p .  \n",
      "  ?property wikibase:statementProperty ?ps .\n",
      "  ?prop ?ps ?value .\n",
      "  SERVICE wikibase:label { bd:serviceParam wikibase:language \"en,bg\"  }    \n",
      "}\n",
      "ORDER BY ASC(?value) \n",
      "LIMIT 1000\n"
     ]
    }
   ],
   "source": [
    "print(QUERY)"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.6.9"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}