Refactor code for improved readability and consistency by removing unnecessary line breaks and adjusting line length in configuration

Author: coolbeevip

gitlab_bot.py

@@ -17,8 +17,6 @@
 from dotenv import load_dotenv
 from gidgetlab.aiohttp import GitLabBot
 
-load_dotenv()  # isort:skip
-
 from src.config import (
     bot_gitlab_token,
     bot_gitlab_url,
@@ -31,9 +29,9 @@
 from src.merge_request_hook import MergeRequestHooks
 from src.note_hook import NoteHooks
 
-bot = GitLabBot(
-    bot_gitlab_username, url=bot_gitlab_url, access_token=bot_gitlab_token
-)
+load_dotenv()  # isort:skip
+
+bot = GitLabBot(bot_gitlab_username, url=bot_gitlab_url, access_token=bot_gitlab_token)
 
 issue_hooks = IssueHooks()
 merge_request_hooks = MergeRequestHooks()
@@ -67,33 +65,25 @@ async def note_issue_event(event, gl, *args, **kwargs):
 @bot.router.register("Merge Request Hook", action="open")
 async def merge_request_opened_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.merge_request_opened_event(
-            event, gl, args, kwargs
-        )
+        await merge_request_hooks.merge_request_opened_event(event, gl, args, kwargs)
 
 
 @bot.router.register("Merge Request Hook", action="update")
 async def merge_request_updated_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.merge_request_updated_event(
-            event, gl, args, kwargs
-        )
+        await merge_request_hooks.merge_request_updated_event(event, gl, args, kwargs)
 
 
 @bot.router.register("Merge Request Hook", action="reopen")
 async def merge_request_reopen_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.merge_request_reopen_event(
-            event, gl, args, kwargs
-        )
+        await merge_request_hooks.merge_request_reopen_event(event, gl, args, kwargs)
 
 
 @bot.router.register("Note Hook", noteable_type="MergeRequest")
 async def note_merge_request_event(event, gl, *args, **kwargs):
     if not ignore_event(event):
-        await merge_request_hooks.note_merge_request_event(
-            event, gl, args, kwargs
-        )
+        await merge_request_hooks.note_merge_request_event(event, gl, args, kwargs)
 
 
 @bot.router.register("Note Hook", noteable_type="Commit")
@@ -114,9 +104,7 @@ def ignore_event(event) -> bool:
     if username != bot_gitlab_username:
         return False
     else:
-        logging.info(
-            "Ignore event: %s triggered by admin", event.data["event_type"]
-        )
+        logging.info("Ignore event: %s triggered by admin", event.data["event_type"])
         return True
 
 

pyproject.toml

@@ -40,7 +40,7 @@ coverage = "7.2.7"
 pytest-cov = "4.1.0"
 
 [tool.ruff]
-line-length = 79
+line-length = 120
 fix = true
 target-version = "py39"
 

src/config.py

@@ -17,9 +17,7 @@
 from dotenv import load_dotenv
 
 load_dotenv()  # isort:skip
-DEFAULT_BOT_GIT_COMMIT_SUBJECT_REGEX_VALUE = (
-    "^(fix|feat|docs|style|refactor|test|chore|build|ci): .*$"
-)
+DEFAULT_BOT_GIT_COMMIT_SUBJECT_REGEX_VALUE = "^(fix|feat|docs|style|refactor|test|chore|build|ci): .*$"
 DEFAULT_BOT_GIT_COMMIT_SUBJECT_EXAMPLES_MARKDOWN_VALUE = """
 * feat: Add authentication module   
 * fix: Resolve issue with login not working
@@ -94,9 +92,7 @@
     ).lower()
     == "true"
 )
-bot_git_commit_subject_regex = os.getenv(
-    "BOT_GIT_COMMIT_SUBJECT_REGEX", DEFAULT_BOT_GIT_COMMIT_SUBJECT_REGEX_VALUE
-)
+bot_git_commit_subject_regex = os.getenv("BOT_GIT_COMMIT_SUBJECT_REGEX", DEFAULT_BOT_GIT_COMMIT_SUBJECT_REGEX_VALUE)
 bot_git_commit_subject_example_markdown = os.getenv(
     "BOT_GIT_COMMIT_SUBJECT_EXAMPLES_MARKDOWN",
     DEFAULT_BOT_GIT_COMMIT_SUBJECT_EXAMPLES_MARKDOWN_VALUE,
@@ -131,13 +127,9 @@
     == "true"
 )
 # gitlab merge request summary
-bot_gitlab_merge_request_summary_language = os.getenv(
-    "BOT_GITLAB_MERGE_REQUEST_SUMMARY_LANGUAGE", "English"
-)
+bot_gitlab_merge_request_summary_language = os.getenv("BOT_GITLAB_MERGE_REQUEST_SUMMARY_LANGUAGE", "English")
 
-bot_gitlab_merge_request_summary_prompt_rule = os.getenv(
-    "BOT_GITLAB_MERGE_REQUEST_SUMMARY_PROMPT_RULE", None
-)
+bot_gitlab_merge_request_summary_prompt_rule = os.getenv("BOT_GITLAB_MERGE_REQUEST_SUMMARY_PROMPT_RULE", None)
 
 # gitlab merge request email username not match check
 bot_gitlab_merge_request_email_username_not_match_enabled = (

src/i18n.py

@@ -18,7 +18,5 @@
 from src.config import bot_language
 
 localedir = os.path.join(os.path.abspath(os.path.dirname(__file__)), "locales")
-translate = gettext.translation(
-    "gitlab-bot", localedir, fallback=True, languages=[bot_language]
-)
+translate = gettext.translation("gitlab-bot", localedir, fallback=True, languages=[bot_language])
 _ = translate.gettext

src/issue_hook.py

@@ -39,34 +39,22 @@ async def parse_milestone_release_note(event, gl):
         match = re.search(pattern, note)
         if match:
             milestone_name = match.group(1)
-            milestones_query_url = (
-                f"/projects/{project_id}/milestones?title={milestone_name}"
-            )
+            milestones_query_url = f"/projects/{project_id}/milestones?title={milestone_name}"
             milestones = await gl.getitem(milestones_query_url)
             if len(milestones) == 1:
                 milestone_id = milestones[0]["id"]
-                query_merge_requests_by_milestone_url = f"/projects/{project_id}/milestones/{milestone_id}/merge_requests"
-                merge_requests = await gl.getitem(
-                    query_merge_requests_by_milestone_url
+                query_merge_requests_by_milestone_url = (
+                    f"/projects/{project_id}/milestones/{milestone_id}/merge_requests"
                 )
+                merge_requests = await gl.getitem(query_merge_requests_by_milestone_url)
                 notes = []
                 for merge_request in merge_requests:
-                    notes.append(
-                        f"* [{merge_request['title']}]({merge_request['web_url']})\n"
-                    )
-                message = _("milestone_release_note").format(
-                    milestone=milestone_name, notes="".join(notes)
-                )
+                    notes.append(f"* [{merge_request['title']}]({merge_request['web_url']})\n")
+                message = _("milestone_release_note").format(milestone=milestone_name, notes="".join(notes))
             else:
-                message = _("milestone_not_found").format(
-                    milestone=milestone_name
-                )
+                message = _("milestone_not_found").format(milestone=milestone_name)
         else:
-            raise Exception(
-                _("invalid_bot_action").format(
-                    action="/bot-release-note 1.0.0"
-                )
-            )
+            raise Exception(_("invalid_bot_action").format(action="/bot-release-note 1.0.0"))
     except Exception as e:
         message = str(e)
 
@@ -80,9 +68,7 @@ async def automatically_mark_label_outdated_issues(event, gl, days_ago=14):
     # get all issues updated before N days ago
     date_days_ago = datetime.now() - timedelta(days=days_ago)
     updated_before = date_days_ago.strftime("%Y-%m-%d")
-    old_issues = await gl.getitem(
-        f"/projects/{project_id}/issues?state=opened&updated_before={updated_before}"
-    )
+    old_issues = await gl.getitem(f"/projects/{project_id}/issues?state=opened&updated_before={updated_before}")
     outdated_issue_label = "Outdated"
     if len(old_issues) > 0:
         for issue in old_issues:

src/llm.py

@@ -36,12 +36,7 @@
 
 AI = None
 
-if (
-    model_name is not None
-    and openai_api_key is not None
-    and openai_api_base is not None
-    and AI_PROVIDER == "openai"
-):
+if model_name is not None and openai_api_key is not None and openai_api_base is not None and AI_PROVIDER == "openai":
     AI = ChatOpenAI(
         openai_api_base=openai_api_base,
         openai_api_key=openai_api_key,
@@ -51,11 +46,7 @@
         max_retries=2,
     )
 
-if (
-    google_api_key is not None
-    and model_name is not None
-    and AI_PROVIDER == "google"
-):
+if google_api_key is not None and model_name is not None and AI_PROVIDER == "google":
     AI = ChatGoogleGenerativeAI(model=model_name)
 
 if (

src/merge_request_hook.py

@@ -58,9 +58,7 @@ def check_commit_message(commit_msg):
         return
     if len(commit_msg) > bot_git_commit_subject_max_length:
         raise Exception(
-            _("commit_subject_max_length").format(
-                commit_subject_max_length=bot_git_commit_subject_max_length
-            )
+            _("commit_subject_max_length").format(commit_subject_max_length=bot_git_commit_subject_max_length)
         )
     if commit_msg.startswith("Merge branch "):
         return
@@ -96,10 +94,7 @@ def check_email(commit_author_name, commit_author_email):
                     gitlab_email_domain=bot_git_email_domain,
                 )
             )
-        if (
-            bot_gitlab_merge_request_email_username_not_match_enabled
-            and username != commit_author_name
-        ):
+        if bot_gitlab_merge_request_email_username_not_match_enabled and username != commit_author_name:
             raise Exception(
                 _("email_username_not_match").format(
                     commit_author_name=commit_author_name,
@@ -115,9 +110,7 @@ async def generate_diff_description_summary(event, gl):
     iid = event.data["object_attributes"]["iid"]
     change_event = event.data["changes"]
     if not change_event:
-        logging.debug(
-            "MR has no code changes, AI Summary generation skipped..."
-        )
+        logging.debug("MR has no code changes, AI Summary generation skipped...")
         return None
 
     if bot_gitlab_merge_request_summary_enabled and AI is not None:
@@ -126,25 +119,17 @@ async def generate_diff_description_summary(event, gl):
                 logging.debug("AI Summary not found, generating...")
                 try:
                     # Support 15.7+
-                    diff_url = (
-                        f"/projects/{project_id}/merge_requests/{iid}/diffs"
-                    )
+                    diff_url = f"/projects/{project_id}/merge_requests/{iid}/diffs"
                     diffs = await gl.getitem(diff_url)
                 except Exception as e:
-                    logging.warning(
-                        "Calling API /diffs error, trying to call /changes", e
-                    )
-                    diff_url = (
-                        f"/projects/{project_id}/merge_requests/{iid}/changes"
-                    )
+                    logging.warning("Calling API /diffs error, trying to call /changes", e)
+                    diff_url = f"/projects/{project_id}/merge_requests/{iid}/changes"
                     changes = await gl.getitem(diff_url)
                     diffs = changes["changes"]
 
                 response_summary = ai_diffs_summary(diffs)
 
-                merge_request_post_note_url = (
-                    f"/projects/{project_id}/merge_requests/{iid}/notes"
-                )
+                merge_request_post_note_url = f"/projects/{project_id}/merge_requests/{iid}/notes"
                 await gl.post(
                     merge_request_post_note_url,
                     data={"body": response_summary},
@@ -154,10 +139,7 @@ async def generate_diff_description_summary(event, gl):
                 logging.debug("AI Summary found, skipping...")
 
             # Add AI Review status label if not exists
-            if (
-                bot_gitlab_merge_request_aireview_label_enabled
-                and not has_ai_review_label(labels)
-            ):
+            if bot_gitlab_merge_request_aireview_label_enabled and not has_ai_review_label(labels):
                 await update_status_label(
                     gl,
                     project_id,
@@ -171,9 +153,7 @@ async def generate_diff_description_summary(event, gl):
             logging.error(e)
             raise e
     else:
-        logging.debug(
-            "AI Summary generation feature is disabled or AI feature is not available."
-        )
+        logging.debug("AI Summary generation feature is disabled or AI feature is not " "available.")
         # Remove AI Review status label
         await update_status_label(
             gl,
@@ -189,32 +169,22 @@ async def check_commit(event, gl):
     project_id = event.project_id
     if event.data["event_type"] == "note":
         commit_title = event.data["merge_request"]["last_commit"]["title"]
-        commit_author_name = event.data["merge_request"]["last_commit"][
-            "author"
-        ]["name"]
-        commit_author_email = event.data["merge_request"]["last_commit"][
-            "author"
-        ]["email"]
+        commit_author_name = event.data["merge_request"]["last_commit"]["author"]["name"]
+        commit_author_email = event.data["merge_request"]["last_commit"]["author"]["email"]
         iid = event.data["merge_request"]["iid"]
         milestone_id = event.data["merge_request"]["milestone_id"]
         # source_branch = event.data["merge_request"]["source_branch"]
         description = event.data["merge_request"]["description"]
     elif event.data["event_type"] == "merge_request":
         commit_title = event.data["object_attributes"]["last_commit"]["title"]
-        commit_author_name = event.data["object_attributes"]["last_commit"][
-            "author"
-        ]["name"]
-        commit_author_email = event.data["object_attributes"]["last_commit"][
-            "author"
-        ]["email"]
+        commit_author_name = event.data["object_attributes"]["last_commit"]["author"]["name"]
+        commit_author_email = event.data["object_attributes"]["last_commit"]["author"]["email"]
         iid = event.data["object_attributes"]["iid"]
         milestone_id = event.data["object_attributes"]["milestone_id"]
         # source_branch = event.data["object_attributes"]["source_branch"]
         description = event.data["object_attributes"]["description"]
 
-    merge_request_post_note_url = (
-        f"/projects/{project_id}/merge_requests/{iid}/notes"
-    )
+    merge_request_post_note_url = f"/projects/{project_id}/merge_requests/{iid}/notes"
     try:
         check_email(commit_author_name, commit_author_email)
         check_commit_message(commit_title)
@@ -246,9 +216,7 @@ async def check_commit(event, gl):
 
 
 async def approval_merge_request(project_id, iid, gl):
-    query_approvals_url = (
-        f"/projects/{project_id}/merge_requests/{iid}/approvals"
-    )
+    query_approvals_url = f"/projects/{project_id}/merge_requests/{iid}/approvals"
     approvals = gl.getitem(query_approvals_url)
     bot_approved = False
     if approvals.approved:
@@ -257,9 +225,7 @@ async def approval_merge_request(project_id, iid, gl):
                 bot_approved = True
                 return
     if not bot_approved:
-        await gl.post(
-            f"/projects/{project_id}/merge_requests/{iid}/approve", data=None
-        )
+        await gl.post(f"/projects/{project_id}/merge_requests/{iid}/approve", data=None)
 
 
 def is_opened_merge_request(event):
@@ -270,9 +236,7 @@ def is_opened_merge_request(event):
     return merge_request_state == "opened"
 
 
-async def update_status_label(
-    gl, pid, mr_iid, label, current_labels, action=StatusLabelAction.Add
-):
+async def update_status_label(gl, pid, mr_iid, label, current_labels, action=StatusLabelAction.Add):
     if not is_status_label(label):
         logging.error(f"Label '{label}' is not a valid status label")
         return False, None
@@ -282,18 +246,14 @@ async def update_status_label(
             to_update.append(label)
             logging.debug(f"Adding status label '{label}' to MR {mr_iid}")
         else:
-            logging.debug(
-                f"Status label '{label}' already exists in MR {mr_iid}"
-            )
+            logging.debug(f"Status label '{label}' already exists in MR {mr_iid}")
             return False, None
     elif action == StatusLabelAction.Remove:
         if label in to_update:
             to_update.remove(label)
             logging.debug(f"Removing status label '{label}' from MR {mr_iid}")
         else:
-            logging.debug(
-                f"Status label '{label}' does not exist in MR {mr_iid}"
-            )
+            logging.debug(f"Status label '{label}' does not exist in MR {mr_iid}")
             return False, None
     else:
         logging.error(f"Invalid action '{action}' for updating status label")
@@ -315,9 +275,7 @@ def is_status_label(label):
 
 
 def has_ai_review(description, labels):
-    if bot_gitlab_merge_request_aireview_label_enabled and has_ai_review_label(
-        labels
-    ):
+    if bot_gitlab_merge_request_aireview_label_enabled and has_ai_review_label(labels):
         return True
     if has_ai_summary_description(description):
         return True