Patch Detail
Show a patch.
GET /api/1.1/patches/21697/?format=api
{ "id": 21697, "url": "https://patchwork.libcamera.org/api/1.1/patches/21697/?format=api", "web_url": "https://patchwork.libcamera.org/patch/21697/", "project": { "id": 1, "url": "https://patchwork.libcamera.org/api/1.1/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": "<20241018193246.805-2-laurent.pinchart@ideasonboard.com>", "date": "2024-10-18T19:32:43", "name": "[1/4] utils: checkstyle.py: Factor out common code to new CheckerBase class", "commit_ref": "5f7bcd93fdc8676921b228ee1029550c1207fb14", "pull_url": null, "state": "accepted", "archived": false, "hash": "c6af59d65419652abfce8b3c061ccec537345ff4", "submitter": { "id": 2, "url": "https://patchwork.libcamera.org/api/1.1/people/2/?format=api", "name": "Laurent Pinchart", "email": "laurent.pinchart@ideasonboard.com" }, "delegate": null, "mbox": "https://patchwork.libcamera.org/patch/21697/mbox/", "series": [ { "id": 4723, "url": "https://patchwork.libcamera.org/api/1.1/series/4723/?format=api", "web_url": "https://patchwork.libcamera.org/project/libcamera/list/?series=4723", "date": "2024-10-18T19:32:42", "name": "utils: checkstyle.py: Improve dependency handling", "version": 1, "mbox": "https://patchwork.libcamera.org/series/4723/mbox/" } ], "comments": "https://patchwork.libcamera.org/api/patches/21697/comments/", "check": "pending", "checks": "https://patchwork.libcamera.org/api/patches/21697/checks/", "tags": {}, "headers": { "Return-Path": "<libcamera-devel-bounces@lists.libcamera.org>", "X-Original-To": "parsemail@patchwork.libcamera.org", "Delivered-To": "parsemail@patchwork.libcamera.org", "Received": [ "from lancelot.ideasonboard.com (lancelot.ideasonboard.com\n\t[92.243.16.209])\n\tby patchwork.libcamera.org (Postfix) with ESMTPS id 3E856C32AF\n\tfor <parsemail@patchwork.libcamera.org>;\n\tFri, 18 Oct 2024 19:32:59 +0000 (UTC)", "from lancelot.ideasonboard.com (localhost [IPv6:::1])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTP id BFF3465391;\n\tFri, 18 Oct 2024 21:32:56 +0200 (CEST)", "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 9208C633C7\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tFri, 18 Oct 2024 21:32:53 +0200 (CEST)", "from pendragon.ideasonboard.com (81-175-209-231.bb.dnainternet.fi\n\t[81.175.209.231])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id 94B5B21C;\n\tFri, 18 Oct 2024 21:31:09 +0200 (CEST)" ], "Authentication-Results": "lancelot.ideasonboard.com; dkim=pass (1024-bit key;\n\tunprotected) header.d=ideasonboard.com header.i=@ideasonboard.com\n\theader.b=\"amTEmReL\"; dkim-atps=neutral", "DKIM-Signature": "v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1729279869;\n\tbh=KgNxz85NUESoziGNOveIgBNP5odlnilj6YbBkXm3D0Y=;\n\th=From:To:Cc:Subject:Date:In-Reply-To:References:From;\n\tb=amTEmReLkpYuOke3kgPCz4PI72SUVcfGoxV1hj5GjRS02xyKmMpZdOgQMqMWh8D5R\n\txZm8P0rrJRF/74QuTXADp71FgfVWWrP4nYH4uwJmxxmh2Vl1xlb990qdRTDD6Owe1L\n\t3+r+ud6s2q50ETjzURSEs28pMEd5Moh7sazz3Uzg=", "From": "Laurent Pinchart <laurent.pinchart@ideasonboard.com>", "To": "libcamera-devel@lists.libcamera.org", "Cc": "Stefan Klug <stefan.klug@ideasonboard.com>", "Subject": "[PATCH 1/4] utils: checkstyle.py: Factor out common code to new\n\tCheckerBase class", "Date": "Fri, 18 Oct 2024 22:32:43 +0300", "Message-ID": "<20241018193246.805-2-laurent.pinchart@ideasonboard.com>", "X-Mailer": "git-send-email 2.45.2", "In-Reply-To": "<20241018193246.805-1-laurent.pinchart@ideasonboard.com>", "References": "<20241018193246.805-1-laurent.pinchart@ideasonboard.com>", "MIME-Version": "1.0", "Content-Transfer-Encoding": "8bit", "X-BeenThere": "libcamera-devel@lists.libcamera.org", "X-Mailman-Version": "2.1.29", "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>", "Errors-To": "libcamera-devel-bounces@lists.libcamera.org", "Sender": "\"libcamera-devel\" <libcamera-devel-bounces@lists.libcamera.org>" }, "content": "The CommitChecker, StyleChecker and Formatter classes duplicate code.\nCreate a new CheckerBase class to factor out common code.\n\nSigned-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n---\n utils/checkstyle.py | 140 ++++++++++++++++----------------------------\n 1 file changed, 51 insertions(+), 89 deletions(-)", "diff": "diff --git a/utils/checkstyle.py b/utils/checkstyle.py\nindex ab89c0a14fab..1de518953dcd 100755\n--- a/utils/checkstyle.py\n+++ b/utils/checkstyle.py\n@@ -334,37 +334,57 @@ class Amendment(Commit):\n class ClassRegistry(type):\n def __new__(cls, clsname, bases, attrs):\n newclass = super().__new__(cls, clsname, bases, attrs)\n- if bases:\n- bases[0].subclasses.append(newclass)\n- bases[0].subclasses.sort(key=lambda x: getattr(x, 'priority', 0),\n- reverse=True)\n+ if bases and bases[0] != CheckerBase:\n+ base = bases[0]\n+\n+ if not hasattr(base, 'subclasses'):\n+ base.subclasses = []\n+ base.subclasses.append(newclass)\n+ base.subclasses.sort(key=lambda x: getattr(x, 'priority', 0),\n+ reverse=True)\n return newclass\n \n \n+class CheckerBase(metaclass=ClassRegistry):\n+ #\n+ # Class methods\n+ #\n+ @classmethod\n+ def instances(cls, obj, names):\n+ for instance in cls.subclasses:\n+ if names and instance.__name__ not in names:\n+ continue\n+ if instance.supports(obj):\n+ yield instance\n+\n+ @classmethod\n+ def supports(cls, obj):\n+ if hasattr(cls, 'commit_types'):\n+ return type(obj) in cls.commit_types\n+\n+ if hasattr(cls, 'patterns'):\n+ for pattern in cls.patterns:\n+ if fnmatch.fnmatch(os.path.basename(obj), pattern):\n+ return True\n+\n+ return False\n+\n+ @classmethod\n+ def all_patterns(cls):\n+ patterns = set()\n+ for instance in cls.subclasses:\n+ if hasattr(instance, 'patterns'):\n+ patterns.update(instance.patterns)\n+\n+ return patterns\n+\n+\n # ------------------------------------------------------------------------------\n # Commit Checkers\n #\n \n-class CommitChecker(metaclass=ClassRegistry):\n- subclasses = []\n-\n- def __init__(self):\n- pass\n-\n- #\n- # Class methods\n- #\n- @classmethod\n- def checkers(cls, commit, names):\n- for checker in cls.subclasses:\n- if names and checker.__name__ not in names:\n- continue\n- if checker.supports(commit):\n- yield checker\n-\n- @classmethod\n- def supports(cls, commit):\n- return type(commit) in cls.commit_types\n+class CommitChecker(CheckerBase):\n+ pass\n \n \n class CommitIssue(object):\n@@ -561,37 +581,8 @@ class TrailersChecker(CommitChecker):\n # Style Checkers\n #\n \n-class StyleChecker(metaclass=ClassRegistry):\n- subclasses = []\n-\n- def __init__(self):\n- pass\n-\n- #\n- # Class methods\n- #\n- @classmethod\n- def checkers(cls, filename, names):\n- for checker in cls.subclasses:\n- if names and checker.__name__ not in names:\n- continue\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- @classmethod\n- def all_patterns(cls):\n- patterns = set()\n- for checker in cls.subclasses:\n- patterns.update(checker.patterns)\n-\n- return patterns\n+class StyleChecker(CheckerBase):\n+ pass\n \n \n class StyleIssue(object):\n@@ -748,37 +739,8 @@ class ShellChecker(StyleChecker):\n # Formatters\n #\n \n-class Formatter(metaclass=ClassRegistry):\n- subclasses = []\n-\n- def __init__(self):\n- pass\n-\n- #\n- # Class methods\n- #\n- @classmethod\n- def formatters(cls, filename, names):\n- for formatter in cls.subclasses:\n- if names and formatter.__name__ not in names:\n- continue\n- if formatter.supports(filename):\n- yield formatter\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- @classmethod\n- def all_patterns(cls):\n- patterns = set()\n- for formatter in cls.subclasses:\n- patterns.update(formatter.patterns)\n-\n- return patterns\n+class Formatter(CheckerBase):\n+ pass\n \n \n class CLangFormatter(Formatter):\n@@ -957,7 +919,7 @@ def check_file(top_level, commit, filename, checkers):\n after = commit.get_file(filename)\n \n formatted = after\n- for formatter in Formatter.formatters(filename, checkers):\n+ for formatter in Formatter.instances(filename, checkers):\n formatted = formatter.format(filename, formatted)\n \n after = after.splitlines(True)\n@@ -971,7 +933,7 @@ def check_file(top_level, commit, filename, checkers):\n \n # Check for code issues not related to formatting.\n issues = []\n- for checker in StyleChecker.checkers(filename, checkers):\n+ for checker in StyleChecker.instances(filename, checkers):\n checker = checker(after)\n for hunk in commit_diff:\n issues += checker.check(hunk.side('to').touched)\n@@ -1019,7 +981,7 @@ def check_style(top_level, commit, checkers):\n issues = 0\n \n # Apply the commit checkers first.\n- for checker in CommitChecker.checkers(commit, checkers):\n+ for checker in CommitChecker.instances(commit, checkers):\n for issue in checker.check(commit, top_level):\n print('%s%s%s' % (Colours.fg(Colours.Yellow), issue.msg, Colours.reset()))\n issues += 1\n", "prefixes": [ "1/4" ] }