Merge pull request #70 from nasa/alexrad71/TEMPO-notebooks

Add TEMPO V04 vs Pandora comparison notebooks

Author: danielfromearth

.git-hooks/check-notebook-headers.py

@@ -88,11 +88,6 @@ def main():
     # Create parser with common arguments
     parser = create_base_parser(description="Check notebook structure for required header content")
 
-    # Add script-specific arguments
-    parser.add_argument(
-        "files", nargs="*", help="Specific files to check (overrides --all-notebooks)"
-    )
-
     args = parser.parse_args()
 
     # Get notebooks to check using common logic

.git-hooks/check-notebook-imports.py

@@ -151,13 +151,14 @@ def main():
             unauthorized = check_notebook_imports(notebook, allowed_packages)
 
             if unauthorized:
+                label = "⚠️ " if args.warn_only else "❌"
                 result.add_error(
                     notebook,
                     f"Unauthorized imports: {', '.join(sorted(unauthorized))}",
                     {"unauthorized_packages": sorted(unauthorized)},
                 )
                 if not args.quiet:
-                    print(f"❌ {notebook}")
+                    print(f"{label} {notebook}")
                     print(f"   Unauthorized: {', '.join(sorted(unauthorized))}")
             elif args.verbose:
                 print(f"✅ {notebook}")
@@ -175,7 +176,7 @@ def main():
     # Print summary
     if not args.quiet:
         print()
-        result.print_summary(verbose=args.verbose)
+        result.print_summary(verbose=args.verbose, warn_only=args.warn_only)
 
         if result.has_errors():
             print()
@@ -184,7 +185,7 @@ def main():
             print("  2. Or remove the imports from notebooks")
             print("  3. Or add to optional dependencies if specialized")
 
-    return result.exit_code()
+    return result.exit_code(warn_only=args.warn_only)
 
 
 if __name__ == "__main__":

.git-hooks/notebook_utils.py

@@ -134,12 +134,18 @@ def has_errors(self) -> bool:
         """Return True if any errors were found."""
         return len(self.errors) > 0
 
-    def print_summary(self, verbose: bool = False):
+    def print_summary(self, verbose: bool = False, warn_only: bool = False):
         """Print a summary of the results."""
         print("=" * 70)
 
         if self.errors:
-            print(f"\n❌ Found {len(self.errors)} error(s) in {self.checked_count} file(s)")
+            if warn_only:
+                print(
+                    f"\n⚠️  Found {len(self.errors)} issue(s) in {self.checked_count}"
+                    f" file(s) (warn-only mode, not blocking)"
+                )
+            else:
+                print(f"\n❌ Found {len(self.errors)} error(s) in {self.checked_count} file(s)")
             for error in self.errors:
                 print(f"\n  {error['file']}")
                 print(f"    {error['message']}")
@@ -155,8 +161,14 @@ def print_summary(self, verbose: bool = False):
         if not self.errors and not self.warnings:
             print(f"✅ All {self.checked_count} file(s) passed")
 
-    def exit_code(self) -> int:
-        """Return appropriate exit code (1 for errors, 0 for success)."""
+    def exit_code(self, warn_only: bool = False) -> int:
+        """Return appropriate exit code.
+
+        Args:
+            warn_only: If True, always return 0 (issues are advisory).
+        """
+        if warn_only:
+            return 0
         return 1 if self.has_errors() else 0
 
 
@@ -209,6 +221,22 @@ def create_base_parser(description: str) -> argparse.ArgumentParser:
         "--quiet", "-q", action="store_true", help="Suppress all output except errors"
     )
 
+    # Behavior arguments
+    behavior_group = parser.add_argument_group("Behavior")
+    behavior_group.add_argument(
+        "--warn-only",
+        action="store_true",
+        help="Report issues as warnings instead of errors (always exits 0)",
+    )
+
+    # Positional: filenames passed by pre-commit (or manually)
+    parser.add_argument(
+        "files",
+        nargs="*",
+        default=[],
+        help="Notebook files to check (passed automatically by pre-commit)",
+    )
+
     return parser
 
 
@@ -221,7 +249,9 @@ def get_notebooks_from_args(args: argparse.Namespace) -> tuple[List[Path], str]:
     Returns:
         Tuple of (list of notebook paths, mode description string)
     """
-    # Check if 'files' argument exists and is populated
+    # Priority: explicit files (from pre-commit or CLI) > --all-notebooks > staged files.
+    # When pre-commit passes filenames, they arrive as positional args and take precedence
+    # over --all-notebooks, which is intended for standalone manual runs.
     if hasattr(args, "files") and args.files:
         notebooks = [Path(f) for f in args.files if f.endswith(".ipynb")]
         mode = "specified"

.pre-commit-config.yaml

@@ -69,7 +69,8 @@ repos:
     hooks:
       - id: check-notebook-imports
         name: Check notebook imports against pyproject.toml
-        entry: python .git-hooks/check-notebook-imports.py
+        entry: python .git-hooks/check-notebook-imports.py --warn-only
         language: system
         types: [jupyter]
+        verbose: true # Always show output since the hook won't block commits
         exclude: "(^|/)(additional_drafts|_archive)/" # Exclude additional_drafts and _archive directories