Add more logging messages for package (#16)

* chores: include more logging messsages for this package.

* fix: fix formatting errors detected by Ruff.

Author: ecarrenolozano

src/pkg_infra/config.py

@@ -49,13 +49,22 @@ def load_config(config_path: str | Path | None = None) -> OmegaConf:
         """
         logger.info('Starting configuration load')
         paths = resolve_config_paths()
+        logger.debug('Resolved config paths: %s', paths)
         parts = [
             load_existing(paths['ecosystem']),
             read_package_default(),
             load_existing(paths['user']),
             load_existing(paths['cwd']),
             load_existing(paths['env']),
         ]
+        logger.info(
+            'Merging configuration sources: ecosystem=%s, package=%s, user=%s, cwd=%s, env=%s',
+            bool(paths['ecosystem'] and paths['ecosystem'].exists()),
+            True,
+            bool(paths['user'] and paths['user'].exists()),
+            bool(paths['cwd'] and paths['cwd'].exists()),
+            bool(paths['env'] and paths['env'].exists()),
+        )
 
         if config_path:
             custom_path = Path(config_path)
@@ -66,6 +75,8 @@ def load_config(config_path: str | Path | None = None) -> OmegaConf:
                 logger.warning(
                     'Custom config path does not exist: %s', custom_path
                 )
+        else:
+            logger.debug('No custom config path provided')
 
         config = merge_configs([p for p in parts if p is not None])
 
@@ -88,6 +99,11 @@ def resolve_config_paths() -> dict[str, Path | None]:
     ecosystem_dir = Path(platformdirs.site_config_dir('pkg_infra'))
     user_dir = Path(platformdirs.user_config_dir('pkg_infra'))
     env_value = os.environ.get(ENV_VARIABLE_DEFAULT_CONFIG)
+    if env_value is None:
+        logger.debug(
+            'Env var %s not set; skipping env config',
+            ENV_VARIABLE_DEFAULT_CONFIG,
+        )
 
     paths = {
         'ecosystem': ecosystem_dir / ECOSYSTEM_CONFIG_FILENAME,
@@ -97,7 +113,6 @@ def resolve_config_paths() -> dict[str, Path | None]:
         'env': Path(env_value) if env_value else None,
         'custom_path': None,
     }
-    logger.debug('Resolved config paths: %s', paths)
     return paths
 
 
@@ -138,6 +153,8 @@ def load_existing(path: Path | None) -> OmegaConf | None:
     if path and path.exists():
         logger.debug('Loading config file: %s', path)
         return OmegaConf.load(path)
+    if path:
+        logger.debug('Config file not found at %s; skipping', path)
     return None
 
 
@@ -150,4 +167,6 @@ def merge_configs(parts: list[OmegaConf]) -> OmegaConf:
     Returns:
         OmegaConf: The merged configuration object.
     """
+    if not parts:
+        logger.warning('No config parts found; using empty config')
     return OmegaConf.merge(*parts) if parts else OmegaConf.create({})

src/pkg_infra/logger.py

@@ -43,10 +43,13 @@ def update_log_filenames_with_timestamp(
     """
     if timestamp is None:
         timestamp = datetime.datetime.utcnow().strftime('%Y%m%d%H%M%S')
+    logger.debug('Updating log filenames with timestamp: %s', timestamp)
 
     def update_filename(filename: str) -> str:
         base, ext = os.path.splitext(filename)
-        return f'{base}_{timestamp}{ext}'
+        updated = f'{base}_{timestamp}{ext}'
+        logger.debug('Updated log filename: %s -> %s', filename, updated)
+        return updated
 
     def recursive_update(d: object) -> None:
         if isinstance(d, dict):
@@ -78,8 +81,10 @@ def configure_loggers_from_omegaconf(
         return
 
     if 'logging' not in merged_config:
+        logger.error("No 'logging' section found in config.")
         raise ValueError("No 'logging' section found in config.")
 
+    logger.info('Configuring logging from merged configuration')
     # Always convert to a pure dict (resolves all OmegaConf nodes)
     log_cfg = OmegaConf.to_container(
         merged_config['logging'], resolve=True, structured_config_mode='dict'
@@ -107,6 +112,9 @@ def configure_loggers_from_omegaconf(
             filename = handler.get('filename')
             if filename:
                 Path(filename).parent.mkdir(parents=True, exist_ok=True)
+                logger.debug(
+                    'Ensured log directory exists: %s', Path(filename).parent
+                )
 
     # Create the loggers listed in the config file
     dictConfig(log_cfg)

src/pkg_infra/schema.py

@@ -73,12 +73,13 @@ def validate_settings(
     Returns True when valid. Raises ValidationError if invalid.
     """
     data = config
+    _logger.debug('Validating settings schema')
     if OmegaConf is not None and OmegaConf.is_config(config):
         data = OmegaConf.to_container(config, resolve=True)
 
     try:
         validated = Settings.model_validate(data)
-        _logger.info('Valid schema: True')
+        _logger.debug('Valid schema: True')
         if show:
             _logger.info(validated)
         return True

src/pkg_infra/session.py

@@ -177,11 +177,13 @@ def _get_location(timeout: float = 3.0) -> str | None:
 
 def _get_configuration() -> object:
     """Load and return the merged configuration using ConfigLoader."""
+    logger.debug('Loading configuration via ConfigLoader')
     return ConfigLoader.load_config()
 
 
 def _get_app_logger(merged_config: object) -> logging.Logger:
     """Get the application logger from the merged configuration object."""
+    logger.debug('Using app logger: %s', merged_config.app.logger)
     return logging.getLogger(merged_config.app.logger)
 
 
@@ -198,6 +200,11 @@ def get_session(
         A Session object representing the current session.
     """
     global _current_session
+    logger.debug(
+        'get_session called with workspace=%s, include_location=%s',
+        workspace,
+        include_location,
+    )
     logger.info('Initialization of a session:')
     if _current_session is not None:
         logger.info('Reusing existing session')
@@ -219,7 +226,17 @@ def get_session(
             process_id = _get_process_id()
             now_utc, now_local = _get_time()
             timezone = _get_timezone(now_local)
-            location = _get_location() if include_location else None
+            logger.debug(
+                'Session time initialized: utc=%s, local=%s, timezone=%s',
+                now_utc,
+                now_local,
+                timezone,
+            )
+            if include_location:
+                location = _get_location()
+            else:
+                logger.debug('Location lookup skipped')
+                location = None
 
             logger.info('Creating new session...')