jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/588997 )

Change subject: [IMPR] Rename diff parameter to show_diff in CosmeticChangesToolkit ......................................................................

[IMPR] Rename diff parameter to show_diff in CosmeticChangesToolkit

- diff parameter to show_diff which is more clearer what it purposes - deprecate the diff parameter in initializer - use diff setter/getter to deprecate its attribute usage - rename diff parameter to show_diff in from_page method - make show_diff and ignore a keyword argument in from_page method which have the same default values as CosmeticChangesToolkit.__init__ - upate from_page call in cosmetic_changes.py script

Change-Id: Ic1983a9981f740c25b1858c56e9892cacde73574 --- M pywikibot/cosmetic_changes.py M scripts/cosmetic_changes.py 2 files changed, 23 insertions(+), 8 deletions(-)

Approvals: Framawiki: Looks good to me, but someone else must approve Dvorapa: Looks good to me, approved jenkins-bot: Verified

diff --git a/pywikibot/cosmetic_changes.py b/pywikibot/cosmetic_changes.py index a75ea5a..37c3542 100755 --- a/pywikibot/cosmetic_changes.py +++ b/pywikibot/cosmetic_changes.py @@ -71,7 +71,9 @@ from pywikibot import textlib from pywikibot.textlib import (_MultiTemplateMatchBuilder, FILE_LINK_REGEX, _get_regexes) -from pywikibot.tools import deprecated_args, first_lower, first_upper +from pywikibot.tools import ( + deprecated, deprecated_args, first_lower, first_upper +)

# Subpage templates. Must be in lower case, @@ -202,12 +204,12 @@

"""Cosmetic changes toolkit."""

- @deprecated_args(debug='diff', redirect=None) - def __init__(self, site, diff=False, namespace=None, pageTitle=None, + @deprecated_args(debug='show_diff', redirect=None, diff='show_diff') + def __init__(self, site, show_diff=False, namespace=None, pageTitle=None, ignore=CANCEL_ALL): """Initializer.""" self.site = site - self.diff = diff + self.show_diff = show_diff try: self.namespace = self.site.namespaces.resolve(namespace).pop(0) except (KeyError, TypeError, IndexError): @@ -244,10 +246,23 @@ if stdnum_isbn: self.common_methods.append(self.fix_ISBN)

+ @property + @deprecated('show_diff', since='20200415') + def diff(self): + """CosmeticChangesToolkit.diff attribute getter.""" + return self.show_diff + + @diff.setter + @deprecated('show_diff', since='20200415') + def diff(self, value): + """CosmeticChangesToolkit.diff attribute setter.""" + self.show_diff = bool(value) + @classmethod - def from_page(cls, page, diff, ignore): + @deprecated_args(diff='show_diff') + def from_page(cls, page, show_diff=False, ignore=CANCEL_ALL): """Create toolkit based on the page.""" - return cls(page.site, diff=diff, namespace=page.namespace(), + return cls(page.site, show_diff=show_diff, namespace=page.namespace(), pageTitle=page.title(), ignore=ignore)

def safe_execute(self, method, text): @@ -283,7 +298,7 @@ else: raise else: - if self.diff: + if self.show_diff: pywikibot.showDiff(text, new_text) return new_text

diff --git a/scripts/cosmetic_changes.py b/scripts/cosmetic_changes.py index a45de3d..3069bcb 100644 --- a/scripts/cosmetic_changes.py +++ b/scripts/cosmetic_changes.py @@ -70,7 +70,7 @@ def treat_page(self): """Treat page with the cosmetic toolkit.""" cc_toolkit = cosmetic_changes.CosmeticChangesToolkit.from_page( - self.current_page, False, self.getOption('ignore')) + self.current_page, ignore=self.getOption('ignore')) changed_text = cc_toolkit.change(self.current_page.get()) if changed_text is not False: self.put_current(new_text=changed_text,