Source code for scripts.states_redirect

# -*- coding: utf-8 -*-
"""Create country sub-division redirect pages.

Check if they are in the form Something, State, and if so, create a redirect
from Something, ST.

Specific arguments:

-start:xxx Specify the place in the alphabet to start searching
-force: Don't ask whether to create pages, just create them.

PRE-REQUISITE : Need to install python-pycountry library.

* Follow the instructions at:
* Install with pip: pip install pycountry
# (C) Andre Engels, 2004
# (C) Pywikibot team, 2004-2019
# Distributed under the terms of the MIT license.
from __future__ import absolute_import, division, unicode_literals

import re

import pywikibot

from import SingleSiteBot, suggest_help
from pywikibot import i18n

    import pycountry
except ImportError as e:
    pycountry = e

[docs]class StatesRedirectBot(SingleSiteBot): """Bot class used for implementation of re-direction norms."""
[docs] def __init__(self, start, force): """Initializer. @param start:xxx Specify the place in the alphabet to start searching. @type start: str @param force: Don't ask whether to create pages, just create them. @type force: bool """ super(StatesRedirectBot, self).__init__() self.start = start self.force = force
[docs] def setup(self): """Create abbrev from pycountry data base.""" self.abbrev = {} for subd in pycountry.subdivisions: # Used subd.code[3:] to extract the exact code for # subdivisional states(ignoring the country code). self.abbrev[] = subd.code[3:]
@property def generator(self): """Generator used by run() method.""" return
[docs] def treat(self, page): """Re-directing process. Check if pages are in the given form Something, State, and if so, create a redirect from Something, ST.. """ for sn in self.abbrev: if', %s$' % sn, page.title()): pl = pywikibot.Page(, page.title().replace(sn, self.abbrev[sn])) # A bit hacking here - the real work is done in the # 'except pywikibot.NoPage' part rather than the 'try'. try: pl.get(get_redirect=True) goal = pl.getRedirectTarget().title() if pywikibot.Page(, goal).exists(): pywikibot.output( 'Not creating {0} - redirect already exists.' .format(goal)) else: pywikibot.warning( '{0} already exists but redirects elsewhere!' .format(goal)) except pywikibot.IsNotRedirectPage: pywikibot.warning( 'Page {0} already exists and is not a redirect ' 'Please check page!' .format(pl.title())) except pywikibot.NoPage: if page.isRedirectPage(): p2 = page.getRedirectTarget() pywikibot.output( 'Note: goal page is redirect.\nCreating redirect ' 'to "{0}" to avoid double redirect.' .format(p2.title())) else: p2 = page if self.force or pywikibot.input_yn('Create redirect {0}?' .format(pl.title())): pl.set_redirect_target( p2, create=True, summary=i18n.twtranslate(, 'states_redirect-comment'))
[docs]def main(*args): """ Process command line arguments and invoke bot. If args is an empty list, sys.argv is used. @param args: command line arguments @type args: str """ local_args = pywikibot.handle_args(args) start = None force = False unknown_parameters = [] # Parse command line arguments for arg in local_args: if arg.startswith('-start:'): start = arg[7:] elif arg == '-force': force = True else: unknown_parameters.append(arg) if isinstance(pycountry, ImportError): missing_dependencies = ('pycountry',) else: missing_dependencies = None if suggest_help(unknown_parameters=unknown_parameters, missing_dependencies=missing_dependencies): return bot = StatesRedirectBot(start, force)
if __name__ == '__main__': main()