Pywikibot-commits April 2017

pywikibot-commits@lists.wikimedia.org

2 participants
100 discussions

[Gerrit] pywikibot/core[master]: [IMPR] Make a decorator for asynchronous methods

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/347171 ) Change subject: [IMPR] Make a decorator for asynchronous methods ...................................................................... [IMPR] Make a decorator for asynchronous methods Change-Id: Ib7a696aa45d395009bb096e30fb1900841a278d5 --- M pywikibot/page.py 1 file changed, 64 insertions(+), 41 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/page.py b/pywikibot/page.py index 00c60c3..0b1d8b6 100644 --- a/pywikibot/page.py +++ b/pywikibot/page.py @@ -71,6 +71,7 @@ PYTHON_VERSION, MediaWikiVersion, UnicodeMixin, ComparableMixin, DotReadableDict, deprecated, deprecate_arg, deprecated_args, issue_deprecation_warning, + add_full_name, manage_wrapping, ModuleDeprecationWrapper as _ModuleDeprecationWrapper, first_upper, redirect_func, remove_last_args, _NotImplementedWarning, OrderedDict, Counter, @@ -100,6 +101,46 @@ ) logger = logging.getLogger("pywiki.wiki.page") + + +@add_full_name +def allow_asynchronous(func): + """ + Decorator to make it possible to run a BasePage method asynchronously. + + This is done when the method is called with kwarg asynchronous=True. + Optionally, you can also provide kwarg callback, which, if provided, is + a callable that gets the page as the first and a possible exception that + occurred during saving in the second thread or None as the second argument. + """ + def handle(func, self, do_async=False, callback=None, *args, **kwargs): + err = None + try: + func(self, *args, **kwargs) + # TODO: other "expected" error types to catch? + except pywikibot.Error as edit_err: + err = edit_err # edit_err will be deleted in the end of the scope + link = self.title(asLink=True) + pywikibot.log('Error saving page %s (%s)\n' % (link, err), + exc_info=True) + if not callback and not do_async: + if isinstance(err, pywikibot.PageSaveRelatedError): + raise err + raise pywikibot.OtherPageSaveError(self, err) + if callback: + callback(self, err) + + def wrapper(self, *args, **kwargs): + do_async = kwargs.pop('asynchronous', False) + if do_async: + pywikibot.async_request(handle, func, self, do_async=True, + *args, **kwargs) + else: + handle(func, self, *args, **kwargs) + + manage_wrapping(wrapper, func) + + return wrapper # Note: Link objects (defined later on) represent a wiki-page's title, while @@ -1197,7 +1238,7 @@ @param quiet: enable/disable successful save operation message; defaults to False. In asynchronous mode, if True, it is up to the calling bot to - manage the ouput e.g. via callback. + manage the output e.g. via callback. @type quiet: bool """ if not summary: @@ -1209,47 +1250,26 @@ if not force and not self.botMayEdit(): raise pywikibot.OtherPageSaveError( self, "Editing restricted by {{bots}} template") - if asynchronous: - pywikibot.async_request(self._save, summary=summary, watch=watch, - minor=minor, botflag=botflag, - asynchronous=asynchronous, - callback=callback, - cc=apply_cosmetic_changes, - quiet=quiet, **kwargs) - else: - self._save(summary=summary, watch=watch, minor=minor, - botflag=botflag, asynchronous=asynchronous, - callback=callback, cc=apply_cosmetic_changes, - quiet=quiet, **kwargs) + self._save(summary=summary, watch=watch, minor=minor, botflag=botflag, + asynchronous=asynchronous, callback=callback, + cc=apply_cosmetic_changes, quiet=quiet, **kwargs) + @allow_asynchronous def _save(self, summary=None, watch=None, minor=True, botflag=None, - asynchronous=False, callback=None, cc=None, quiet=False, - **kwargs): + cc=None, quiet=False, **kwargs): """Helper function for save().""" - err = None link = self.title(asLink=True) if cc or cc is None and config.cosmetic_changes: summary = self._cosmetic_changes_hook(summary) or summary - try: - done = self.site.editpage(self, summary=summary, minor=minor, - watch=watch, bot=botflag, **kwargs) - if not done: - if not quiet: - pywikibot.warning(u"Page %s not saved" % link) - raise pywikibot.PageNotSaved(self) + + done = self.site.editpage(self, summary=summary, minor=minor, + watch=watch, bot=botflag, **kwargs) + if not done: if not quiet: - pywikibot.output(u"Page %s saved" % link) - # TODO: other "expected" error types to catch? - except pywikibot.Error as edit_err: - err = edit_err # edit_err will be deleted in the end of the scope - pywikibot.log(u"Error saving page %s (%s)\n" % (link, err), - exc_info=True) - if not callback and not asynchronous: - if isinstance(err, pywikibot.PageSaveRelatedError): - raise err - raise pywikibot.OtherPageSaveError(self, err) - if callback: - callback(self, err) + pywikibot.warning('Page %s not saved' % link) + raise pywikibot.PageNotSaved(self) + if not quiet: + pywikibot.output('Page %s saved' % link) def _cosmetic_changes_hook(self, comment): if self.isTalkPage() or \ @@ -3849,7 +3869,8 @@ return site.dbName() return site - def editEntity(self, data=None, asynchronous=False, **kwargs): + @allow_asynchronous + def editEntity(self, data=None, **kwargs): """ Edit an entity using Wikibase wbeditentity API. @@ -3861,14 +3882,16 @@ @param data: Data to be saved @type data: dict, or None to save the current content of the entity. - @param asynchronous: if True, launch a separate thread to edit + @keyword asynchronous: if True, launch a separate thread to edit asynchronously @type asynchronous: bool + @keyword callback: a callable object that will be called after the entity + has been updated. It must take two arguments: (1) a WikibasePage + object, and (2) an exception instance, which will be None if the + page was saved successfully. This is intended for use by bots that + need to keep track of which saves were successful. + @type callback: callable """ - if asynchronous: - pywikibot.async_request(self.editEntity, data, **kwargs) - return - if hasattr(self, '_revid'): baserevid = self.latest_revision_id else: -- To view, visit https://gerrit.wikimedia.org/r/347171 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ib7a696aa45d395009bb096e30fb1900841a278d5 Gerrit-PatchSet: 6 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: Update version string

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/348446 ) Change subject: Update version string ...................................................................... Update version string Change-Id: Ib4a25e7dbfc754afd1183f4666e4e2be4bcab0db --- M pywikibot/family.py 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Dalba: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/family.py b/pywikibot/family.py index d031b8a..e32078e 100644 --- a/pywikibot/family.py +++ b/pywikibot/family.py @@ -1263,7 +1263,7 @@ Use L{pywikibot.tools.MediaWikiVersion} to compare version strings. """ # Here we return the latest mw release for downloading - return '1.28.0' + return '1.28.1' def force_version(self, code): """ -- To view, visit https://gerrit.wikimedia.org/r/348446 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ib4a25e7dbfc754afd1183f4666e4e2be4bcab0db Gerrit-PatchSet: 1 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: [IMPR] Improve redirect.py

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/272327 ) Change subject: [IMPR] Improve redirect.py ...................................................................... [IMPR] Improve redirect.py - Enable direct iteration for RedirectGenerator - setup the generator in generator constructor using action parameter - derive RedirectRobot from SingleSiteBot - overwrite super class' init_page, just pass - setup action threat in bot constructor using action parameter - treat pages or page titles and call action_treat method to handle it - implement -total option for all actions - remove obsolete methods - use super class' run method. This fixes T153883 Bug: T153883 Change-Id: I94e3b920d4086ebf22fd8a8f41c2a0b33c6605fa --- M scripts/redirect.py 1 file changed, 45 insertions(+), 44 deletions(-) Approvals: Dalba: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/redirect.py b/scripts/redirect.py index f1cb2b7..fabe715 100755 --- a/scripts/redirect.py +++ b/scripts/redirect.py @@ -88,8 +88,8 @@ import pywikibot -from pywikibot import i18n, xmlreader, Bot -from pywikibot.bot import OptionHandler +from pywikibot import i18n, xmlreader +from pywikibot.bot import OptionHandler, SingleSiteBot from pywikibot.exceptions import ArgumentDeprecationWarning from pywikibot.textlib import extract_templates_and_params_regex_simple from pywikibot.tools.formatter import color_format @@ -121,7 +121,7 @@ 'xml': None, } - def __init__(self, **kwargs): + def __init__(self, action, **kwargs): """Constructor.""" super(RedirectGenerator, self).__init__(**kwargs) self.site = pywikibot.Site() @@ -134,6 +134,15 @@ self.api_number = self.getOption('total') self.api_until = self.getOption('until') self.xmlFilename = self.getOption('xml') + + # connect the generator selected by 'action' parameter + cls = self.__class__ + if action == 'double': + cls.__iter__ = lambda slf: slf.retrieve_double_redirects() + elif action == 'broken': + cls.__iter__ = lambda slf: slf.retrieve_broken_redirects() + elif action == 'both': + cls.__iter__ = lambda slf: slf.get_redirects_via_api(maxlen=2) def get_redirects_from_dump(self, alsoGetPageTitles=False): """ @@ -392,7 +401,7 @@ continue -class RedirectRobot(Bot): +class RedirectRobot(SingleSiteBot): """Redirect bot.""" @@ -407,9 +416,19 @@ self.site = pywikibot.Site() self.repo = self.site.data_repository() self.is_repo = self.repo if self.repo == self.site else None - self.action = action self.exiting = False self.sdtemplate = self.get_sd_template() + + # connect the action treat + if action == 'double': + self.action_treat = self.fix_1_double_redirect + elif action == 'broken': + self.action_treat = self.delete_1_broken_redirect + elif action == 'both': + self.action_treat = self.fix_double_or_delete_broken_redirect + else: + raise NotImplementedError('No valid action "{0}" found.' + ''.format(action)) def get_sd_template(self): """Look for speedy deletion template and return it. @@ -439,6 +458,10 @@ ''.format('"{0}" '.format(title) if title else '')) return None + def init_page(self, page): + """Overwrite super class method.""" + pass + def delete_redirect(self, page, summary_key): """Delete the redirect page.""" assert page.site == self.site, ( @@ -460,12 +483,6 @@ page.put(content, reason) except pywikibot.PageSaveRelatedError as e: pywikibot.error(e) - - def delete_broken_redirects(self): - """Process all broken redirects.""" - # get reason for deletion text - for redir_name in self.generator.retrieve_broken_redirects(): - self.delete_1_broken_redirect(redir_name) def delete_1_broken_redirect(self, redir_name): """Treat one broken redirect.""" @@ -566,11 +583,6 @@ targetPage.title(asLink=True), "Won't delete anything." if self.getOption('delete') else "Skipping.")) - - def fix_double_redirects(self): - """Process double redirects.""" - for redir_name in self.generator.retrieve_double_redirects(): - self.fix_1_double_redirect(redir_name) def fix_1_double_redirect(self, redir_name): """Treat one double redirect.""" @@ -711,34 +723,23 @@ % (redir.title(), error)) break - def fix_double_or_delete_broken_redirects(self): - """Process all redirects for 'both' action.""" - # TODO: part of this should be moved to generator, the rest merged into - # self.run() - count = 0 - for (redir_name, code, target, final)\ - in self.generator.get_redirects_via_api(maxlen=2): - if code == 1: - continue - elif code == 0: - self.delete_1_broken_redirect(redir_name) - count += 1 - else: - self.fix_1_double_redirect(redir_name) - count += 1 - if count >= self.getOption('total'): - break + def fix_double_or_delete_broken_redirect(self, page): + """Treat one broken or double redirect.""" + redir_name, code, target, final = page + if code == 1: + return + elif code == 0: + self.delete_1_broken_redirect(redir_name) + else: + self.fix_1_double_redirect(redir_name) - def run(self): - """Run the script method selected by 'action' parameter.""" - # TODO: make all generators return a redirect type indicator, - # thus make them usable with 'both' - if self.action == 'double': - self.fix_double_redirects() - elif self.action == 'broken': - self.delete_broken_redirects() - elif self.action == 'both': - self.fix_double_or_delete_broken_redirects() + def treat(self, page): + """Treat a single page.""" + self.action_treat(page) + if self._treat_counter >= self.getOption('total'): + pywikibot.output('\nNumber of pages reached the total limit. ' + 'Script terminated.') + self.quit() def main(*args): @@ -821,7 +822,7 @@ pywikibot.bot.suggest_help(missing_action=True) else: pywikibot.Site().login() - options['generator'] = RedirectGenerator(**gen_options) + options['generator'] = RedirectGenerator(action, **gen_options) bot = RedirectRobot(action, **options) bot.run() -- To view, visit https://gerrit.wikimedia.org/r/272327 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I94e3b920d4086ebf22fd8a8f41c2a0b33c6605fa Gerrit-PatchSet: 10 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: [IMPR] use OptionHandler for redirect.RedirectGenerator

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/347586 ) Change subject: [IMPR] use OptionHandler for redirect.RedirectGenerator ...................................................................... [IMPR] use OptionHandler for redirect.RedirectGenerator - use float('inf') as default value for 'total' option to compare with Redirect bot counter (thanks Dalba) - Improve option choice: You can have only one option out of "fullscan", "move" or "xml" (or none of them for the default double/broken redirects) - fix for redirect_bot_tests.py Change-Id: I263384471b39fcc24e4a9cddea31f6e21ae16d65 --- M scripts/redirect.py M tests/redirect_bot_tests.py 2 files changed, 56 insertions(+), 62 deletions(-) Approvals: Dalba: Looks good to me, approved jenkins-bot: Verified diff --git a/scripts/redirect.py b/scripts/redirect.py index 6ff9da3..f1cb2b7 100755 --- a/scripts/redirect.py +++ b/scripts/redirect.py @@ -89,6 +89,7 @@ import pywikibot from pywikibot import i18n, xmlreader, Bot +from pywikibot.bot import OptionHandler from pywikibot.exceptions import ArgumentDeprecationWarning from pywikibot.textlib import extract_templates_and_params_regex_simple from pywikibot.tools.formatter import color_format @@ -104,26 +105,35 @@ return link.canonical_title().replace(' ', '_') -class RedirectGenerator(object): +class RedirectGenerator(OptionHandler): """Redirect generator.""" - def __init__(self, xmlFilename=None, namespaces=[], offset=-1, - use_move_log=False, use_api=False, start=None, until=None, - number=None, page_title=None): + availableOptions = { + 'fullscan': False, + 'moves': False, + 'namespaces': [0], + 'offset': -1, + 'page': None, + 'start': None, + 'total': None, + 'until': None, + 'xml': None, + } + + def __init__(self, **kwargs): """Constructor.""" + super(RedirectGenerator, self).__init__(**kwargs) self.site = pywikibot.Site() - self.xmlFilename = xmlFilename - self.namespaces = namespaces - if use_api and not self.namespaces: - self.namespaces = [0] - self.offset = offset - self.use_move_log = use_move_log - self.use_api = use_api - self.api_start = start - self.api_until = until - self.api_number = number - self.page_title = page_title + self.use_api = self.getOption('fullscan') + self.use_move_log = self.getOption('moves') + self.namespaces = self.getOption('namespaces') + self.offset = self.getOption('offset') + self.page_title = self.getOption('page') + self.api_start = self.getOption('start') + self.api_number = self.getOption('total') + self.api_until = self.getOption('until') + self.xmlFilename = self.getOption('xml') def get_redirects_from_dump(self, alsoGetPageTitles=False): """ @@ -386,10 +396,10 @@ """Redirect bot.""" - def __init__(self, action, generator, **kwargs): + def __init__(self, action, **kwargs): """Constructor.""" self.availableOptions.update({ - 'number': None, + 'total': float('inf'), 'delete': False, 'sdtemplate': None, }) @@ -398,7 +408,6 @@ self.repo = self.site.data_repository() self.is_repo = self.repo if self.repo == self.site else None self.action = action - self.generator = generator self.exiting = False self.sdtemplate = self.get_sd_template() @@ -717,7 +726,7 @@ else: self.fix_1_double_redirect(redir_name) count += 1 - if self.getOption('number') and count >= self.getOption('number'): + if count >= self.getOption('total'): break def run(self): @@ -742,29 +751,16 @@ @type args: list of unicode """ options = {} + gen_options = {} # what the bot should do (either resolve double redirs, or process broken # redirs) action = None - # where the bot should get his infos from (either None to load the - # maintenance special page from the live wiki, or the filename of a - # local XML dump file) - xmlFilename = None - # Which namespace should be processed when using a XML dump - # default to -1 which means all namespaces will be processed namespaces = [] - # at which redirect shall we start searching double redirects again - # (only with dump); default to -1 which means all redirects are checked - offset = -1 - moved_pages = False - fullscan = False - start = '' - until = '' - number = None - pagename = None + source = set() for arg in pywikibot.handle_args(args): arg, sep, value = arg.partition(':') - option = arg[1:] + option = arg.partition('-')[2] # bot options if arg == 'do': action = 'double' @@ -775,17 +771,18 @@ elif option in ('always', 'delete'): options[option] = True elif option == 'total': - options['number'] = number = int(value) + options[option] = gen_options[option] = int(value) elif option == 'sdtemplate': options['sdtemplate'] = value or pywikibot.input( 'Which speedy deletion template to use?') # generator options - elif option == 'fullscan': - fullscan = True + elif option in ('fullscan', 'moves'): + gen_options[option] = True + source.add(arg) elif option == 'xml': - xmlFilename = value or i18n.input('pywikibot-enter-xml-filename') - elif option == 'moves': - moved_pages = True + gen_options[option] = value or i18n.input( + 'pywikibot-enter-xml-filename') + source.add(arg) elif option == 'namespace': # "-namespace:" does NOT yield -namespace:0 further down the road! ns = value or i18n.input('pywikibot-enter-namespace-number') @@ -802,13 +799,9 @@ if ns not in namespaces: namespaces.append(ns) elif option == 'offset': - offset = int(value) - elif option == 'start': - start = value - elif option == 'until': - until = value - elif option == 'page': - pagename = value + gen_options[option] = int(value) + elif option in ('page', 'start', 'until'): + gen_options[option] = value # deprecated or unknown options elif option == 'step': issue_deprecation_warning('The usage of "{0}"'.format(arg), @@ -816,19 +809,20 @@ else: pywikibot.output(u'Unknown argument: %s' % arg) - if not action or xmlFilename and (moved_pages or fullscan): - problems = [] - if xmlFilename and moved_pages: - problems += ['Either use a XML file or the moved pages from the API'] - if xmlFilename and fullscan: - problems += ['Either use a XML file or do a full scan using the API'] - pywikibot.bot.suggest_help(additional_text='\n'.join(problems), + gen_options['namespaces'] = namespaces + + if len(source) > 1: + problem = 'You can only use one of {0} options.'.format( + ' or '.join(source)) + pywikibot.bot.suggest_help(additional_text=problem, missing_action=not action) + return + if not action: + pywikibot.bot.suggest_help(missing_action=True) else: pywikibot.Site().login() - gen = RedirectGenerator(xmlFilename, namespaces, offset, moved_pages, - fullscan, start, until, number, pagename) - bot = RedirectRobot(action, gen, **options) + options['generator'] = RedirectGenerator(**gen_options) + bot = RedirectRobot(action, **options) bot.run() if __name__ == '__main__': diff --git a/tests/redirect_bot_tests.py b/tests/redirect_bot_tests.py index 358ae7d..feb5bfa 100644 --- a/tests/redirect_bot_tests.py +++ b/tests/redirect_bot_tests.py @@ -33,21 +33,21 @@ def test_with_delete_and_existing_sdtemplate(self): """Test with delete and existing sdtemplate.""" options = {'delete': True, 'sdtemplate': '{{t}}'} - bot = RedirectRobot('broken', None, **options) + bot = RedirectRobot('broken', **options) self.assertEqual(bot.sdtemplate, '{{t}}') @patch.object(i18n, 'twhas_key', new=Mock(return_value=True)) @patch.object(i18n, 'twtranslate', new=Mock(return_value='{{sd_title}}')) def test_with_delete_and_i18n_sd(self): """Test with delete and i18n template.""" - bot = RedirectRobot('broken', None, delete=True) + bot = RedirectRobot('broken', delete=True) self.assertEqual(bot.sdtemplate, '{{sd_title}}') @patch.object(i18n, 'twhas_key', new=Mock(return_value=False)) def test_with_delete_no_sd_no_i18n(self): """Test with delete and no i18n template.""" with patch.object(pywikibot, 'warning') as w: - bot = RedirectRobot('broken', None, delete=True) + bot = RedirectRobot('broken', delete=True) w.assert_called_with('No speedy deletion template available.') self.assertEqual(bot.sdtemplate, None) @@ -56,6 +56,6 @@ options = {'delete': True, 'sdtemplate': 'txt {{n|a}} txt'} with patch.object(Page, 'exists', new=Mock(return_value=False)): with patch.object(pywikibot, 'warning') as w: - bot = RedirectRobot('broken', None, **options) + bot = RedirectRobot('broken', **options) w.assert_called_with('No speedy deletion template "n" available.') self.assertEqual(bot.sdtemplate, None) -- To view, visit https://gerrit.wikimedia.org/r/347586 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I263384471b39fcc24e4a9cddea31f6e21ae16d65 Gerrit-PatchSet: 6 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: [IMPR] Provide options by a separate handler class

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/272316 ) Change subject: [IMPR] Provide options by a separate handler class ...................................................................... [IMPR] Provide options by a separate handler class - provide an option handler class - derive BaseBot from OptionHandler class There are som generator classes who could derive from OptionHandler: - redirect.RedirectGenerator - pagefromfile.PageFromFileReader Will be done in a separate patch set. - rewrite help message for redirect.py Change-Id: Ib281147d38f3d6eaf34f1a1ad0c7c920513f0d79 --- M pywikibot/bot.py 1 file changed, 48 insertions(+), 27 deletions(-) Approvals: Dalba: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/bot.py b/pywikibot/bot.py index 4785117..4cef28a 100644 --- a/pywikibot/bot.py +++ b/pywikibot/bot.py @@ -1131,31 +1131,16 @@ i18n.input('pywikibot-enter-finished-browser') -class BaseBot(object): +class OptionHandler(object): - """ - Generic Bot to be subclassed. + """Class to get and set options.""" - This class provides a run() method for basic processing of a - generator one page at a time. - - If the subclass places a page generator in self.generator, - Bot will process each page in the generator, invoking the method treat() - which must then be implemented by subclasses. - - If the subclass does not set a generator, or does not override - treat() or run(), NotImplementedError is raised. - """ - - # Bot configuration. + # Handler configuration. # Only the keys of the dict can be passed as init options # The values are the default values - # Extend this in subclasses! - availableOptions = { - 'always': False, # By default ask for confirmation when putting a page - } + # Overwrite this in subclasses! - _current_page = None + availableOptions = {} def __init__(self, **kwargs): """ @@ -1164,13 +1149,7 @@ @param kwargs: bot options @type kwargs: dict """ - if 'generator' in kwargs: - self.generator = kwargs.pop('generator') - self.setOptions(**kwargs) - - self._treat_counter = 0 - self._save_counter = 0 def setOptions(self, **kwargs): """ @@ -1196,13 +1175,55 @@ """ Get the current value of an option. - @param option: key defined in Bot.availableOptions + @param option: key defined in OptionHandler.availableOptions """ try: return self.options.get(option, self.availableOptions[option]) except KeyError: raise pywikibot.Error(u'%s is not a valid bot option.' % option) + +class BaseBot(OptionHandler): + + """ + Generic Bot to be subclassed. + + This class provides a run() method for basic processing of a + generator one page at a time. + + If the subclass places a page generator in self.generator, + Bot will process each page in the generator, invoking the method treat() + which must then be implemented by subclasses. + + If the subclass does not set a generator, or does not override + treat() or run(), NotImplementedError is raised. + """ + + # Handler configuration. + # The values are the default values + # Extend this in subclasses! + + availableOptions = { + 'always': False, # By default ask for confirmation when putting a page + } + + _current_page = None + + def __init__(self, **kwargs): + """ + Only accept options defined in availableOptions. + + @param kwargs: bot options + @type kwargs: dict + """ + if 'generator' in kwargs: + self.generator = kwargs.pop('generator') + + super(BaseBot, self).__init__(**kwargs) + + self._treat_counter = 0 + self._save_counter = 0 + @property def current_page(self): """Return the current working page as a property.""" -- To view, visit https://gerrit.wikimedia.org/r/272316 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ib281147d38f3d6eaf34f1a1ad0c7c920513f0d79 Gerrit-PatchSet: 15 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: DrTrigon <dr.trigon(a)surfeu.ch> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Ladsgroup <Ladsgroup(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Matěj Suchánek <matejsuchanek97(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: Ricordisamoa <ricordisamoa(a)openmailbox.org> Gerrit-Reviewer: Russell Blau <russblau(a)imapmail.org> Gerrit-Reviewer: XZise <CommodoreFabianus(a)gmx.de> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: category.py : add link in the default summary

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/348445 ) Change subject: category.py : add link in the default summary ...................................................................... category.py : add link in the default summary Bug: T151109 Change-Id: Ie8e0cee269e3e4d5f21bc2c31b426f2a740feb44 --- M scripts/category.py 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/scripts/category.py b/scripts/category.py index 7e7bd69..ffdd13c 100755 --- a/scripts/category.py +++ b/scripts/category.py @@ -488,7 +488,7 @@ template_vars = {'oldcat': self.oldcat.title(withNamespace=False)} if self.newcat: template_vars.update({ - 'newcat': self.newcat.title(withNamespace=False), + 'newcat': self.newcat.title(withNamespace=False, asLink=True), 'title': self.newcat.title(withNamespace=False)}) # Set edit summary for changed pages. if comment: -- To view, visit https://gerrit.wikimedia.org/r/348445 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Ie8e0cee269e3e4d5f21bc2c31b426f2a740feb44 Gerrit-PatchSet: 1 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Gerrit Patch Uploader <gerritpatchuploader(a)gmail.com> Gerrit-Reviewer: Framawiki <framawiki(a)tools.wmflabs.org> Gerrit-Reviewer: Gerrit Patch Uploader <gerritpatchuploader(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: [bugfix] new intersection of property names

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/348383 ) Change subject: [bugfix] new intersection of property names ...................................................................... [bugfix] new intersection of property names - The intersection of property names has been changed for the tested wikis. Remove page_top_level_section_count from this list. Bug: T163071 Change-Id: If1980313b6803a6e8f61c2bef9177af4ca980004 --- M tests/site_tests.py 1 file changed, 3 insertions(+), 3 deletions(-) Approvals: Dalba: Looks good to me, approved jenkins-bot: Verified diff --git a/tests/site_tests.py b/tests/site_tests.py index b2b06c6..1dffc0d 100644 --- a/tests/site_tests.py +++ b/tests/site_tests.py @@ -3336,9 +3336,9 @@ for item in ('defaultsort', 'disambiguation', 'displaytitle', 'forcetoc', 'graph_specs', 'hiddencat', 'newsectionlink', 'noeditsection', 'noexternallanglinks', 'nogallery', - 'noindex', 'nonewsectionlink', 'notoc', - 'page_top_level_section_count', 'score', 'templatedata', - 'wikibase-badge-Q17437796', 'wikibase_item'): + 'noindex', 'nonewsectionlink', 'notoc', 'score', + 'templatedata', 'wikibase-badge-Q17437796', + 'wikibase_item'): self.assertIn(item, pnames) -- To view, visit https://gerrit.wikimedia.org/r/348383 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: If1980313b6803a6e8f61c2bef9177af4ca980004 Gerrit-PatchSet: 1 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: config2: use repr() of exceptions to prevent UnicodeDecodeEr...

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/348444 ) Change subject: config2: use repr() of exceptions to prevent UnicodeDecodeErrors ...................................................................... config2: use repr() of exceptions to prevent UnicodeDecodeErrors When no program is configured to open .py files, the _win32_extension_command function will throw an OSError. On non-English Windows versions, this error often contains non-ascii characters. On Python 2, this error will be a str in the Windows' multi byte encoding. Trying to decode this error with a different encoding will cause an UnicodeDecodeError, which then blocks Pywikibot from being used. Instead of trying to guess the correct encoding to use, use the repr() of the string. This is guaranteed to be ascii, and can therefore always be embedded in a unicode string safely. Bug: T120222 Change-Id: I47e2756259ecbc1279e1124c076622177b3fc1d6 --- M pywikibot/config2.py 1 file changed, 1 insertion(+), 1 deletion(-) Approvals: Merlijn van Deen: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/config2.py b/pywikibot/config2.py index 90877ba..e0bac1e 100644 --- a/pywikibot/config2.py +++ b/pywikibot/config2.py @@ -942,7 +942,7 @@ return cmd[:-1].strip() except WindowsError as e: # Catch any key lookup errors - output('Unable to detect program for file extension "{0}": {1}'.format( + output('Unable to detect program for file extension "{0}": {1!r}'.format( extension, e)) -- To view, visit https://gerrit.wikimedia.org/r/348444 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I47e2756259ecbc1279e1124c076622177b3fc1d6 Gerrit-PatchSet: 2 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Gerrit Patch Uploader <gerritpatchuploader(a)gmail.com> Gerrit-Reviewer: Framawiki <framawiki(a)tools.wmflabs.org> Gerrit-Reviewer: Gerrit Patch Uploader <gerritpatchuploader(a)gmail.com> Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: pywikibot/__init__.py: Do not use `deprecate_arg`

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/347138 ) Change subject: pywikibot/__init__.py: Do not use `deprecate_arg` ...................................................................... pywikibot/__init__.py: Do not use `deprecate_arg` `deprecate_arg` is deprecated itself and redirected to `pywikibot.tools.deprecate_arg` which is imported as `__deprecate_arg`. Rename `__deprecate_arg` to `_deprecate_arg`. Python mangles names that start with two leading underscores inside classes to make them private. This prevented the usage of `__deprecate_arg` in Coordinate class. Bug: T162509 Change-Id: Icf557d5f337c302b328ad784317cdb2934bcf458 --- M pywikibot/__init__.py 1 file changed, 3 insertions(+), 3 deletions(-) Approvals: jenkins-bot: Verified Xqt: Looks good to me, approved diff --git a/pywikibot/__init__.py b/pywikibot/__init__.py index 45b08f5..59016c3 100644 --- a/pywikibot/__init__.py +++ b/pywikibot/__init__.py @@ -69,7 +69,7 @@ from pywikibot.tools import ( # __ to avoid conflict with ModuleDeprecationWrapper._deprecated deprecated as __deprecated, - deprecate_arg as __deprecate_arg, + deprecate_arg as _deprecate_arg, normalize_username, MediaWikiVersion, redirect_func, @@ -130,7 +130,7 @@ deprecated = redirect_func(__deprecated) -deprecate_arg = redirect_func(__deprecate_arg) +deprecate_arg = redirect_func(_deprecate_arg) class Timestamp(datetime.datetime): @@ -235,7 +235,7 @@ _items = ('lat', 'lon', 'globe') - @deprecate_arg('entity', 'globe_item') + @_deprecate_arg('entity', 'globe_item') def __init__(self, lat, lon, alt=None, precision=None, globe='earth', typ='', name='', dim=None, site=None, globe_item=None): """ -- To view, visit https://gerrit.wikimedia.org/r/347138 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: Icf557d5f337c302b328ad784317cdb2934bcf458 Gerrit-PatchSet: 1 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: Dalba <dalba.wiki(a)gmail.com> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Lokal Profil <lokal.profil(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot <>

7 years

[Gerrit] pywikibot/core[master]: [IMPR] Show a warning when a LogEntry type is not known

by jenkins-bot (Code Review)

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/289227 ) Change subject: [IMPR] Show a warning when a LogEntry type is not known ...................................................................... [IMPR] Show a warning when a LogEntry type is not known - a warning could ensure to update the bot for unknown types - put the return statement outside the try statement to ensure that only the missing 'type' key is fetched by this exception Bug: T135505 Change-Id: I096cf636c6da1d65fe578e053594a5203d4dceb8 --- M pywikibot/logentries.py 1 file changed, 4 insertions(+), 2 deletions(-) Approvals: Mpaa: Looks good to me, approved jenkins-bot: Verified diff --git a/pywikibot/logentries.py b/pywikibot/logentries.py index 7665806..310d826 100644 --- a/pywikibot/logentries.py +++ b/pywikibot/logentries.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- """Objects representing Mediawiki log entries.""" # -# (C) Pywikibot team, 2007-2016 +# (C) Pywikibot team, 2007-2017 # # Distributed under the terms of the MIT license. # @@ -431,6 +431,8 @@ try: return cls.logtypes[logtype] except KeyError: + pywikibot.warning( + 'Log entry key {0} is not known.'.format(logtype)) return LogEntry def _createFromData(self, logdata): @@ -443,8 +445,8 @@ """ try: logtype = logdata['type'] - return LogEntryFactory._getEntryClass(logtype)(logdata, self._site) except KeyError: pywikibot.debug('API log entry received:\n{0}'.format(logdata), _logger) raise Error("Log entry has no 'type' key") + return LogEntryFactory._getEntryClass(logtype)(logdata, self._site) -- To view, visit https://gerrit.wikimedia.org/r/289227 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I096cf636c6da1d65fe578e053594a5203d4dceb8 Gerrit-PatchSet: 3 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Xqt <info(a)gno.de> Gerrit-Reviewer: John Vandenberg <jayvdb(a)gmail.com> Gerrit-Reviewer: Magul <tomasz.magulski(a)gmail.com> Gerrit-Reviewer: Mpaa <mpaa.wiki(a)gmail.com> Gerrit-Reviewer: jenkins-bot <>

7 years

← Newer
1
2
3
4
5
6
7
8
9
10
Older →

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

Pywikibot-commits April 2017