Merge pull request #38 from per1234/lint-report-size-deltas

Lint the Python code of libraries/report-size-deltas during CI run

Author: aentinger

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+doctests = True
+# W503 and W504 are mutually exclusive. PEP 8 recommends line break before.
+ignore = W503
+max-complexity = 10
+max-line-length = 120
+select = E,W,F,C,N

.github/workflows/libraries_report-size-deltas.yml

@@ -15,6 +15,12 @@ jobs:
         with:
           python-version: '3.8.2'
 
+      - name: Lint with flake8
+        run: |
+          pip install --quiet flake8
+          pip install --quiet pep8-naming
+          flake8 --show-source "$GITHUB_WORKSPACE/libraries/report-size-deltas"
+
       - name: Run Python unit tests
         run: |
           export PYTHONPATH="$GITHUB_WORKSPACE/libraries/report-size-deltas"

reportsizedeltas.py

@@ -121,8 +121,8 @@ def report_exists(self, pr_number, pr_head_sha):
         page_number = 1
         page_count = 1
         while page_number <= page_count:
-            api_data = self.api_request(request="repos/" + self.repository_name + "/issues/" + str(pr_number) +
-                                                "/comments",
+            api_data = self.api_request(request="repos/" + self.repository_name + "/issues/" + str(pr_number)
+                                                + "/comments",
                                         page_number=page_number)
 
             comments_data = api_data["json_data"]
@@ -150,8 +150,8 @@ def get_artifact_download_url_for_sha(self, pr_user_login, pr_head_ref, pr_head_
         page_count = 1
         while page_number <= page_count:
             api_data = self.api_request(request="repos/" + self.repository_name + "/actions/runs",
-                                        request_parameters="actor=" + pr_user_login + "&branch=" + pr_head_ref +
-                                                           "&event=pull_request&status=completed",
+                                        request_parameters="actor=" + pr_user_login + "&branch=" + pr_head_ref
+                                                           + "&event=pull_request&status=completed",
                                         page_number=page_number)
             runs_data = api_data["json_data"]
 
@@ -179,8 +179,8 @@ def get_artifact_download_url_for_run(self, run_id):
         page_number = 1
         page_count = 1
         while page_number <= page_count:
-            api_data = self.api_request(request="repos/" + self.repository_name + "/actions/runs/" +
-                                                str(run_id) + "/artifacts",
+            api_data = self.api_request(request="repos/" + self.repository_name + "/actions/runs/"
+                                                + str(run_id) + "/artifacts",
                                         page_number=page_number)
             artifacts_data = api_data["json_data"]
 
@@ -230,19 +230,19 @@ def generate_report(self, artifact_folder_object, pr_head_sha, pr_number):
         artifact_folder_object -- object containing the data about the temporary folder that stores the markdown files
         """
         with artifact_folder_object as artifact_folder:
-            report_markdown = (self.report_key_beginning + pr_head_sha + "]" +
-                               "(https://github.com/" + self.repository_name + "/pull/" + str(pr_number) +
-                               "/commits/" + pr_head_sha + ")**\n\n")
+            report_markdown = (self.report_key_beginning + pr_head_sha + "]"
+                               + "(https://github.com/" + self.repository_name + "/pull/" + str(pr_number)
+                               + "/commits/" + pr_head_sha + ")**\n\n")
             report_markdown = report_markdown + "FQBN | Flash Usage | RAM For Global Variables\n---|---|---"
             reports_data = []
             for report_filename in sorted(os.listdir(path=artifact_folder)):
                 with open(file=artifact_folder + "/" + report_filename) as report_file:
                     report_data = json.load(report_file)
                     reports_data = reports_data + [report_data]
-                    report_markdown = (report_markdown + "\n" +
-                                       report_data["fqbn"] +
-                                       generate_value_cell(report_data["flash_delta"]) +
-                                       generate_value_cell(report_data["ram_delta"]))
+                    report_markdown = (report_markdown + "\n"
+                                       + report_data["fqbn"]
+                                       + generate_value_cell(report_data["flash_delta"])
+                                       + generate_value_cell(report_data["ram_delta"]))
 
         logger.debug("Report:\n" + report_markdown)
         return {"markdown": report_markdown, "data": reports_data}
@@ -257,11 +257,11 @@ def comment_report(self, pr_number, report_markdown):
         report_data = {"body": report_markdown}
         report_data = json.dumps(obj=report_data)
         report_data = report_data.encode(encoding="utf-8")
-        url = ("https://api.github.com/repos/" +
-               self.repository_name +
-               "/issues/" +
-               str(pr_number) +
-               "/comments")
+        url = ("https://api.github.com/repos/"
+               + self.repository_name
+               + "/issues/"
+               + str(pr_number)
+               + "/comments")
 
         self.http_request(url=url, data=report_data)
 
@@ -278,8 +278,8 @@ def api_request(self, request, request_parameters="", page_number=1):
         page_number -- Some responses will be paginated. This argument specifies which page should be returned.
                        (default value: 1)
         """
-        return self.get_json_response(url="https://api.github.com/" + request + "?" + request_parameters + "&page=" +
-                                          str(page_number) + "&per_page=100")
+        return self.get_json_response(url="https://api.github.com/" + request + "?" + request_parameters + "&page="
+                                          + str(page_number) + "&per_page=100")
 
     def get_json_response(self, url):
         """Load the specified URL and return a dictionary:
@@ -306,21 +306,11 @@ def get_json_response(self, url):
                 page_count = 0
                 additional_pages = False
             else:
-                page_count = 1
-                additional_pages = False
-
-                if response_data["headers"]["Link"] is not None:
-                    # Get the pagination data
-                    if response_data["headers"]["Link"].find(">; rel=\"next\"") != -1:
-                        additional_pages = True
-                    for link in response_data["headers"]["Link"].split(","):
-                        if link[-13:] == ">; rel=\"last\"":
-                            link = re.split("[?&>]", link)
-                            for parameter in link:
-                                if parameter[:5] == "page=":
-                                    page_count = int(parameter.split("=")[1])
-                                    break
-                            break
+                page_count = get_page_count(link_header=response_data["headers"]["Link"])
+                if page_count > 1:
+                    additional_pages = True
+                else:
+                    additional_pages = False
 
             return {"json_data": json_data, "additional_pages": additional_pages, "page_count": page_count}
         except Exception as exception:
@@ -443,6 +433,26 @@ def determine_urlopen_retry(exception):
     return False
 
 
+def get_page_count(link_header):
+    """Return the number of pages of the API response
+
+    Keyword arguments:
+    link_header -- Link header of the HTTP response
+    """
+    page_count = 1
+    if link_header is not None:
+        # Get the pagination data
+        for link in link_header.split(","):
+            if link[-13:] == ">; rel=\"last\"":
+                link = re.split("[?&>]", link)
+                for parameter in link:
+                    if parameter[:5] == "page=":
+                        page_count = int(parameter.split("=")[1])
+                        break
+                break
+    return page_count
+
+
 def generate_value_cell(value):
     """Return the Markdown formatted text for a memory change data cell in the report table