jenkins-bot has submitted this change and it was merged.
Change subject: A simple script to help converting scripts from compat to core ......................................................................
A simple script to help converting scripts from compat to core
most of the conversions are for README-conversion.txt
Change-Id: I17e80e0fd17ec619c95d986ed210b389a0e8d73d --- A scripts/maintenance/compat2core.py 1 file changed, 186 insertions(+), 0 deletions(-)
Approvals: Ladsgroup: Looks good to me, approved jenkins-bot: Verified
diff --git a/scripts/maintenance/compat2core.py b/scripts/maintenance/compat2core.py new file mode 100644 index 0000000..fe5af47 --- /dev/null +++ b/scripts/maintenance/compat2core.py @@ -0,0 +1,186 @@ +#!/usr/bin/python +# -*- coding: utf-8 -*- +""" +This is a helper script to convert compat 1.0 scripts to the new core 2.0 +framework. + +NOTE: Please be aware that this script is not be able to convert your codes +completely. It may support you with some automatic replacements and it gives +some warnings and hints for converting. Please refer the converting guide +README-conversion.txt in the core framework folder and check your codes finally. + +The scripts asks for the .py file and converts it to +<scriptname>-core.py in the same directory. The following options are supported: + +- warnonly: Do not convert the source but show warning messages. This is good + to check already merged scripts. + +usage + +to convert a script and show warnings about deprecated methods: + pwb.py maintenance/compat2core <scriptname> + +to show warnings about deprecated methods: + pwb.py maintenance/compat2core <scriptname> -warnonly +""" +# +# (C) xqt, 2014 +# +# Distributed under the terms of the MIT license. +# +__version__ = '$Id$' +# + +import os +import re +import codecs +import pywikibot + +# be carefull with replacement order! +replacements = ( + # doc strings + ('#\r?\n__version__', + '#\n# Automatically ported from compat branch by compat2core.py script\n' + '#\n__version__'), + ('Pywikipedia bot team', 'Pywikibot team'), + # importing changes + ('import wikipedia(?: as pywikibot)?', 'import pywikibot'), + ('(?<!from pywikibot )import (config|pagegenerators)', + r'from pywikibot import \1'), + ('(?<!from pywikibot.compat )import query', + 'from pywikibot.compat import query'), + # remove deprecated libs + ('import catlib\r?\n', ''), + ('import userlib\r?\n', ''), + # change wikipedia to pywikibot, exclude URLs + ('(?<!.)wikipedia.', u'pywikibot.'), + # site instance call + ('pywikibot.getSite\s*(\s*', 'pywikibot.Site('), + # lang is differen from code. We should use code in core + ('([Ss])ite.lang(\W*)', r'\1ite.code\2'), + # change compat library classes to pywikibot intrinsic classes + ('catlib.Category\s*(\s*', 'pywikibot.Category('), + ('catlib.change_category\s*((\s*)(?P<article>.+?),\s*(?P<oldcat>.+?),', + r'\g<article>.change_category(\1\g<oldcat>,'), + ('userlib.User\s*(\s*', 'pywikibot.User('), + # deprecated title methods + ('.urlname\s*(\s*)', '.title(asUrl=True)'), + ('.urlname\s*(\s*(?:withNamespace\s*=\s*)?(True|False)+\s*)', + r'.title(asUrl=True, withNamespace=\1)'), + ('.titleWithoutNamespace\s*(\s*)', '.title(withNamespace=False)'), + ('.sectionFreeTitle\s*(\s*)', '.title(withSection=False)'), + ('.aslink\s*(\s*)', '.title(asLink=True)'), + # other deprecated methods + ('.encoding\s*(\s*)', '.site.encoding()'), + # stopme() is doen by the framework itself + ('(\s*)try:\s*\r?\n\s+main()\s*\r?\n\s*finally:\s*\r?\n\s+pywikibot.stopme()', + r'\1main()'), +) + +# some warnings which must be changed manually +warnings = ( + ('pywikibot.setAction(', + 'setAction() no longer works; you must pass an explicit edit summary\n' + 'message to put() or put_async()'), + ('.removeImage(', + 'Page.removeImage() is deprecated and does not work at core'), + ('.replaceImage(', + 'Page.replaceImage() is deprecated and does not work at core'), + ('.getVersionHistory(', + 'Page.getVersionHistory() returns a pywikibot.Timestamp object instead of\n' + 'a MediaWiki one'), + ('.contributions(', + 'User.contributions() returns a pywikibot.Timestamp object instead of a\n' + 'MediaWiki one'), + ('.getFileMd5Sum(', + 'ImagePage.getFileMd5Sum() is deprecated should be replaced by ' + 'getFileSHA1Sum()'), + (' wikipedia.', + '"wikipedia" library has been changed to "pywikibot".'), + ('from wikipedia import', + '"wikipedia" library has been changed to "pywikibot". Please find the\n' + 'right way to import your object.'), + ('query.GetData(', + 'query.GetData() should be replaced by pywikibot.data.api.Request or\n' + 'by a direct site request'), +) + + +class ConvertBot(object): + + def __init__(self, filename=None, warnonly=False): + self.source = filename + self.warnonly = warnonly + + def run(self): + self.get_source() + self.get_dest() + if not self.warnonly: + self.convert() + self.warning() + + def get_source(self): + while True: + if self.source is None: + self.source = pywikibot.input( + 'Please input the .py file to convert ' + '(no input to leave):') + if not self.source: + exit() + if not self.source.endswith(u'.py'): + self.source += '.py' + if os.path.exists(self.source): + break + self.source = os.path.join('scripts', self.source) + if os.path.exists(self.source): + break + pywikibot.output(u'%s does not exist. Please retry.' % self.source) + self.source = None + + def get_dest(self): + self.dest = u'%s-core.%s' % tuple(self.source.rsplit(u'.', 1)) + if not self.warnonly and pywikibot.inputChoice( + u'Destination file is %s.' % self.dest, + ['Yes', 'No'], ['y', 'n'], 'y') == 'n': + pywikibot.output('Quitting...') + exit() + + def convert(self): + f = codecs.open(self.source, "r", "utf-8") + text = f.read() + f.close() + for r in replacements: + text = re.sub(r[0], r[1], text) + g = codecs.open(self.dest, "w", "utf-8") + g.write(text) + g.close() + + def warning(self): + filename = self.source if self.warnonly else self.dest + g = codecs.open(filename, "r", "utf-8") + for i, line in enumerate(g, start=1): + for w in warnings: + if w[0] in line: + pywikibot.warning(u'line %d: %s>>> %s\n' % (i, line, w[1])) + g.close() + + +def main(): + filename = None + warnonly = False + + # Parse command line arguments for -help option + for arg in pywikibot.handleArgs(): + if arg.startswith('-warnonly'): + warnonly = True + elif not arg.startswith('-'): + filename = arg + else: + pywikibot.warning(arg + ' is not supported') + bot = ConvertBot(filename, warnonly) + bot.run() + + +if __name__ == "__main__": + pywikibot.stopme() # we do not work on any site + main()