Patch Detail
Show a patch.
GET /api/patches/1519/?format=api
{ "id": 1519, "url": "https://patchwork.libcamera.org/api/patches/1519/?format=api", "web_url": "https://patchwork.libcamera.org/patch/1519/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/projects/1/?format=api", "name": "libcamera", "link_name": "libcamera", "list_id": "libcamera_core", "list_email": "libcamera-devel@lists.libcamera.org", "web_url": "", "scm_url": "", "webscm_url": "" }, "msgid": "<20190625170917.17818-1-laurent.pinchart@ideasonboard.com>", "date": "2019-06-25T17:09:16", "name": "[libcamera-devel,1/2] utils: checkstyle.py: Refactor formatters and checkers support", "commit_ref": null, "pull_url": null, "state": "accepted", "archived": false, "hash": "e78a62eeddf09b700aeb76ff5bdfadac3e2b0dab", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/1519/mbox/", "series": [ { "id": 375, "url": "https://patchwork.libcamera.org/api/series/375/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=375", "date": "2019-06-25T17:09:16", "name": "[libcamera-devel,1/2] utils: checkstyle.py: Refactor formatters and checkers support", "version": 1, "mbox": "https://patchwork.libcamera.org/series/375/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/1519/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/1519/checks/", "tags": {}, "headers": { "Return-Path": "<laurent.pinchart@ideasonboard.com>", "Received": [ "from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[IPv6:2001:4b98:dc2:55:216:3eff:fef7:d647])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 464C860103\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 25 Jun 2019 19:09:40 +0200 (CEST)", "from pendragon.bb.dnainternet.fi\n\t(dfj612yhrgyx302h3jwwy-3.rev.dnainternet.fi\n\t[IPv6:2001:14ba:21f5:5b00:ce28:277f:58d7:3ca4])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id CA867510\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tTue, 25 Jun 2019 19:09:39 +0200 (CEST)" ], "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1561482579;\n\tbh=ttD+kglOiWrxthWdMaNZVnR8m68E9Q2ym9CgYwPNKRY=;\n\th=From:To:Subject:Date:From;\n\tb=KuD5/98/erNukXOgSCJcO9mTmEOcrPTfC12T0g3CuXpDAuMkJiiORNrwOKqyPW0x4\n\tz3Eotc/tZL0G4rEI64jS7zxI6LXqJ9lGHqtCKhyaRCQnERjSB3tqPpt9akcvM1f/Y9\n\tO7dUL0nLPIeNbiGo8saG4zWB+Y85XhNl6yaeWiqw=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Date": "Tue, 25 Jun 2019 20:09:16 +0300", "Message-Id": "<20190625170917.17818-1-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.21.0", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "Subject": "[libcamera-devel] [PATCH 1/2] utils: checkstyle.py: Refactor\n\tformatters and checkers support", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.23", "Precedence": "list", "List-Id": "<libcamera-devel.lists.libcamera.org>", "List-Unsubscribe": "<https://lists.libcamera.org/options/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=unsubscribe>", "List-Archive": "<https://lists.libcamera.org/pipermail/libcamera-devel/>", "List-Post": "<mailto:libcamera-devel@lists.libcamera.org>", "List-Help": "<mailto:libcamera-devel-request@lists.libcamera.org?subject=help>", "List-Subscribe": "<https://lists.libcamera.org/listinfo/libcamera-devel>,\n\t<mailto:libcamera-devel-request@lists.libcamera.org?subject=subscribe>", "X-List-Received-Date": "Tue, 25 Jun 2019 17:09:40 -0000" }, "content": "Introduce two new base classes for the code formatters and style\ncheckers, with an auto-registration mechanism that automatically uses\nall derived classes. This will allow easier addition of new formatters\nand checkers.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n utils/checkstyle.py | 202 ++++++++++++++++++++++++++++++++------------\n 1 file changed, 149 insertions(+), 53 deletions(-)", "diff": "diff --git a/utils/checkstyle.py b/utils/checkstyle.py\nindex 9abd2687b1f9..5c8bde6e1f46 100755\n--- a/utils/checkstyle.py\n+++ b/utils/checkstyle.py\n@@ -15,6 +15,8 @@\n \n import argparse\n import difflib\n+import fnmatch\n+import os.path\n import re\n import shutil\n import subprocess\n@@ -39,12 +41,6 @@ dependencies = {\n 'git': True,\n }\n \n-source_extensions = (\n- '.c',\n- '.cpp',\n- '.h'\n-)\n-\n # ------------------------------------------------------------------------------\n # Colour terminal handling\n #\n@@ -195,44 +191,61 @@ def parse_diff(diff):\n \n \n # ------------------------------------------------------------------------------\n-# Code reformatting\n+# Style Checkers\n #\n \n-def formatter_astyle(filename, data):\n- ret = subprocess.run(['astyle', *astyle_options],\n- input=data.encode('utf-8'), stdout=subprocess.PIPE)\n- return ret.stdout.decode('utf-8')\n+_style_checkers = []\n \n+class StyleCheckerRegistry(type):\n+ def __new__(cls, clsname, bases, attrs):\n+ newclass = super(StyleCheckerRegistry, cls).__new__(cls, clsname, bases, attrs)\n+ if clsname != 'StyleChecker':\n+ _style_checkers.append(newclass)\n+ return newclass\n \n-def formatter_clang_format(filename, data):\n- ret = subprocess.run(['clang-format', '-style=file',\n- '-assume-filename=' + filename],\n- input=data.encode('utf-8'), stdout=subprocess.PIPE)\n- return ret.stdout.decode('utf-8')\n \n+class StyleChecker(metaclass=StyleCheckerRegistry):\n+ def __init__(self):\n+ pass\n \n-def formatter_strip_trailing_space(filename, data):\n- lines = data.split('\\n')\n- for i in range(len(lines)):\n- lines[i] = lines[i].rstrip() + '\\n'\n- return ''.join(lines)\n+ #\n+ # Class methods\n+ #\n+ @classmethod\n+ def checkers(cls, filename):\n+ for checker in _style_checkers:\n+ if checker.supports(filename):\n+ yield checker\n \n+ @classmethod\n+ def supports(cls, filename):\n+ for pattern in cls.patterns:\n+ if fnmatch.fnmatch(os.path.basename(filename), pattern):\n+ return True\n+ return False\n \n-available_formatters = {\n- 'astyle': formatter_astyle,\n- 'clang-format': formatter_clang_format,\n- 'strip-trailing-spaces': formatter_strip_trailing_space,\n-}\n+ @classmethod\n+ def all_patterns(cls):\n+ patterns = set()\n+ for checker in _style_checkers:\n+ patterns.update(checker.patterns)\n \n+ return patterns\n+\n+\n+class StyleIssue(object):\n+ def __init__(self, line_number, line, msg):\n+ self.line_number = line_number\n+ self.line = line\n+ self.msg = msg\n \n-# ------------------------------------------------------------------------------\n-# Style checking\n-#\n \n-class LogCategoryChecker(object):\n+class LogCategoryChecker(StyleChecker):\n log_regex = re.compile('\\\\bLOG\\((Debug|Info|Warning|Error|Fatal)\\)')\n+ patterns = ('*.cpp',)\n \n def __init__(self, content):\n+ super().__init__()\n self.__content = content\n \n def check(self, line_numbers):\n@@ -242,17 +255,101 @@ class LogCategoryChecker(object):\n if not LogCategoryChecker.log_regex.search(line):\n continue\n \n- issues.append([line_number, line, 'LOG() should use categories'])\n+ issues.append(StyleIssue(line_number, line, 'LOG() should use categories'))\n \n return issues\n \n \n-available_checkers = {\n- 'log_category': LogCategoryChecker,\n-}\n+# ------------------------------------------------------------------------------\n+# Formatters\n+#\n \n+_formatters = []\n \n-def check_file(top_level, commit, filename, formatters):\n+class FormatterRegistry(type):\n+ def __new__(cls, clsname, bases, attrs):\n+ newclass = super(FormatterRegistry, cls).__new__(cls, clsname, bases, attrs)\n+ if clsname != 'Formatter':\n+ _formatters.append(newclass)\n+ return newclass\n+\n+\n+class Formatter(metaclass=FormatterRegistry):\n+ enabled = True\n+\n+ def __init__(self):\n+ pass\n+\n+ #\n+ # Class methods\n+ #\n+ @classmethod\n+ def formatters(cls, filename):\n+ for formatter in _formatters:\n+ if not cls.enabled:\n+ continue\n+ if formatter.supports(filename):\n+ yield formatter\n+\n+ @classmethod\n+ def supports(cls, filename):\n+ if not cls.enabled:\n+ return False\n+ for pattern in cls.patterns:\n+ if fnmatch.fnmatch(os.path.basename(filename), pattern):\n+ return True\n+ return False\n+\n+ @classmethod\n+ def all_patterns(cls):\n+ patterns = set()\n+ for formatter in _formatters:\n+ if not cls.enabled:\n+ continue\n+ patterns.update(formatter.patterns)\n+\n+ return patterns\n+\n+\n+class AStyleFormatter(Formatter):\n+ enabled = False\n+ patterns = ('*.c', '*.cpp', '*.h')\n+\n+ @classmethod\n+ def format(cls, filename, data):\n+ ret = subprocess.run(['astyle', *astyle_options],\n+ input=data.encode('utf-8'), stdout=subprocess.PIPE)\n+ return ret.stdout.decode('utf-8')\n+\n+\n+class CLangFormatter(Formatter):\n+ enabled = False\n+ patterns = ('*.c', '*.cpp', '*.h')\n+\n+ @classmethod\n+ def format(cls, filename, data):\n+ ret = subprocess.run(['clang-format', '-style=file',\n+ '-assume-filename=' + filename],\n+ input=data.encode('utf-8'), stdout=subprocess.PIPE)\n+ return ret.stdout.decode('utf-8')\n+\n+\n+class StripTrailingSpaceFormatter(Formatter):\n+ patterns = ('*.c', '*.cpp', '*.h', '*.py', 'meson.build')\n+\n+ @classmethod\n+ def format(cls, filename, data):\n+ lines = data.split('\\n')\n+ for i in range(len(lines)):\n+ lines[i] = lines[i].rstrip() + '\\n'\n+ return ''.join(lines)\n+\n+\n+# ------------------------------------------------------------------------------\n+# Style checking\n+#\n+\n+def check_file(top_level, commit, filename):\n # Extract the line numbers touched by the commit.\n diff = subprocess.run(['git', 'diff', '%s~..%s' % (commit, commit), '--',\n '%s/%s' % (top_level, filename)],\n@@ -275,9 +372,8 @@ def check_file(top_level, commit, filename, formatters):\n after = after.decode('utf-8')\n \n formatted = after\n- for formatter in formatters:\n- formatter = available_formatters[formatter]\n- formatted = formatter(filename, formatted)\n+ for formatter in Formatter.formatters(filename):\n+ formatted = formatter.format(filename, formatted)\n \n after = after.splitlines(True)\n formatted = formatted.splitlines(True)\n@@ -290,8 +386,8 @@ def check_file(top_level, commit, filename, formatters):\n \n # Check for code issues not related to formatting.\n issues = []\n- for checker in available_checkers:\n- checker = available_checkers[checker](after)\n+ for checker in StyleChecker.checkers(filename):\n+ checker = checker(after)\n for hunk in commit_diff:\n issues += checker.check(hunk.side('to').touched)\n \n@@ -307,15 +403,15 @@ def check_file(top_level, commit, filename, formatters):\n print(hunk)\n \n if len(issues):\n- issues.sort()\n+ issues = sorted(issues, key=lambda i: i.line_number)\n for issue in issues:\n- print('%s#%u: %s' % (Colours.fg(Colours.Yellow), issue[0], issue[2]))\n- print('+%s%s' % (issue[1].rstrip(), Colours.reset()))\n+ print('%s#%u: %s' % (Colours.fg(Colours.Yellow), issue.line_number, issue.msg))\n+ print('+%s%s' % (issue.line.rstrip(), Colours.reset()))\n \n return len(formatted_diff) + len(issues)\n \n \n-def check_style(top_level, commit, formatters):\n+def check_style(top_level, commit):\n # Get the commit title and list of files.\n ret = subprocess.run(['git', 'show', '--pretty=oneline','--name-only', commit],\n stdout=subprocess.PIPE)\n@@ -328,15 +424,18 @@ def check_style(top_level, commit, formatters):\n print(title)\n print(separator)\n \n- # Filter out non C/C++ files.\n- files = [f for f in files if f.endswith(source_extensions)]\n+ # Filter out files we have no checker for.\n+ patterns = set()\n+ patterns.update(StyleChecker.all_patterns())\n+ patterns.update(Formatter.all_patterns())\n+ files = [f for f in files if len([p for p in patterns if fnmatch.fnmatch(os.path.basename(f), p)])]\n if len(files) == 0:\n print(\"Commit doesn't touch source files, skipping\")\n return\n \n issues = 0\n for f in files:\n- issues += check_file(top_level, commit, f, formatters)\n+ issues += check_file(top_level, commit, f)\n \n if issues == 0:\n print(\"No style issue detected\")\n@@ -407,16 +506,13 @@ def main(argv):\n formatter = args.formatter\n else:\n if dependencies['clang-format']:\n- formatter = 'clang-format'\n+ CLangFormatter.enabled = True\n elif dependencies['astyle']:\n- formatter = 'astyle'\n+ AStyleFormatter.enabled = True\n else:\n print(\"No formatter found, please install clang-format or astyle\")\n return 1\n \n- # Create the list of formatters to be applied.\n- formatters = [formatter, 'strip-trailing-spaces']\n-\n # Get the top level directory to pass absolute file names to git diff\n # commands, in order to support execution from subdirectories of the git\n # tree.\n@@ -427,7 +523,7 @@ def main(argv):\n revlist = extract_revlist(args.revision_range)\n \n for commit in revlist:\n- check_style(top_level, commit, formatters)\n+ check_style(top_level, commit)\n print('')\n \n return 0\n", "prefixes": [ "libcamera-devel", "1/2" ] }