[Pywikibot-commits] [Gerrit] pywikibot/core[master]: Remove diff_checker.py

jenkins-bot has submitted this change and it was merged. ( https://gerrit.wikimedia.org/r/506118 ) Change subject: Remove diff_checker.py ...................................................................... Remove diff_checker.py With T221462 being resolved, I think all of diff_checker checks are now performed by flake8 and its plugins. Change-Id: I6c96567a1c27b48e577602b062d49f0c7e6feaea --- M docs/scripts/scripts.maintenance.rst D scripts/maintenance/diff_checker.py M tox.ini 3 files changed, 0 insertions(+), 174 deletions(-) Approvals: Xqt: Looks good to me, approved jenkins-bot: Verified diff --git a/docs/scripts/scripts.maintenance.rst b/docs/scripts/scripts.maintenance.rst index 705963e..b1c17fa 100644 --- a/docs/scripts/scripts.maintenance.rst +++ b/docs/scripts/scripts.maintenance.rst @@ -33,14 +33,6 @@ :undoc-members: :show-inheritance: -scripts.maintenance.diff\_checker script ----------------------------------------- - -.. automodule:: scripts.maintenance.diff_checker - :members: - :undoc-members: - :show-inheritance: - scripts.maintenance.download\_dump script ----------------------------------------- diff --git a/scripts/maintenance/diff_checker.py b/scripts/maintenance/diff_checker.py deleted file mode 100644 index 1dc9b3b..0000000 --- a/scripts/maintenance/diff_checker.py +++ /dev/null @@ -1,160 +0,0 @@ -#!/usr/bin/python -# -*- coding: utf-8 -*- -"""Check that the latest commit diff follows the guidelines. - -Currently the script checks the following code style issues: - - Line lengths: Newly added lines longer than 79 chars are not allowed. - - Unicode literal notations: They are not allowed since we instead import - unicode_literals from __future__. - - Single-quoted strings are preferred, but when a string contains single - quote characters, use double quotes to avoid backslashes in the string. - -See [[Manual:Pywikibot/Development/Guidelines]] for more info. - -Todo: The following rules can be added in the future: - - Prefer string.format() instead of modulo operator % for string - formatting. The modulo operator might be deprecated by a future - python release. -""" -# -# (C) Pywikibot team, 2017-2019 -# -# Distributed under the terms of the MIT license. -# - -from __future__ import ( - absolute_import, division, print_function, unicode_literals) - -from re import compile as re_compile, IGNORECASE -from subprocess import check_output -from sys import version_info - -from unidiff import PatchSet - -from pywikibot import __url__ - -if version_info.major == 3: - PY2 = False - from tokenize import tokenize, STRING -else: - PY2 = True - from tokenize import generate_tokens as tokenize, STRING - - -# Regexp for a line that is allowed to be longer than the limit. -# It does not make sense to break long URLs. -# https://github.com/PyCQA/pylint/blob/d42e74bb9428f895f36808d30bd8a1fe31e28f… -IGNORABLE_LONG_LINE = re_compile(r'\s*(# )?<?https?://\S+>?$').match - -STRING_MATCH = re_compile( - r'(?P<prefix>[bfru]*)?(?P<quote>\'+|"+).', IGNORECASE, -).match - - -def get_latest_patchset(): - """Return the PatchSet for the latest commit.""" - # regex from https://github.com/PyCQA/pylint/blob/master/pylintrc - output = check_output( - ['git', 'diff', '-U0', '@~..@']) - return PatchSet.from_string( - output.replace(b'\r\n', b'\n'), encoding='utf-8') - - -def print_error(path, line_no, col_no, error): - """Print the error.""" - print('{}:{}:{}: {}'.format(path, line_no, col_no, error)) # noqa: T001 - - -def check_quotes(match, file_path, start): - """Check string quotes and return True if there are no errors.""" - string = match.string - quote = match.group('quote') - if quote == '"': - if "'" not in string: - print_error( - file_path, start[0], start[1] + 1, - "use 'single-quoted' strings " - '(unless the string contains single quote characters)') - return False - elif quote == "'": - if ( - 'r' not in match.group('prefix') - and string.count(r'\'') - int(string.endswith(r'\'')) - and '"' not in string - ): - print_error( - file_path, start[0], start[1] + 1, - r'use a "double-quoted" string to avoid \' escape sequence') - return False - return True - - -def check_tokens(file_path, line_nos): - """Check the style of lines in the given file_path.""" - no_errors = True - max_line = max(line_nos) - with open(file_path, 'rb') as f: - token_generator = tokenize(f.readline) - for type_, string, start, end, line_val in token_generator: - if max_line < start[0]: - break - if start[0] not in line_nos or type_ != STRING: - continue - if PY2: - string = string.decode('utf-8') - match = STRING_MATCH(string) - if 'u' in match.group('prefix'): - no_errors = False - print_error( - file_path, start[0], start[1] + 1, - 'newly-added/modified line with u"" prefixed string ' - 'literal', - ) - no_errors = check_quotes(match, file_path, start) and no_errors - return no_errors - - -def check(latest_patchset): - """Check that the added/modified lines do not violate the guideline. - - @return: True if there are no error, False otherwise. - @rtype: bool - """ - no_errors = True - for patched_file in latest_patchset: - path = patched_file.path - if not (path.endswith('.py') or patched_file.is_removed_file): - continue - added_lines = set() - for hunk in patched_file: - for line in hunk: - if not line.is_added: - continue - line_no = line.target_line_no - added_lines.add(line_no) - line_val = line.value - # Check line length - if len(line_val) > 80 and not IGNORABLE_LONG_LINE(line_val): - print_error( - path, line_no, len(line_val), - 'newly-added/modified line longer than 79 characters', - ) - no_errors = False - if added_lines: - no_errors = check_tokens(path, added_lines) and no_errors - return no_errors - - -def main(): - """Run this script.""" - latest_patchset = get_latest_patchset() - if not check(latest_patchset): - raise SystemExit( - 'diff-checker failed.\n' - 'Please review <{}/Development/Guidelines#Miscellaneous> ' - 'and update your patch-set accordingly.'.format(__url__) - ) - - -if __name__ == '__main__': - main() diff --git a/tox.ini b/tox.ini index 8dbf4ae..a3c926e 100644 --- a/tox.ini +++ b/tox.ini @@ -4,7 +4,6 @@ skipsdist = True skip_missing_interpreters = True envlist = - diff-checker commit-message flake8-{py27,py3,pypy} doctest-{py27,py34} @@ -14,7 +13,6 @@ # Override default for WM Jenkins # Others are run in their own individual jobs on WM Jenkins envlist = - diff-checker commit-message flake8-{py27,py3,pypy} @@ -47,10 +45,6 @@ fasttest-py34: nose-detecthttp>=0.1.3 fasttest-py34: six -[testenv:diff-checker] -deps = unidiff -commands = python scripts/maintenance/diff_checker.py - [testenv:commit-message] deps = commit-message-validator commands = commit-message-validator -- To view, visit https://gerrit.wikimedia.org/r/506118 To unsubscribe, or for help writing mail filters, visit https://gerrit.wikimedia.org/r/settings Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-MessageType: merged Gerrit-Change-Id: I6c96567a1c27b48e577602b062d49f0c7e6feaea Gerrit-Change-Number: 506118 Gerrit-PatchSet: 2 Gerrit-Owner: Dalba &lt;dalba.wiki(a)gmail.com&gt; Gerrit-Reviewer: Dalba &lt;dalba.wiki(a)gmail.com&gt; Gerrit-Reviewer: Xqt &lt;info(a)gno.de&gt; Gerrit-Reviewer: jenkins-bot (75)