Modify pre-commit script

Author: sfc-gh-pczajka

ci/pre-commit/check_optional_imports.py

@@ -1,6 +1,6 @@
 #!/usr/bin/env python3
 """
-Pre-commit hook to ensure optional imports are wrapped in try...except blocks.
+Pre-commit hook to ensure optional dependencies are always imported from .options module.
 This ensures that the connector can operate in environments where these optional libraries are not available.
 """
 import argparse
@@ -27,17 +27,12 @@ def __str__(self):
 
 
 class ImportChecker(ast.NodeVisitor):
-    """Checks for unwrapped optional imports."""
+    """Checks that optional imports are only imported from .options module."""
 
     def __init__(self, filename: str):
         self.filename = filename
         self.violations: List[ImportViolation] = []
 
-    def visit_Try(self, node: ast.Try):
-        """Track entry/exit of try blocks."""
-        # do not visit blocks inside try..except blocks
-        pass
-
     def visit_Import(self, node: ast.Import):
         """Check import statements."""
         for alias in node.names:
@@ -47,27 +42,41 @@ def visit_Import(self, node: ast.Import):
     def visit_ImportFrom(self, node: ast.ImportFrom):
         """Check from...import statements."""
         if node.module:
-            self._check_import(node.module, node.lineno, node.col_offset)
+            # Check if importing from a checked module directly
+            for module in CHECKED_MODULES:
+                if node.module.startswith(module):
+                    self.violations.append(
+                        ImportViolation(
+                            self.filename,
+                            node.lineno,
+                            node.col_offset,
+                            f"Import from '{node.module}' is not allowed. Use 'from .options import {module}' instead",
+                        )
+                    )
+
+            # Check if importing checked modules from .options (this is allowed)
+            if node.module == ".options":
+                # This is the correct way to import these modules
+                pass
         self.generic_visit(node)
 
     def _check_import(self, module_name: str, line: int, col: int):
-        """Check if a module import is boto-related and unwrapped."""
-
+        """Check if a module import is for checked modules and not from .options."""
         for module in CHECKED_MODULES:
             if module_name.startswith(module):
                 self.violations.append(
                     ImportViolation(
                         self.filename,
                         line,
                         col,
-                        f"Import of '{module_name}' must be wrapped in try...except block to handle cases where {module} is not available",
+                        f"Direct import of '{module_name}' is not allowed. Use 'from .options import {module}' instead",
                     )
                 )
                 break
 
 
 def check_file(filename: str) -> List[ImportViolation]:
-    """Check a file for boto import violations."""
+    """Check a file for optional import violations."""
     try:
         tree = ast.parse(Path(filename).read_text())
     except SyntaxError:
@@ -80,9 +89,8 @@ def check_file(filename: str) -> List[ImportViolation]:
 
 def main():
     """Main function for pre-commit hook."""
-    return 0  # temporarily skip the check
     parser = argparse.ArgumentParser(
-        description="Check for unwrapped boto3/botocore imports"
+        description="Check that optional imports are only imported from .options module"
     )
     parser.add_argument("filenames", nargs="*", help="Filenames to check")
     parser.add_argument(
@@ -98,7 +106,7 @@ def main():
 
     # Show violations
     if all_violations:
-        print("Unwrapped boto3/botocore import violations found:")
+        print("Optional import violations found:")
         print()
 
         for violation in all_violations:
@@ -107,18 +115,19 @@ def main():
         if args.show_fixes:
             print()
             print("How to fix:")
-            print("  - Wrap boto3/botocore imports in try...except blocks")
+            print("  - Import optional modules only from .options module")
             print("  - Example:")
-            print("    try:")
-            print("        import boto3")
-            print("        from botocore.config import Config")
-            print("    except ImportError:")
-            print("        # Handle the case where boto3/botocore is not available")
-            print("        boto3 = None")
-            print("        Config = None")
+            print("    # CORRECT:")
+            print("    from .options import boto3, botocore, installed_boto")
+            print("    if installed_boto:")
+            print("        SigV4Auth = botocore.auth.SigV4Auth")
+            print()
+            print("    # INCORRECT:")
+            print("    import boto3")
+            print("    from botocore.auth import SigV4Auth")
             print()
             print(
-                "  - This ensures the connector works in environments where AWS libraries are not installed"
+                "  - This ensures the connector works in environments where optional libraries are not installed"
             )
 
         print()