Fixed most of pylint issues.

Author: miroslavpojer

.pylintrc

@@ -322,7 +322,7 @@ max-returns=6
 max-statements=50
 
 # Minimum number of public methods for a class (see R0903).
-min-public-methods=2
+min-public-methods=1
 
 
 [EXCEPTIONS]

main.py

@@ -21,14 +21,10 @@
 """
 
 import logging
-
-# TODO - fix certificate verification
 import warnings
-from urllib3.exceptions import InsecureRequestWarning
-
-warnings.filterwarnings("ignore", category=InsecureRequestWarning)
 
 from github import Github, Auth
+from urllib3.exceptions import InsecureRequestWarning
 
 from release_notes_generator.generator import ReleaseNotesGenerator
 from release_notes_generator.model.custom_chapters import CustomChapters
@@ -37,6 +33,8 @@
 from release_notes_generator.utils.logging_config import setup_logging
 from release_notes_generator.filter import FilterByRelease
 
+warnings.filterwarnings("ignore", category=InsecureRequestWarning)
+
 
 def run() -> None:
     """

release_notes_generator/action_inputs.py

@@ -228,7 +228,9 @@ def get_coderabbit_release_notes_title() -> str:
         """
         Get the CodeRabbit release notes title from the action inputs.
         """
-        return get_action_input(CODERABBIT_RELEASE_NOTES_TITLE, CODERABBIT_RELEASE_NOTE_TITLE_DEFAULT)  # type: ignore[return-value]
+        return get_action_input(
+            CODERABBIT_RELEASE_NOTES_TITLE, CODERABBIT_RELEASE_NOTE_TITLE_DEFAULT
+        )  # type: ignore[return-value]
 
     @staticmethod
     def get_coderabbit_summary_ignore_groups() -> list[str]:

release_notes_generator/builder.py

@@ -29,7 +29,6 @@
 logger = logging.getLogger(__name__)
 
 
-# pylint: disable=too-few-public-methods
 class ReleaseNotesBuilder:
     """
     A class representing the Release Notes Builder.

release_notes_generator/filter.py

@@ -87,12 +87,16 @@ def filter(self, data: MinedData) -> MinedData:
             md.commits = commits_list
 
             logger.debug(
-                f"Input data. Issues: {len(data.issues)}, "
-                f"Pull Requests: {len(data.pull_requests)}, Commits: {len(data.commits)}"
+                "Input data. Issues: %d, Pull Requests: %d, Commits: %d",
+                len(data.issues),
+                len(data.pull_requests),
+                len(data.commits),
             )
             logger.debug(
-                f"Filtered data. Issues: {len(md.issues)}, "
-                f"Pull Requests: {len(md.pull_requests)}, Commits: {len(md.commits)}"
+                "Filtered data. Issues: %d, Pull Requests: %d, Commits: %d",
+                len(md.issues),
+                len(md.pull_requests),
+                len(md.commits),
             )
         else:
             md.issues = deepcopy(data.issues)

release_notes_generator/miner.py

@@ -47,6 +47,9 @@ def __init__(self, github_instance: Github, rate_limiter: GithubRateLimiter):
         self._safe_call = safe_call_decorator(rate_limiter)
 
     def mine_data(self) -> MinedData:
+        """
+        Mines data from GitHub, including repository information, issues, pull requests, commits, and releases.
+        """
         logger.info("Starting data mining from GitHub...")
         data = MinedData()
 

release_notes_generator/model/chapter.py

@@ -33,15 +33,15 @@ def __init__(
         self.rows: dict[int | str, str] = {}
         self.empty_message = empty_message
 
-    def add_row(self, id: int | str, row: str) -> None:
+    def add_row(self, row_id: int | str, row: str) -> None:
         """
         Adds a row to the chapter.
 
         @param id: The number or sha of the row.
         @param row: The row to add.
         @return: None
         """
-        self.rows[id] = row
+        self.rows[row_id] = row
 
     def to_string(self, sort_ascending: bool = True, print_empty_chapters: bool = True) -> str:
         """

release_notes_generator/model/custom_chapters.py

@@ -38,27 +38,27 @@ def populate(self, records: dict[int | str, Record]) -> None:
         @param records: A dictionary of records where the key is an integer and the value is a Record object.
         @return: None
         """
-        for id, record in records.items():  # iterate all records
+        for record_id, record in records.items():  # iterate all records
             # check if the record should be skipped
-            if records[id].skip:
+            if records[record_id].skip:
                 continue
 
             # skip direct commits as they do not have labels
             if isinstance(record, CommitRecord):
                 continue
 
             for ch in self.chapters.values():  # iterate all chapters
-                if id in self.populated_record_numbers_list and ActionInputs.get_duplicity_scope() not in (
+                if record_id in self.populated_record_numbers_list and ActionInputs.get_duplicity_scope() not in (
                     DuplicityScopeEnum.CUSTOM,
                     DuplicityScopeEnum.BOTH,
                 ):
                     continue
 
-                for record_label in records[id].labels:  # iterate all labels of the record (issue, or 1st PR)
-                    if record_label in ch.labels and records[id].pulls_count > 0:
-                        if not records[id].is_present_in_chapters:
-                            ch.add_row(id, records[id].to_chapter_row())
-                            self.populated_record_numbers_list.append(id)
+                for record_label in records[record_id].labels:  # iterate all labels of the record (issue, or 1st PR)
+                    if record_label in ch.labels and records[record_id].pulls_count > 0:
+                        if not records[record_id].is_present_in_chapters:
+                            ch.add_row(record_id, records[record_id].to_chapter_row())
+                            self.populated_record_numbers_list.append(record_id)
 
     def from_yaml_array(self, chapters: list[dict[str, str]]) -> "CustomChapters":
         """

release_notes_generator/model/mined_data.py

@@ -47,4 +47,10 @@ def __init__(self):
         self.since = datetime(1970, 1, 1)  # Default to epoch start
 
     def is_empty(self):
+        """
+        Checks if the mined data is empty, meaning no repository has been set.
+
+        Returns:
+            bool: True if the repository is None, False otherwise.
+        """
         return self.repository is None

release_notes_generator/model/record.py

@@ -21,7 +21,7 @@
 import logging
 import re
 
-from typing import Optional, AnyStr, Any, Dict, List
+from typing import Optional, Any, Dict, List
 
 from github.Issue import Issue
 from github.PullRequest import PullRequest
@@ -158,7 +158,8 @@ def get_rls_notes(self, line_marks: Optional[list[str]] = None) -> str:
             if pull.body and detection_regex.search(pull.body):
                 release_notes += self.__get_rls_notes_default(pull, line_marks, detection_regex)
             elif pull.body and cr_active and cr_detection_regex.search(pull.body):  # type: ignore[union-attr]
-                release_notes += self.__get_rls_notes_code_rabbit(pull, line_marks, cr_detection_regex)  # type: ignore[arg-type]
+                release_notes += self.__get_rls_notes_code_rabbit(pull, line_marks,
+                                                                  cr_detection_regex)  # type: ignore[arg-type]
 
         # Return the concatenated release notes
         return release_notes.rstrip()
@@ -251,7 +252,7 @@ def pulls_count(self) -> int:
     @property
     def pr_contains_issue_mentions(self) -> bool:
         """Checks if the pull request contains issue mentions."""
-        # todo call both and merge solve in issue
+        # TODO call both and merge solve in issue #153
         return len(extract_issue_numbers_from_body(self._pulls[0])) > 0
 
     @property
@@ -346,8 +347,7 @@ def to_chapter_row(self) -> str:
 
         @return: The record as a row string.
         """
-        # TODO - create a version on child classes
-
+        # TODO - create a version on child classes #152
         self.increment_present_in_chapters()
         row_prefix = f"{ActionInputs.get_duplicity_icon()} " if self.present_in_chapters() > 1 else ""
         format_values = {}
@@ -429,11 +429,7 @@ def is_commit_sha_present(self, sha: str) -> bool:
         @param sha: The commit SHA to check for.
         @return: A boolean indicating whether the specified commit SHA is present in the record.
         """
-        for pull in self._pulls:
-            if pull.merge_commit_sha == sha:
-                return True
-
-        return False
+        return any(pull.merge_commit_sha == sha for pull in self._pulls)
 
     @staticmethod
     def is_pull_request_merged(pull: PullRequest) -> bool:
@@ -456,7 +452,7 @@ def __init__(self, pull: PullRequest, skip: bool = False):
         super().__init__(issue=None, skip=skip)
         self.register_pull_request(pull)
         self.__is_release_note_detected = self.contains_release_notes
-        self.___issues: Dict[int, List[Issue]] = {}
+        self.__issues: Dict[int, List[Issue]] = {}
 
 
 class IssueRecord(Record):