relink and rimport now share a logger.

Author: samsrabin

relink.py

@@ -20,11 +20,9 @@
     validate_paths,
     validate_directory,
     configure_logging,
+    logger
 )
 
-# Set up logger
-logger = logging.getLogger(__name__)
-
 # Define a custom log level that always prints
 ALWAYS = logging.CRITICAL * 2
 logging.addLevelName(ALWAYS, "ALWAYS")
@@ -389,7 +387,7 @@ def main():
 
     args = parse_arguments()
 
-    configure_logging(logger, args.log_level)
+    configure_logging(args.log_level)
 
     my_username = os.environ["USER"]
 

rimport

@@ -28,7 +28,7 @@ INDENT = "    "
 INPUTDATA_URL = "https://osdf-data.gdex.ucar.edu/ncar/gdex/d651077/cesmdata/inputdata"
 
 # Configure logging
-logger = logging.getLogger(__name__)
+logger = shared.logger
 
 
 def build_parser() -> argparse.ArgumentParser:
@@ -330,7 +330,7 @@ def main(argv: List[str] | None = None) -> int:
 
     # Configure logging based on verbosity flags
     log_level = shared.get_log_level(quiet=args.quiet, verbose=args.verbose)
-    shared.configure_logging(logger, log_level)
+    shared.configure_logging(log_level)
 
     # Ensure we are running as the STAGE_OWNER account before touching the tree
     # Set env var RIMPORT_SKIP_USER_CHECK=1 if you prefer to run `sudox -u STAGE_OWNER rimport …`

shared.py

@@ -12,6 +12,8 @@
     "/glade/campaign/collections/gdex/data/d651077/cesmdata/inputdata/"
 )
 
+logger = logging.getLogger("rimport_relink")
+
 
 def get_log_level(quiet: bool = False, verbose: bool = False) -> int:
     """Determine logging level based on quiet and verbose flags.
@@ -33,7 +35,7 @@ def get_log_level(quiet: bool = False, verbose: bool = False) -> int:
     return logging.INFO
 
 
-def configure_logging(logger, log_level: int) -> None:
+def configure_logging(log_level: int, logger_in: logging.Logger = logger) -> None:
     """Configure logging to send INFO/WARNING to stdout and ERROR/CRITICAL to stderr.
 
     Sets up two handlers:
@@ -44,8 +46,9 @@ def configure_logging(logger, log_level: int) -> None:
 
     Args:
         log_level: Minimum logging level (DEBUG, INFO, or WARNING).
+        logger_in: Logger to operate on. Should only be used in testing.
     """
-    logger.setLevel(log_level)
+    logger_in.setLevel(log_level)
 
     # Handler for INFO, WARNING, and DEBUG level messages -> stdout
     info_handler = logging.StreamHandler(sys.stdout)
@@ -59,9 +62,9 @@ def configure_logging(logger, log_level: int) -> None:
     error_handler.setFormatter(logging.Formatter("%(message)s"))
 
     # Clear any existing handlers and add our custom ones
-    logger.handlers.clear()
-    logger.addHandler(info_handler)
-    logger.addHandler(error_handler)
+    logger_in.handlers.clear()
+    logger_in.addHandler(info_handler)
+    logger_in.addHandler(error_handler)
 
 
 def add_inputdata_root(parser: argparse.ArgumentParser):

tests/shared/test_configure_logging.py

@@ -23,17 +23,17 @@ def cleanup_logger(self):
 
     def test_sets_logger_level_to_info(self):
         """Test that configure_logging sets the logger level to INFO."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         assert logger.level == logging.INFO
 
     def test_creates_two_handlers(self):
         """Test that configure_logging creates exactly two handlers."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         assert len(logger.handlers) == 2
 
     def test_info_handler_goes_to_stdout(self, capsys):
         """Test that INFO level messages go to stdout."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         logger.info("Test info message")
 
         captured = capsys.readouterr()
@@ -42,7 +42,7 @@ def test_info_handler_goes_to_stdout(self, capsys):
 
     def test_warning_handler_goes_to_stdout(self, capsys):
         """Test that WARNING level messages go to stdout."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         logger.warning("Test warning message")
 
         captured = capsys.readouterr()
@@ -51,7 +51,7 @@ def test_warning_handler_goes_to_stdout(self, capsys):
 
     def test_error_handler_goes_to_stderr(self, capsys):
         """Test that ERROR level messages go to stderr."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         logger.error("Test error message")
 
         captured = capsys.readouterr()
@@ -60,7 +60,7 @@ def test_error_handler_goes_to_stderr(self, capsys):
 
     def test_critical_handler_goes_to_stderr(self, capsys):
         """Test that CRITICAL level messages go to stderr."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         logger.critical("Test critical message")
 
         captured = capsys.readouterr()
@@ -76,15 +76,15 @@ def test_clears_existing_handlers(self):
         assert len(logger.handlers) >= 1
 
         # Configure logging
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
 
         # Verify old handlers were cleared and new ones added
         assert len(logger.handlers) == 2
         assert dummy_handler not in logger.handlers
 
     def test_formatter_uses_message_only(self, capsys):
         """Test that the formatter outputs only the message without level/timestamp."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         logger.info("Simple message")
 
         captured = capsys.readouterr()
@@ -94,18 +94,18 @@ def test_formatter_uses_message_only(self, capsys):
 
     def test_multiple_calls_dont_duplicate_handlers(self):
         """Test that calling configure_logging multiple times doesn't duplicate handlers."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         assert len(logger.handlers) == 2
 
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         assert len(logger.handlers) == 2  # Still 2, not 4
 
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
         assert len(logger.handlers) == 2  # Still 2, not 6
 
     def test_configure_with_debug_level(self, capsys):
         """Test that configure_logging accepts DEBUG level."""
-        shared.configure_logging(logger, logging.DEBUG)
+        shared.configure_logging(logging.DEBUG, logger)
 
         # DEBUG messages should now be logged
         logger.debug("Debug message")
@@ -116,7 +116,7 @@ def test_configure_with_debug_level(self, capsys):
 
     def test_configure_with_warning_level(self, capsys):
         """Test that configure_logging accepts WARNING level."""
-        shared.configure_logging(logger, logging.WARNING)
+        shared.configure_logging(logging.WARNING, logger)
 
         # INFO messages should be suppressed
         logger.info("Info message")
@@ -130,7 +130,7 @@ def test_configure_with_warning_level(self, capsys):
 
     def test_configure_with_info_level_suppresses_debug(self, capsys):
         """Test that INFO level suppresses DEBUG messages."""
-        shared.configure_logging(logger, logging.INFO)
+        shared.configure_logging(logging.INFO, logger)
 
         logger.debug("Debug message")
         logger.info("Info message")