Formatted code_coverage_disable_check.py to comply with all coding and documentation standards.

Author: im-vedant

.github/workflows/code_coverage_disable_check.py

@@ -2,20 +2,20 @@
 
 Methodology:
 
-    Recursively analyzes TypeScript files in the specified directories to ensure
-    they do not contain code coverage disable statements.
+    Recursively analyzes TypeScript files in the specified directories to
+    ensure they do not contain code coverage disable statements.
 
     This script enforces proper code coverage practices in the project.
 
 NOTE:
-
     This script complies with our python3 coding and documentation standards.
     It complies with:
 
         1) Pylint
         2) Pydocstyle
         3) Pycodestyle
         4) Flake8
+        5) Python Black
 
 """
 
@@ -24,6 +24,7 @@
 import argparse
 import sys
 
+
 def has_code_coverage_disable(file_path):
     """
     Check if a TypeScript file contains code coverage disable statements.
@@ -32,18 +33,30 @@ def has_code_coverage_disable(file_path):
         file_path (str): Path to the TypeScript file.
 
     Returns:
-        bool: True if code coverage disable statement is found, False otherwise.
+        bool: True if code coverage disable statement is found, False
+        otherwise.
     """
-    code_coverage_disable_pattern = re.compile(r'(?://\s*istanbul\s+ignore(?:-next-line|-line)?|/\*\s*istanbul\s+ignore\s*(?:next|-line)\s*\*/)', re.IGNORECASE)
-    
+    code_coverage_disable_pattern = re.compile(
+        r"""(?://\s*istanbul\s+ignore(?:-next-line|-line)?
+        |/\*\s*istanbul\s+ignore\s*(?:next|-line)\s*\*/)""",
+        re.IGNORECASE,
+    )
+
     try:
-        with open(file_path, 'r', encoding='utf-8') as file:
+        with open(file_path, "r", encoding="utf-8") as file:
             content = file.read()
             return bool(code_coverage_disable_pattern.search(content))
-    except Exception as e:
+    except FileNotFoundError:
+        print(f"File not found: {file_path}")
+        return False
+    except PermissionError:
+        print(f"Permission denied: {file_path}")
+        return False
+    except (IOError, OSError) as e:
         print(f"Error reading file {file_path}: {e}")
         return False
 
+
 def check_code_coverage(directories):
     """
     Recursively check TypeScript files for code coverage disable statements.
@@ -52,29 +65,46 @@ def check_code_coverage(directories):
         directories (list) : List of directories.
 
     Returns:
-        bool: True if code coverage disable statement is found, False otherwise.
+        bool: True if code coverage disable statement is found, False
+        otherwise.
     """
     code_coverage_found = False
 
     for directory in directories:
         if not os.path.exists(directory):
-            print(f"Error: The specified directory '{directory}' does not exist.")
+            print(
+                f"""Error: The specified directory '{directory}' does
+                not exist."""
+            )
             sys.exit(1)
-        for root, dirs, files in os.walk(directory):
+        for root, _, files in os.walk(directory):
             for file_name in files:
-                if file_name.endswith('.tsx') and not file_name.endswith('.test.tsx'):
+                if (
+                    file_name.endswith(".tsx")
+                    and not file_name.endswith(".test.tsx")
+                   ):
                     file_path = os.path.join(root, file_name)
                     if has_code_coverage_disable(file_path):
-                        print(f'File {file_path} contains code coverage disable statement.')
+                        print(
+                            f"""File {file_path} contains code coverage disable
+                            statement."""
+                        )
                         code_coverage_found = True
 
-        setup_path = os.path.join(directory, 'setup.ts')
-        if os.path.exists(setup_path) and has_code_coverage_disable(setup_path):
-            print(f'Setup file {setup_path} contains code coverage disable statement.')
+        setup_path = os.path.join(directory, "setup.ts")
+        if (
+            os.path.exists(setup_path)
+            and has_code_coverage_disable(setup_path)
+           ):
+            print(
+                f"""Setup file {setup_path} contains code coverage disable
+                statement."""
+            )
             code_coverage_found = True
 
     return code_coverage_found
 
+
 def arg_parser_resolver():
     """Resolve the CLI arguments provided by the user.
 
@@ -85,12 +115,14 @@ def arg_parser_resolver():
     parser.add_argument(
         "--directory",
         type=str,
-        nargs='+',
+        nargs="+",
         default=[os.getcwd()],
-        help="One or more directories to check for code coverage disable statements (default: current directory)."
+        help="""One or more directories to check for code coverage disable
+        statements (default: current directory).""",
     )
     return parser.parse_args()
 
+
 def main():
     """
     Execute the script's main functionality.
@@ -99,16 +131,16 @@ def main():
     the following tasks:
     1. Validates and retrieves the directory to check from
        command line arguments.
-    2. Recursively checks TypeScript files for code coverage disable statements.
+    2. Recursively checks TypeScript files for code coverage disable
+    statements.
     3. Provides informative messages based on the analysis.
     4. Exits with an error if code coverage disable statements are found.
 
     Raises:
         SystemExit: If an error occurs during execution.
     """
     args = arg_parser_resolver()
-    print("Directories to check: ", args.directory)
-    
+
     # Check code coverage in the specified directory
     code_coverage_found = check_code_coverage(args.directory)
 
@@ -118,5 +150,6 @@ def main():
 
     print("Code coverage disable check completed successfully.")
 
+
 if __name__ == "__main__":
     main()