setup python black linter (#65)

* ✨refactor code formatting in multiple files, update dev requirements

* ✨refactor argument parsing for commands and enhance code formatting

Author: ming1in

ai_commit_msg/cli/config_handler.py

@@ -4,6 +4,7 @@
 from ai_commit_msg.utils.logger import Logger
 from ai_commit_msg.services.onboarding_service import onboarding_flow
 
+
 def handle_config_setup():
     onboarding_flow()
     return
@@ -25,7 +26,7 @@ def config_handler(args):
         has_updated = True
 
     if args.reset:
-        #reset the db the entire db
+        # reset the db the entire db
         LocalDbService().reset_db()
         Logger().log("Configuration has been reset")
         has_updated = True

ai_commit_msg/cli/gen_ai_commit_message_handler.py

@@ -5,14 +5,17 @@
 from ai_commit_msg.utils.error import AIModelHandlerError
 from ai_commit_msg.utils.logger import Logger
 
+
 def gen_ai_commit_message_handler():
     logger = Logger()
 
     PipService().display_outdated_version_message()
 
-    if(len(GitService.get_staged_files()) == 0):
-      print("🚨 No files are staged for commit. Run `git add` to stage some of your changes")
-      return
+    if len(GitService.get_staged_files()) == 0:
+        print(
+            "🚨 No files are staged for commit. Run `git add` to stage some of your changes"
+        )
+        return
 
     staged_diff = GitService.get_staged_diff()
 
@@ -34,24 +37,28 @@ def gen_ai_commit_message_handler():
 
     should_push_changes = input(command_string)
 
-    if should_push_changes == 'n':
+    if should_push_changes == "n":
         logger.log("👋 Goodbye!")
         return
-    elif should_push_changes != 'y':
+    elif should_push_changes != "y":
         logger.log("🚨 Invalid input. Exiting.")
         return
 
-    execute_cli_command(['git', 'commit', '-m', ai_gen_commit_msg], output=True)
+    execute_cli_command(["git", "commit", "-m", ai_gen_commit_msg], output=True)
     current_branch = GitService.get_current_branch()
     has_upstream = GitService.has_upstream_branch(current_branch)
 
     if has_upstream:
-        execute_cli_command(['git', 'push'], output=True)
+        execute_cli_command(["git", "push"], output=True)
         return
 
-    set_upstream = input(f"No upstream branch found for '{current_branch}'. This will run: 'git push --set-upstream origin {current_branch}'. Set upstream? (y/n): ")
-    if set_upstream.lower() == 'y':
-        execute_cli_command(['git', 'push', '--set-upstream', 'origin', current_branch], output=True)
+    set_upstream = input(
+        f"No upstream branch found for '{current_branch}'. This will run: 'git push --set-upstream origin {current_branch}'. Set upstream? (y/n): "
+    )
+    if set_upstream.lower() == "y":
+        execute_cli_command(
+            ["git", "push", "--set-upstream", "origin", current_branch], output=True
+        )
         print(f"🔄 Upstream branch set for '{current_branch}'")
     else:
         print("Skipping push. You can set upstream manually")

ai_commit_msg/cli/hook_handler.py

@@ -12,7 +12,7 @@ def get_bash_script():
     version = PipService.get_version()
     id = uuid.uuid4()
 
-    PREPARE_COMMIT_MSG_BASH_SCRIPT=f"""#!/usr/bin/env bash
+    PREPARE_COMMIT_MSG_BASH_SCRIPT = f"""#!/usr/bin/env bash
 # This file was generated by git-ai-commit: https://github.com/the-cafe/git-ai-commit
 # version: {version}
 # hash: {id}
@@ -30,26 +30,29 @@ def get_bash_script():
 """
     return PREPARE_COMMIT_MSG_BASH_SCRIPT
 
+
 def handle_setup_hook(hook_directory_path: str):
     existing_hook_content = ""
     if os.path.exists(hook_directory_path):
-      with open(hook_directory_path, 'r') as file:
-          existing_hook_content = file.read()
+        with open(hook_directory_path, "r") as file:
+            existing_hook_content = file.read()
 
     if existing_hook_content == get_bash_script():
         Logger().log("prepare-commit-msg hook already exists")
         return
 
     if existing_hook_content:
-      override_content = input(f"prepare-commit-msg hook already exists in {hook_directory_path}\n\nWould you like to overwrite it? (y/n): ")
+        override_content = input(
+            f"prepare-commit-msg hook already exists in {hook_directory_path}\n\nWould you like to overwrite it? (y/n): "
+        )
 
-      if override_content.lower() == 'n':
-        return
-      elif override_content.lower() != 'y':
-        Logger().log("Invalid input. Exiting.")
+        if override_content.lower() == "n":
+            return
+        elif override_content.lower() != "y":
+            Logger().log("Invalid input. Exiting.")
 
     ## create the prepare-commit-msg file and write the hook code
-    with open(hook_directory_path, 'w') as file:
+    with open(hook_directory_path, "w") as file:
         file.write(get_bash_script())
 
     # make the file executable
@@ -74,7 +77,9 @@ def setup_husky_git_hook():
     Logger().log("[Setup] Husky prepare-commit-msg hook")
 
     if not HuskyService.repo_has_husky_framework():
-        Logger().log("Husky framework not found in the repository. Please install husky - https://typicode.github.io/husky/")
+        Logger().log(
+            "Husky framework not found in the repository. Please install husky - https://typicode.github.io/husky/"
+        )
         return
 
     file_path = HuskyService.get_husky_prepare_commit_msg_hook_path()
@@ -95,6 +100,7 @@ def setup_git_hook():
 
     return
 
+
 def hook_handler(args):
     if args.setup:
         setup_git_hook()

ai_commit_msg/cli/summary_handler.py

@@ -3,40 +3,47 @@
 from ai_commit_msg.utils.logger import Logger
 from ai_commit_msg.utils.utils import execute_cli_command
 
+
 def print_summary(summary):
-  Logger().log(f"""Here is a summary of your changes:
+    Logger().log(
+        f"""Here is a summary of your changes:
 
   {summary}
 
 to use this summary run: `git commit -m "{summary}"`
-""")
+"""
+    )
+
 
 def summaryFromDiffFile(diff_file_path):
-  with open(diff_file_path, 'r') as file:
-    diff = file.read()
-    ai_commit_msg = generate_commit_message(diff)
-    print_summary(ai_commit_msg)
+    with open(diff_file_path, "r") as file:
+        diff = file.read()
+        ai_commit_msg = generate_commit_message(diff)
+        print_summary(ai_commit_msg)
+
 
 def summary_handler(args):
 
-  if args.diff:
-    summaryFromDiffFile(args.diff)
-    return
+    if args.diff:
+        summaryFromDiffFile(args.diff)
+        return
 
-  if args.unstaged:
-    Logger().log("Fetching your unstaged changes...\n")
-    unstaged_changes_diff = execute_cli_command(['git', 'diff'])
-    ai_commit_msg = generate_commit_message(unstaged_changes_diff.stdout)
-    print_summary(ai_commit_msg)
-    return
+    if args.unstaged:
+        Logger().log("Fetching your unstaged changes...\n")
+        unstaged_changes_diff = execute_cli_command(["git", "diff"])
+        ai_commit_msg = generate_commit_message(unstaged_changes_diff.stdout)
+        print_summary(ai_commit_msg)
+        return
 
-  Logger().log("Fetching your staged changes...\n")
+    Logger().log("Fetching your staged changes...\n")
 
-  if(len(GitService.get_staged_files()) == 0):
-    Logger().log("🚨 No files are staged for commit. Run `git add` to stage some of your changes")
-    return
+    if len(GitService.get_staged_files()) == 0:
+        Logger().log(
+            "🚨 No files are staged for commit. Run `git add` to stage some of your changes"
+        )
+        return
 
-  staged_changes_diff = execute_cli_command(['git', 'diff', '--staged'])
-  ai_commit_msg = generate_commit_message(staged_changes_diff.stdout)
+    staged_changes_diff = execute_cli_command(["git", "diff", "--staged"])
+    ai_commit_msg = generate_commit_message(staged_changes_diff.stdout)
 
-  print_summary(ai_commit_msg)
+    print_summary(ai_commit_msg)

ai_commit_msg/core/gen_commit_msg.py

@@ -7,28 +7,29 @@
 from ai_commit_msg.utils.logger import Logger
 from ai_commit_msg.utils.models import ANTHROPIC_MODEL_LIST, OPEN_AI_MODEL_LIST
 
+
 def generate_commit_message(diff: str = None) -> str:
 
-  if diff is None:
-    raise ValueError("Diff is required to generate a commit message")
+    if diff is None:
+        raise ValueError("Diff is required to generate a commit message")
 
-  select_model = ConfigService.get_model()
+    select_model = ConfigService.get_model()
 
-  prompt = get_prompt(diff)
+    prompt = get_prompt(diff)
 
-  # TODO - create a factory with a shared interface for calling the LLM models, this will make it easier to add new models
-  ai_gen_commit_msg = None
-  if str(select_model) in OPEN_AI_MODEL_LIST :
-    ai_gen_commit_msg = OpenAiService().chat_with_openai(prompt)
-  elif(select_model.startswith("ollama")):
-    ai_gen_commit_msg = OLlamaService().chat_completion(prompt)
-  elif(select_model in ANTHROPIC_MODEL_LIST):
-    ai_gen_commit_msg = AnthropicService().chat_completion(prompt)
+    # TODO - create a factory with a shared interface for calling the LLM models, this will make it easier to add new models
+    ai_gen_commit_msg = None
+    if str(select_model) in OPEN_AI_MODEL_LIST:
+        ai_gen_commit_msg = OpenAiService().chat_with_openai(prompt)
+    elif select_model.startswith("ollama"):
+        ai_gen_commit_msg = OLlamaService().chat_completion(prompt)
+    elif select_model in ANTHROPIC_MODEL_LIST:
+        ai_gen_commit_msg = AnthropicService().chat_completion(prompt)
 
-  if ai_gen_commit_msg is None:
-    Logger().log("Unsupported model: " + select_model)
-    return ""
+    if ai_gen_commit_msg is None:
+        Logger().log("Unsupported model: " + select_model)
+        return ""
 
-  prefix = ConfigService().prefix
+    prefix = ConfigService().prefix
 
-  return prefix + ai_gen_commit_msg
+    return prefix + ai_gen_commit_msg

ai_commit_msg/core/prompt.py

@@ -1,9 +1,10 @@
 from ai_commit_msg.services.config_service import ConfigService
 
+
 def get_prompt(diff):
-  max_length = ConfigService().max_length
+    max_length = ConfigService().max_length
 
-  COMMIT_MSG_SYSTEM_MESSAGE = f'''
+    COMMIT_MSG_SYSTEM_MESSAGE = f"""
 Your a software engineer and you are reviewing a set of code changes.
 You will be provided with a set of code changes in diff format.
 
@@ -13,9 +14,9 @@ def get_prompt(diff):
 - You don't need to add any punctuation or capitalization.
 - Instead of and, use a comma to save characters.
 - Your response cannot more than {max_length} characters.
-'''
+"""
 
-  return [
-    {"role": "system", "content": COMMIT_MSG_SYSTEM_MESSAGE},
-    {"role": "user", "content": diff},
-  ]
+    return [
+        {"role": "system", "content": COMMIT_MSG_SYSTEM_MESSAGE},
+        {"role": "user", "content": diff},
+    ]