boofun.utils.logging

Logging utilities for the BooFun library.

This module provides a consistent logging interface for the library, enabling users to configure debug logging for troubleshooting.

Usage:

import logging

# Enable debug logging for BooFun logging.getLogger(“boofun”).setLevel(logging.DEBUG) logging.getLogger(“boofun”).addHandler(logging.StreamHandler())

# Or use the convenience function from boofun.utils.logging import enable_debug_logging enable_debug_logging()

Functions

enable_debug_logging([level, format_string])	Enable debug logging for the BooFun library.
get_logger(name)	Get a logger for a specific BooFun submodule.

boofun.utils.logging.enable_debug_logging(level: int = 10, format_string: str | None = None) → None

Enable debug logging for the BooFun library.

This is a convenience function for users who want to see detailed logging output for debugging purposes.

Parameters:

• level – Logging level (default: DEBUG)

• format_string – Custom format string (default: timestamp, level, name, message)

Example

>>> from boofun.utils.logging import enable_debug_logging
>>> enable_debug_logging()
>>> # Now BooFun will log debug messages

boofun.utils.logging.get_logger(name: str) → Logger

Get a logger for a specific BooFun submodule.

Parameters:

name – Submodule name (e.g., “core.base”, “analysis.fourier”)

Returns:

Logger instance