[{"id":2167,"web_url":"https://patchwork.libcamera.org/comment/2167/","msgid":"<20190704202407.GB5024@pendragon.ideasonboard.com>","date":"2019-07-04T20:24:07","subject":"Re: [libcamera-devel] [PATCH v2] utils: checkstyle.py: Add pep8\n\tchecker","submitter":{"id":2,"url":"https://patchwork.libcamera.org/api/people/2/","name":"Laurent Pinchart","email":"laurent.pinchart@ideasonboard.com"},"content":"Hi Kieran,\n\nThank you for the patch.\n\nOn Thu, Jul 04, 2019 at 04:06:58PM +0100, Kieran Bingham wrote:\n> Process python additions with pep8 and report any errors that are added.\n> \n> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n> \n> --\n\nThis should be --- to be stripped by git am. Don't forget to remove it\nbefore pushing in any case :-)\n\n> v2:\n>  - Now catches if pep8 is not available\n>  - line_no_regex renamed to results_regex and contained in Pep8Checker\n>    class\n>  - Single quotes used instead of double quotes\n>  - 'data' moved to local variable instance of class instance\n> ---\n>  utils/checkstyle.py | 33 +++++++++++++++++++++++++++++++++\n>  1 file changed, 33 insertions(+)\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index fab4b116d2ff..c5ecdc12112b 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -276,6 +276,39 @@ class MesonChecker(StyleChecker):\n>          return issues\n>  \n>  \n> +class Pep8Checker(StyleChecker):\n> +    patterns = ('*.py',)\n> +    results_regex = re.compile('stdin:([0-9]+):([0-9]+)(.*)')\n> +\n> +    def __init__(self, content):\n> +        super().__init__()\n> +        self.__content = content\n> +\n> +    def check(self, line_numbers):\n> +        issues = []\n> +        data = ''.join(self.__content).encode('utf-8')\n> +\n> +        try:\n> +            ret = subprocess.run(['pep8', '--ignore=E501', '-'],\n> +                                 input=data, stdout=subprocess.PIPE)\n> +        except FileNotFoundError:\n> +            issues.append(StyleIssue(0, '', \"Please install pep8 to validate python additions\"))\n> +            return issues\n> +\n> +        results = ret.stdout.decode('utf-8').splitlines()\n> +        for item in results:\n> +            search = re.search(Pep8Checker.results_regex, item)\n> +            line_number = int(search.group(1))\n> +            position = int(search.group(2))\n> +            msg = search.group(3)\n> +\n> +            if line_number in line_numbers:\n> +                line = self.__content[line_number - 1]\n> +                issues.append(StyleIssue(line_number, line, msg))\n> +\n> +        return issues\n> +\n> +\n\nThis looks good to me. It however prints an empty line below the\nmessage when pep8 isn't installed. How about squashing the following\nchange in ?\n\ndiff --git a/utils/checkstyle.py b/utils/checkstyle.py\nindex c5ecdc12112b..42a96f6d6102 100755\n--- a/utils/checkstyle.py\n+++ b/utils/checkstyle.py\n@@ -292,7 +292,7 @@ class Pep8Checker(StyleChecker):\n             ret = subprocess.run(['pep8', '--ignore=E501', '-'],\n                                  input=data, stdout=subprocess.PIPE)\n         except FileNotFoundError:\n-            issues.append(StyleIssue(0, '', \"Please install pep8 to validate python additions\"))\n+            issues.append(StyleIssue(0, None, \"Please install pep8 to validate python additions\"))\n             return issues\n\n         results = ret.stdout.decode('utf-8').splitlines()\n@@ -483,7 +483,8 @@ def check_file(top_level, commit, filename):\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.line_number, issue.msg))\n-            print('+%s%s' % (issue.line.rstrip(), Colours.reset()))\n+            if issue.line is not None:\n+                print('+%s%s' % (issue.line.rstrip(), Colours.reset()))\n\n     return len(formatted_diff) + len(issues)\n \n\nWith that,\n\nReviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\n>  # ------------------------------------------------------------------------------\n>  # Formatters\n>  #","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 C0C4C600F9\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu,  4 Jul 2019 22:24:28 +0200 (CEST)","from pendragon.ideasonboard.com\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 2CC8B24B;\n\tThu,  4 Jul 2019 22:24:28 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1562271868;\n\tbh=3jKdYUjLzNTurYwe6yT8MF/lFAxcHPi8EjzjdXOMvdM=;\n\th=Date:From:To:Cc:Subject:References:In-Reply-To:From;\n\tb=JCcVqh+31h6JmG/uH8T3wK9F9G2klYpwZv3crpFHwjTUa0ub0VLot5GpP2IWkJtA3\n\txmLDnWxGBTNYKhyxzyxpVpq3/SCn5MYRPhQx+rQs/zLaiHdDWLv4fsgmGsxDWTVh2L\n\tpOEwN5PciJhslMP9AH5pN7ws9v/cmpaMW1fXrKG4=","Date":"Thu, 4 Jul 2019 23:24:07 +0300","From":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","To":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Cc":"LibCamera Devel <libcamera-devel@lists.libcamera.org>","Message-ID":"<20190704202407.GB5024@pendragon.ideasonboard.com>","References":"<20190704150658.18809-1-kieran.bingham@ideasonboard.com>","MIME-Version":"1.0","Content-Type":"text/plain; charset=utf-8","Content-Disposition":"inline","In-Reply-To":"<20190704150658.18809-1-kieran.bingham@ideasonboard.com>","User-Agent":"Mutt/1.10.1 (2018-07-13)","Subject":"Re: [libcamera-devel] [PATCH v2] utils: checkstyle.py: Add pep8\n\tchecker","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":"Thu, 04 Jul 2019 20:24:28 -0000"}},{"id":2171,"web_url":"https://patchwork.libcamera.org/comment/2171/","msgid":"<38cf48ae-b6ef-b0a8-84cf-2c32f074ea54@ideasonboard.com>","date":"2019-07-04T20:52:46","subject":"Re: [libcamera-devel] [PATCH v2] utils: checkstyle.py: Add pep8\n\tchecker","submitter":{"id":4,"url":"https://patchwork.libcamera.org/api/people/4/","name":"Kieran Bingham","email":"kieran.bingham@ideasonboard.com"},"content":"Hi Laurent,\n\nOn 04/07/2019 21:24, Laurent Pinchart wrote:\n> Hi Kieran,\n> \n> Thank you for the patch.\n> \n> On Thu, Jul 04, 2019 at 04:06:58PM +0100, Kieran Bingham wrote:\n>> Process python additions with pep8 and report any errors that are added.\n>>\n>> Signed-off-by: Kieran Bingham <kieran.bingham@ideasonboard.com>\n>>\n>> --\n> \n> This should be --- to be stripped by git am. Don't forget to remove it\n> before pushing in any case :-)\n> \n>> v2:\n>>  - Now catches if pep8 is not available\n>>  - line_no_regex renamed to results_regex and contained in Pep8Checker\n>>    class\n>>  - Single quotes used instead of double quotes\n>>  - 'data' moved to local variable instance of class instance\n>> ---\n>>  utils/checkstyle.py | 33 +++++++++++++++++++++++++++++++++\n>>  1 file changed, 33 insertions(+)\n>>\n>> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n>> index fab4b116d2ff..c5ecdc12112b 100755\n>> --- a/utils/checkstyle.py\n>> +++ b/utils/checkstyle.py\n>> @@ -276,6 +276,39 @@ class MesonChecker(StyleChecker):\n>>          return issues\n>>  \n>>  \n>> +class Pep8Checker(StyleChecker):\n>> +    patterns = ('*.py',)\n>> +    results_regex = re.compile('stdin:([0-9]+):([0-9]+)(.*)')\n>> +\n>> +    def __init__(self, content):\n>> +        super().__init__()\n>> +        self.__content = content\n>> +\n>> +    def check(self, line_numbers):\n>> +        issues = []\n>> +        data = ''.join(self.__content).encode('utf-8')\n>> +\n>> +        try:\n>> +            ret = subprocess.run(['pep8', '--ignore=E501', '-'],\n>> +                                 input=data, stdout=subprocess.PIPE)\n>> +        except FileNotFoundError:\n>> +            issues.append(StyleIssue(0, '', \"Please install pep8 to validate python additions\"))\n>> +            return issues\n>> +\n>> +        results = ret.stdout.decode('utf-8').splitlines()\n>> +        for item in results:\n>> +            search = re.search(Pep8Checker.results_regex, item)\n>> +            line_number = int(search.group(1))\n>> +            position = int(search.group(2))\n>> +            msg = search.group(3)\n>> +\n>> +            if line_number in line_numbers:\n>> +                line = self.__content[line_number - 1]\n>> +                issues.append(StyleIssue(line_number, line, msg))\n>> +\n>> +        return issues\n>> +\n>> +\n> \n> This looks good to me. It however prints an empty line below the\n> message when pep8 isn't installed. How about squashing the following\n> change in ?\n> \n> diff --git a/utils/checkstyle.py b/utils/checkstyle.py\n> index c5ecdc12112b..42a96f6d6102 100755\n> --- a/utils/checkstyle.py\n> +++ b/utils/checkstyle.py\n> @@ -292,7 +292,7 @@ class Pep8Checker(StyleChecker):\n>              ret = subprocess.run(['pep8', '--ignore=E501', '-'],\n>                                   input=data, stdout=subprocess.PIPE)\n>          except FileNotFoundError:\n> -            issues.append(StyleIssue(0, '', \"Please install pep8 to validate python additions\"))\n> +            issues.append(StyleIssue(0, None, \"Please install pep8 to validate python additions\"))\n>              return issues\n> \n>          results = ret.stdout.decode('utf-8').splitlines()\n> @@ -483,7 +483,8 @@ def check_file(top_level, commit, filename):\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.line_number, issue.msg))\n> -            print('+%s%s' % (issue.line.rstrip(), Colours.reset()))\n> +            if issue.line is not None:\n> +                print('+%s%s' % (issue.line.rstrip(), Colours.reset()))\n> \n>      return len(formatted_diff) + len(issues)\n>  \n> \n> With that,\n> \n> Reviewed-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>\n\nI've tested your change, and it works fine.\n\nPushed with your changes\n--\nKieran\n\n\n> \n>>  # ------------------------------------------------------------------------------\n>>  # Formatters\n>>  #\n>","headers":{"Return-Path":"<kieran.bingham@ideasonboard.com>","Received":["from perceval.ideasonboard.com (perceval.ideasonboard.com\n\t[213.167.242.64])\n\tby lancelot.ideasonboard.com (Postfix) with ESMTPS id 7711A6156B\n\tfor <libcamera-devel@lists.libcamera.org>;\n\tThu,  4 Jul 2019 22:52:50 +0200 (CEST)","from [192.168.0.20]\n\t(cpc89242-aztw30-2-0-cust488.18-1.cable.virginm.net [86.31.129.233])\n\tby perceval.ideasonboard.com (Postfix) with ESMTPSA id C5D3324B;\n\tThu,  4 Jul 2019 22:52:49 +0200 (CEST)"],"DKIM-Signature":"v=1; a=rsa-sha256; c=relaxed/simple; d=ideasonboard.com;\n\ts=mail; t=1562273569;\n\tbh=FyQ9EjGZb32Xqms/v9dwS7hnmEBoJeD5e3/YCEUgOx0=;\n\th=Reply-To:Subject:To:Cc:References:From:Date:In-Reply-To:From;\n\tb=bR47o0Wo+xyi4TMwWKPwMNiYkYqBks6QoG4FW2ZzWkVAWwyO1fNYu4kx0rmr4RpNJ\n\tMxV8sDp/txha133yi3Wp9hNPbXcdrtEq9HTVXpcnyqPVo1URIulU6N6YnhASnKT+o0\n\tPxdASG5KQwEMqfajvJ0ePCgF7bJ3NUqQYfBuLgWI=","Reply-To":"kieran.bingham@ideasonboard.com","To":"Laurent Pinchart <laurent.pinchart@ideasonboard.com>","Cc":"LibCamera Devel <libcamera-devel@lists.libcamera.org>","References":"<20190704150658.18809-1-kieran.bingham@ideasonboard.com>\n\t<20190704202407.GB5024@pendragon.ideasonboard.com>","From":"Kieran Bingham <kieran.bingham@ideasonboard.com>","Openpgp":"preference=signencrypt","Autocrypt":"addr=kieran.bingham@ideasonboard.com; keydata=\n\tmQINBFYE/WYBEACs1PwjMD9rgCu1hlIiUA1AXR4rv2v+BCLUq//vrX5S5bjzxKAryRf0uHat\n\tV/zwz6hiDrZuHUACDB7X8OaQcwhLaVlq6byfoBr25+hbZG7G3+5EUl9cQ7dQEdvNj6V6y/SC\n\trRanWfelwQThCHckbobWiQJfK9n7rYNcPMq9B8e9F020LFH7Kj6YmO95ewJGgLm+idg1Kb3C\n\tpotzWkXc1xmPzcQ1fvQMOfMwdS+4SNw4rY9f07Xb2K99rjMwZVDgESKIzhsDB5GY465sCsiQ\n\tcSAZRxqE49RTBq2+EQsbrQpIc8XiffAB8qexh5/QPzCmR4kJgCGeHIXBtgRj+nIkCJPZvZtf\n\tKr2EAbc6tgg6DkAEHJb+1okosV09+0+TXywYvtEop/WUOWQ+zo+Y/OBd+8Ptgt1pDRyOBzL8\n\tRXa8ZqRf0Mwg75D+dKntZeJHzPRJyrlfQokngAAs4PaFt6UfS+ypMAF37T6CeDArQC41V3ko\n\tlPn1yMsVD0p+6i3DPvA/GPIksDC4owjnzVX9kM8Zc5Cx+XoAN0w5Eqo4t6qEVbuettxx55gq\n\t8K8FieAjgjMSxngo/HST8TpFeqI5nVeq0/lqtBRQKumuIqDg+Bkr4L1V/PSB6XgQcOdhtd36\n\tOe9X9dXB8YSNt7VjOcO7BTmFn/Z8r92mSAfHXpb07YJWJosQOQARAQABtDBLaWVyYW4gQmlu\n\tZ2hhbSA8a2llcmFuLmJpbmdoYW1AaWRlYXNvbmJvYXJkLmNvbT6JAkAEEwEKACoCGwMFCwkI\n\tBwIGFQgJCgsCBBYCAwECHgECF4ACGQEFAlnDk/gFCQeA/YsACgkQoR5GchCkYf3X5w/9EaZ7\n\tcnUcT6dxjxrcmmMnfFPoQA1iQXr/MXQJBjFWfxRUWYzjvUJb2D/FpA8FY7y+vksoJP7pWDL7\n\tQTbksdwzagUEk7CU45iLWL/CZ/knYhj1I/+5LSLFmvZ/5Gf5xn2ZCsmg7C0MdW/GbJ8IjWA8\n\t/LKJSEYH8tefoiG6+9xSNp1p0Gesu3vhje/GdGX4wDsfAxx1rIYDYVoX4bDM+uBUQh7sQox/\n\tR1bS0AaVJzPNcjeC14MS226mQRUaUPc9250aj44WmDfcg44/kMsoLFEmQo2II9aOlxUDJ+x1\n\txohGbh9mgBoVawMO3RMBihcEjo/8ytW6v7xSF+xP4Oc+HOn7qebAkxhSWcRxQVaQYw3S9iZz\n\t2iA09AXAkbvPKuMSXi4uau5daXStfBnmOfalG0j+9Y6hOFjz5j0XzaoF6Pln0jisDtWltYhP\n\tX9LjFVhhLkTzPZB/xOeWGmsG4gv2V2ExbU3uAmb7t1VSD9+IO3Km4FtnYOKBWlxwEd8qOFpS\n\tjEqMXURKOiJvnw3OXe9MqG19XdeENA1KyhK5rqjpwdvPGfSn2V+SlsdJA0DFsobUScD9qXQw\n\tOvhapHe3XboK2+Rd7L+g/9Ud7ZKLQHAsMBXOVJbufA1AT+IaOt0ugMcFkAR5UbBg5+dZUYJj\n\t1QbPQcGmM3wfvuaWV5+SlJ+WeKIb8ta5Ag0EVgT9ZgEQAM4o5G/kmruIQJ3K9SYzmPishRHV\n\tDcUcvoakyXSX2mIoccmo9BHtD9MxIt+QmxOpYFNFM7YofX4lG0ld8H7FqoNVLd/+a0yru5Cx\n\tadeZBe3qr1eLns10Q90LuMo7/6zJhCW2w+HE7xgmCHejAwuNe3+7yt4QmwlSGUqdxl8cgtS1\n\tPlEK93xXDsgsJj/bw1EfSVdAUqhx8UQ3aVFxNug5OpoX9FdWJLKROUrfNeBE16RLrNrq2ROc\n\tiSFETpVjyC/oZtzRFnwD9Or7EFMi76/xrWzk+/b15RJ9WrpXGMrttHUUcYZEOoiC2lEXMSAF\n\tSSSj4vHbKDJ0vKQdEFtdgB1roqzxdIOg4rlHz5qwOTynueiBpaZI3PHDudZSMR5Fk6QjFooE\n\tXTw3sSl/km/lvUFiv9CYyHOLdygWohvDuMkV/Jpdkfq8XwFSjOle+vT/4VqERnYFDIGBxaRx\n\tkoBLfNDiiuR3lD8tnJ4A1F88K6ojOUs+jndKsOaQpDZV6iNFv8IaNIklTPvPkZsmNDhJMRHH\n\tIu60S7BpzNeQeT4yyY4dX9lC2JL/LOEpw8DGf5BNOP1KgjCvyp1/KcFxDAo89IeqljaRsCdP\n\t7WCIECWYem6pLwaw6IAL7oX+tEqIMPph/G/jwZcdS6Hkyt/esHPuHNwX4guqTbVEuRqbDzDI\n\t2DJO5FbxABEBAAGJAiUEGAEKAA8CGwwFAlnDlGsFCQeA/gIACgkQoR5GchCkYf1yYRAAq+Yo\n\tnbf9DGdK1kTAm2RTFg+w9oOp2Xjqfhds2PAhFFvrHQg1XfQR/UF/SjeUmaOmLSczM0s6XMeO\n\tVcE77UFtJ/+hLo4PRFKm5X1Pcar6g5m4xGqa+Xfzi9tRkwC29KMCoQOag1BhHChgqYaUH3yo\n\tUzaPwT/fY75iVI+yD0ih/e6j8qYvP8pvGwMQfrmN9YB0zB39YzCSdaUaNrWGD3iCBxg6lwSO\n\tLKeRhxxfiXCIYEf3vwOsP3YMx2JkD5doseXmWBGW1U0T/oJF+DVfKB6mv5UfsTzpVhJRgee7\n\t4jkjqFq4qsUGxcvF2xtRkfHFpZDbRgRlVmiWkqDkT4qMA+4q1y/dWwshSKi/uwVZNycuLsz+\n\t+OD8xPNCsMTqeUkAKfbD8xW4LCay3r/dD2ckoxRxtMD9eOAyu5wYzo/ydIPTh1QEj9SYyvp8\n\tO0g6CpxEwyHUQtF5oh15O018z3ZLztFJKR3RD42VKVsrnNDKnoY0f4U0z7eJv2NeF8xHMuiU\n\tRCIzqxX1GVYaNkKTnb/Qja8hnYnkUzY1Lc+OtwiGmXTwYsPZjjAaDX35J/RSKAoy5wGo/YFA\n\tJxB1gWThL4kOTbsqqXj9GLcyOImkW0lJGGR3o/fV91Zh63S5TKnf2YGGGzxki+ADdxVQAm+Q\n\tsbsRB8KNNvVXBOVNwko86rQqF9drZuw=","Organization":"Ideas on Board","Message-ID":"<38cf48ae-b6ef-b0a8-84cf-2c32f074ea54@ideasonboard.com>","Date":"Thu, 4 Jul 2019 21:52:46 +0100","User-Agent":"Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101\n\tThunderbird/60.7.1","MIME-Version":"1.0","In-Reply-To":"<20190704202407.GB5024@pendragon.ideasonboard.com>","Content-Type":"text/plain; charset=utf-8","Content-Language":"en-GB","Content-Transfer-Encoding":"7bit","Subject":"Re: [libcamera-devel] [PATCH v2] utils: checkstyle.py: Add pep8\n\tchecker","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":"Thu, 04 Jul 2019 20:52:50 -0000"}}]