setup_logger
Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the Habitat Guide and Python API guide (v2.0) for usage.
- setup_logger(name: str, output_dir: Path | None = None, log_filename: str = 'processing.log', level: int = 20, console_level: int | None = None) Logger[source]
Setup a logger for a HABIT module or script.
This is the main entry point for setting up logging in HABIT applications.
- Parameters:
name – Name of the module/script (e.g., ‘preprocessing’, ‘habitat’)
output_dir – Directory where log file will be created. If None, only console logging.
log_filename – Name of the log file (default: ‘processing.log’)
level – Logging level for file output (default: INFO)
console_level – Logging level for console. If None, uses same as level.
- Returns:
Configured logger instance
- Return type: