Refactor FolderAnalyzerGenHook to handle errors during file analysis

sumansaurabh · sumansaurabh · commit 0bb459107ac0 · 2024-08-25T21:01:22.000+05:30
diff --git a/penify_hook/commit_analyzer.py b/penify_hook/commit_analyzer.py
@@ -16,16 +16,20 @@ def __init__(self, repo_path: str, api_client: APIClient):
         self.repo_details = self.get_repo_details()
 
     def get_repo_details(self):
-        """
-        Get the details of the repository, including the hosting service (e.g., GitHub, Azure DevOps),
+        """Get the details of the repository, including the hosting service,
         organization name, and repository name.
 
-        This method checks the remote URL of the repository to determine whether it is hosted on
-        GitHub, Azure DevOps, or another service. It also extracts the organization (or user) name
-        and the repository name from the URL.
+        This method checks the remote URL of the repository to determine whether
+        it is hosted on GitHub, Azure DevOps, Bitbucket, GitLab, or another
+        service. It extracts the organization (or user) name and the repository
+        name from the URL. If the hosting service is not recognized, it will
+        return "Unknown Hosting Service". The method handles potential errors
+        during the extraction process and returns a dictionary with the relevant
+        details.
 
         Returns:
-            dict: A dictionary containing the hosting service, organization name, repository name, and remote URL.
+            dict: A dictionary containing the organization name, repository name, and
+                hosting service.
         """
         remote_url = None
         hosting_service = "Unknown"
@@ -75,6 +79,24 @@ def get_repo_details(self):
         }
 
     def get_summary(self, instruction: str):
+        """Generate a summary for the commit based on the staged changes.
+
+        This function retrieves the differences of the staged changes in the
+        repository and generates a commit summary using the provided
+        instruction. If there are no changes staged for commit, an exception is
+        raised.
+
+        Args:
+            instruction (str): A string containing instructions for generating the commit summary.
+
+        Returns:
+            str: The generated commit summary based on the staged changes and provided
+                instruction.
+
+        Raises:
+            Exception: If there are no changes staged for commit.
+        """
+
         diff = self.repo.git.diff('--cached')
         if not diff:
             raise Exception("No changes to commit")
@@ -88,7 +110,16 @@ def run(self, msg: Optional[str], edit_commit_message: bool):
         and processes each file. It stages any files that have been modified
         during processing and creates an auto-commit if changes were made. A
         progress bar is displayed to indicate the processing status of each
-        file.
+        file. If there is an error generating the commit summary, an exception
+        is raised.
+
+        Args:
+            msg (Optional[str]): An optional message to include in the commit.
+            edit_commit_message (bool): A flag indicating whether to open the
+                git commit edit terminal after committing.
+
+        Raises:
+            Exception: If there is an error generating the commit summary.
         """
         summary: dict = self.get_summary(msg)
         if not summary:
@@ -106,11 +137,12 @@ def run(self, msg: Optional[str], edit_commit_message: bool):
         
 
     def _amend_commit(self):
-        """
-        Open the default git editor for editing the commit message.
-        
-        Args:
-            initial_message (str): The initial commit message to populate the editor with.
+        """Open the default git editor for editing the commit message.
+
+        This function changes the current working directory to the repository
+        path, runs the git command to amend the last commit, and opens the
+        default editor for the user to modify the commit message. After the
+        operation, it returns to the original directory.
         """
         try:
             # Change to the repository directory
diff --git a/penify_hook/folder_analyzer.py b/penify_hook/folder_analyzer.py
@@ -42,7 +42,14 @@ def run(self):
         them and running a file analyzer on each one. It provides feedback on
         the number of files being processed and handles any errors that occur
         during the analysis of individual files, ensuring that the progress bar
-        updates appropriately even in the event of an error.
+        updates appropriately even in the event of an error.  It first retrieves
+        a list of all files in the specified directory and prints the total
+        number of files to be processed. Then, it initializes a progress bar to
+        visually indicate the processing status. For each file, it attempts to
+        create an instance of `FileAnalyzerGenHook` and run its analysis method.
+        If an error occurs while processing a file, it catches the exception,
+        prints an error message, and continues with the next file, ensuring that
+        the progress bar reflects the ongoing processing.
         """
         try:
             file_list = self.list_all_files_in_dir(self.dir_path)
diff --git a/penify_hook/git_analyzer.py b/penify_hook/git_analyzer.py
@@ -13,16 +13,18 @@ def __init__(self, repo_path: str, api_client: APIClient):
         self.repo_details = self.get_repo_details()
 
     def get_repo_details(self):
-        """
-        Get the details of the repository, including the hosting service (e.g., GitHub, Azure DevOps),
+        """Get the details of the repository, including the hosting service,
         organization name, and repository name.
 
-        This method checks the remote URL of the repository to determine whether it is hosted on
-        GitHub, Azure DevOps, or another service. It also extracts the organization (or user) name
-        and the repository name from the URL.
+        This method checks the remote URL of the repository to determine whether
+        it is hosted on GitHub, Azure DevOps, Bitbucket, GitLab, or another
+        service. It extracts the organization (or user) name and the repository
+        name from the URL. If the hosting service cannot be determined, it will
+        return "Unknown Hosting Service".
 
         Returns:
-            dict: A dictionary containing the hosting service, organization name, repository name, and remote URL.
+            dict: A dictionary containing the organization name, repository name, and
+                hosting service.
         """
         remote_url = None
         hosting_service = "Unknown"
@@ -143,13 +145,13 @@ def process_file(self, file_path):
         """Process a file by checking its type, reading its content, and sending it
         to an API.
 
-        This method first constructs the absolute path of the file and checks if
-        the file has a valid extension. If the file type is supported, it reads
-        the content of the file and retrieves the differences from the last
-        commit in the repository. If there are changes detected, it sends the
-        file content along with the modified lines to an API for further
-        processing. If the API response indicates no changes, it will not
-        overwrite the original file.
+        This method constructs the absolute path of the specified file and
+        verifies if the file has a valid extension. If the file type is
+        supported, it reads the content of the file and retrieves the
+        differences from the last commit in the repository. If changes are
+        detected, it sends the file content along with the modified lines to an
+        API for further processing. If the API response indicates no changes,
+        the original file will not be overwritten.
 
         Args:
             file_path (str): The relative path to the file to be processed.
@@ -206,7 +208,10 @@ def run(self):
         and processes each file. It stages any files that have been modified
         during processing and creates an auto-commit if changes were made. A
         progress bar is displayed to indicate the processing status of each
-        file.
+        file.  The method handles any exceptions that occur during file
+        processing, printing an error message for each file that fails to
+        process. If any modifications are made to the files, an auto-commit is
+        created to save those changes.
         """
         modified_files = self.get_modified_files_in_last_commit()
         changes_made = False
diff --git a/penify_hook/main.py b/penify_hook/main.py
@@ -19,6 +19,16 @@
 api_url = 'https://production-gateway.snorkell.ai/api'
 
 def install_git_hook(location, token):
+    """
+    Install a post-commit hook in the specified location.
+    Args:
+        location (str): The path to the Git repository.
+        token (str): The token to be used in the hook.
+    Raises:
+        SystemExit: If the hooks directory does not exist.
+    Returns:
+        None
+    """
     hooks_dir = Path(location) / ".git/hooks"
     hook_path = hooks_dir / HOOK_FILENAME
     
@@ -33,6 +43,13 @@ def install_git_hook(location, token):
     print(f"Post-commit hook installed in {hook_path}")
 
 def uninstall_git_hook(location):
+    """
+    Uninstalls the post-commit hook from the specified location.
+    Parameters:
+    - location (str): The path to the directory containing the Git repository.
+    Returns:
+    None
+    """
     hook_path = Path(location) / ".git/hooks" / HOOK_FILENAME
     
     if hook_path.exists():
@@ -42,6 +59,14 @@ def uninstall_git_hook(location):
         print(f"No post-commit hook found in {hook_path}")
 
 def generate_doc(token, file_path=None, complete_folder_path=None, git_folder_path=None):
+    """
+    Generates documentation based on the given parameters.
+    Parameters:
+    - token (str): The API token for authentication.
+    - file_path (str, optional): The path to a specific file to generate documentation for.
+    - complete_folder_path (str, optional): The path to a complete folder to generate documentation for.
+    - git_folder_path (str, optional): The path to a Git repository folder to generate documentation for.
+    """
     
     api_client = APIClient(api_url, token)
 
