utils.configure_logging()

Configure the seapig package logger.

Usage

Source

utils.configure_logging(
    level="WARNING",
    handler=None,
)

Sets the log level and attaches handler (or a logging.StreamHandler writing to stderr when None) to the "seapig" logger. Any previously attached handlers are removed first.

The SEAPIG_LOG_LEVEL environment variable, when set, overrides the level parameter.

Parameters

level: str | int = "WARNING"

Minimum log level, e.g. "INFO", "DEBUG", or an integer constant such as logging.INFO. Defaults to "WARNING".

handler: logging.Handler | None = None

A custom logging.Handler. When None a logging.StreamHandler (stderr) with a simple formatter is used.

Examples

>>> import logging
>>> from seapig.utils.logging import configure_logging
>>> configure_logging(level="INFO")