Add pylint disable comments to changelog CI check

Author: agraul

.github/workflows/changelogs/changelogs.py

@@ -1,4 +1,5 @@
 #!/usr/bin/env python3
+# pylint: disable=missing-module-docstring
 
 import logging
 import argparse
@@ -39,11 +40,14 @@ def __init__(self, tracker_filename: str = None):
         trackers = {}
         if tracker_filename:
             try:
+                # pylint: disable-next=logging-fstring-interpolation
                 logging.info(f"Parsing tracker file: {tracker_filename}")
                 tree = ET.parse(tracker_filename)
             except FileNotFoundError as e:
+                # pylint: disable-next=raise-missing-from,broad-exception-raised
                 raise Exception(f"{e.strerror}: '{e.filename}'")
             except ET.ParseError as e:
+                # pylint: disable-next=raise-missing-from,broad-exception-raised
                 raise Exception(f"Error parsing '{tracker_filename}': {e.msg}")
 
             for tracker in tree.getroot():
@@ -53,11 +57,13 @@ def __init__(self, tracker_filename: str = None):
                     name = tracker.find("name").text
                     regex = tracker.find("regex").text
                 except AttributeError:
+                    # pylint: disable-next=raise-missing-from,broad-exception-raised
                     raise Exception(
                         f"Error parsing '{tracker_filename}': not a tracker XML file"
                     )
                 trackers[name] = regex
 
+            # pylint: disable-next=logging-fstring-interpolation
             logging.info(f"Found {len(trackers.keys())} tracker definition(s)")
 
         self.trackers = trackers
@@ -145,10 +151,13 @@ def get_message_header(self) -> str:
         if os.getenv("GITHUB_ACTION"):
             msg = "::error" if self.severe else "::warning"
             if self.file:
+                # pylint: disable-next=consider-using-f-string
                 msg += " file={}".format(self.file)
                 if self.line:
+                    # pylint: disable-next=consider-using-f-string
                     msg += ",line={}".format(self.line)
                     if self.end_line:
+                        # pylint: disable-next=consider-using-f-string
                         msg += ",endLine={}".format(self.end_line)
 
             return msg + "::"
@@ -214,6 +223,7 @@ def __init__(
         regex_rules: RegexRules,
     ):
         if pr_number and not os.getenv("GH_TOKEN"):
+            # pylint: disable-next=broad-exception-raised
             raise Exception(
                 "GitHub API key not set. Please set it in 'GH_TOKEN' environment variable."
             )
@@ -239,14 +249,18 @@ def get_bugzilla_api(self) -> bugzilla.Bugzilla:
 
         uri = os.getenv("BUGZILLA_URI", DEFAULT_BUGZILLA_URI)
         try:
+            # pylint: disable-next=logging-fstring-interpolation
             logging.info(f"Initializing Bugzilla API at '{uri}'")
             bzapi = bugzilla.Bugzilla(uri, api_key=api_key)
+        # pylint: disable-next=unused-variable
         except requests.exceptions.ConnectionError as e:
+            # pylint: disable-next=raise-missing-from
             raise ConnectionError(f"Cannot connect to the Bugzilla API at '{uri}'")
 
         try:
             assert bzapi.logged_in, f"Cannot log into the Bugzilla API at '{uri}'"
         except xmlrpc.client.Fault as f:
+            # pylint: disable-next=raise-missing-from,broad-exception-raised
             raise Exception(
                 f"Cannot log in to the Bugzilla API at '{uri}': {f.faultString}"
             )
@@ -277,12 +291,16 @@ def get_modified_files_for_pkg(
                     pkg_files.append(f)
 
         if logging.getLogger().isEnabledFor(logging.DEBUG):
+            # pylint: disable-next=use-implicit-booleaness-not-len
             if len(pkg_files):
+                # pylint: disable-next=logging-not-lazy
                 logging.debug(
                     f"Found {len(pkg_files)} file(s) in package {pkg_name}:\n  "
                     + "\n  ".join(pkg_files)
                 )
+            # pylint: disable-next=use-implicit-booleaness-not-len
             if len(pkg_chlogs):
+                # pylint: disable-next=logging-not-lazy
                 logging.debug(
                     f"Found {len(pkg_chlogs)} changelog(s) in package {pkg_name}:\n  "
                     + "\n  ".join(pkg_chlogs)
@@ -312,8 +330,10 @@ def get_pkg_index(self, files: list[str]) -> dict[str, list[str]]:
 
         try:
             pkg_names = os.listdir(packages_dir)
+            # pylint: disable-next=logging-fstring-interpolation
             logging.debug(f"Found {len(pkg_names)} package(s) in 'rel-eng/packages'")
         except FileNotFoundError:
+            # pylint: disable-next=raise-missing-from,broad-exception-raised
             raise Exception(
                 "Not an Uyuni repository. Consider using '--uyuni-dir' option."
             )
@@ -330,6 +350,7 @@ def get_pkg_index(self, files: list[str]) -> dict[str, list[str]]:
                 .rstrip()
                 .split(maxsplit=1)[1]
             )
+            # pylint: disable-next=logging-fstring-interpolation
             logging.debug(f"Indexing package {pkg_name} in path {pkg_path}")
 
             # Get the list of modified files and changelog files for the package
@@ -375,6 +396,7 @@ def get_pr_trackers(
         assert pr_number
         assert git_repo
 
+        # pylint: disable-next=logging-fstring-interpolation
         logging.info(f"Requesting information for PR#{pr_number} at '{git_repo}'")
 
         pr_path = f"repos/{git_repo}/pulls/{pr_number}"
@@ -383,10 +405,12 @@ def get_pr_trackers(
         )
         title_and_commits = stream.read()
         if stream.close():
+            # pylint: disable-next=broad-exception-raised
             raise Exception(
                 "An error occurred when getting the PR information from the GitHub API."
             )
 
+        # pylint: disable-next=logging-fstring-interpolation
         logging.debug(
             f"Retrieved title and commit messages for PR#{pr_number}:\n{title_and_commits}"
         )
@@ -409,6 +433,7 @@ def validate_chlog_entry(
         # Test spacing (ignored in version strings)
         # Test to check if a match overlaps with a version string
         overlaps = (
+            # pylint: disable-next=unnecessary-lambda-assignment
             lambda ver_str, match: ver_str.start() <= match.start()
             and ver_str.end() >= match.end()
         )
@@ -455,12 +480,14 @@ def get_entry_obj(self, buffer: list[str], file: str, line_no: int) -> Entry:
     def validate_chlog_file(self, file: str) -> tuple[list[Issue], list[Entry]]:
         """Validate a single changelog file"""
 
+        # pylint: disable-next=logging-fstring-interpolation
         logging.debug(f"Validating changelog file: {file}")
         file_path = os.path.join(self.uyuni_root, file)
 
         if os.path.getsize(file_path) == 0:
             return ([Issue(IssueType.EMPTY_CHLOG, file)], [])
 
+        # pylint: disable-next=unspecified-encoding
         f = open(file_path, "r")
         issues = []
         entries = []
@@ -520,6 +547,7 @@ def validate_chlog_file(self, file: str) -> tuple[list[Issue], list[Entry]]:
         # EOF
         if entry_buf:
             # Validate and append the last entry
+            # pylint: disable-next=undefined-loop-variable
             entry = self.get_entry_obj(entry_buf, file, line_no + 1)
             issues.extend(self.validate_chlog_entry(entry, entries))
             entries.append(entry)
@@ -532,9 +560,11 @@ def validate_bsc(self, entry: Entry) -> list[Issue]:
         issues = []
         # 'bnc' is the name of the tracker as defined in the trackers file
         if "bnc" in entry.trackers:
+            # pylint: disable-next=unused-variable
             for tracker, bug_id in entry.trackers["bnc"]:
                 try:
                     bug = self.bzapi.getbug(bug_id)
+                    # pylint: disable-next=logging-fstring-interpolation
                     logging.debug(f"Bug #{bug_id} belongs to product '{bug.product}'")
 
                     if not bug.product.startswith("SUSE Manager"):
@@ -629,6 +659,7 @@ def validate_trackers(self, entries: list[Entry]) -> list[Issue]:
                 # changelog entry are also mentioned in the PR
                 if pr_validation:
                     for t in trackers:
+                        # pylint: disable-next=possibly-used-before-assignment
                         if kind not in pr_trackers or t not in pr_trackers[kind]:
                             # Tracker not mentioned in the PR
                             issues.append(
@@ -763,14 +794,18 @@ def main():
 
     try:
         logging.debug("Initializing the validator")
+        # pylint: disable-next=invalid-name
         regexRules = RegexRules(args.tracker_file)
         validator = ChangelogValidator(
             args.uyuni_dir, args.git_repo, args.pr_number, args.line_length, regexRules
         )
 
+        # pylint: disable-next=logging-fstring-interpolation
         logging.debug(f"Validating {len(args.files)} file(s)")
         issues = validator.validate(args.files)
+        # pylint: disable-next=logging-fstring-interpolation
         logging.debug(f"Validation finished with {len(issues)} issue(s)")
+    # pylint: disable-next=broad-exception-caught
     except Exception as e:
         print(e, file=sys.stderr)
         return 2
@@ -782,6 +817,7 @@ def main():
         return 0
 
     logging.info(
+        # pylint: disable-next=logging-format-interpolation,consider-using-f-string
         "Changelog test {} with {} issue(s):".format(
             "failed" if is_fail else "passed", len(issues)
         )
@@ -794,6 +830,7 @@ def main():
     if is_fail:
         print()
         print(
+            # pylint: disable-next=consider-using-f-string
             "{}See https://github.com/uyuni-project/uyuni/wiki/Contributing for a guide to writing changelogs.".format(
                 "::notice::" if is_gh_action else ""
             )