Skip to content

logger ¤

Logging utilities.

Functions:

configure_logging ¤

configure_logging(
    level: str,
    path: str | Path | None = None,
    *,
    include: tuple[str, ...] = (),
    exclude: tuple[str, ...] = (),
    downgrade: tuple[str, ...] = ()
) -> None

Configure logging.

Parameters:

  • level (str) –

    Log level (name).

  • path (str | Path | None, default: None ) –

    Log file path.

  • include (tuple[str, ...], default: () ) –

    List of package names for which to show logs.

  • exclude (tuple[str, ...], default: () ) –

    List of package names for which to hide logs.

  • downgrade (tuple[str, ...], default: () ) –

    List of package names for which to allow log levels greater or equal to INFO level. Packages that are downgraded will see all their INFO logs demoted to DEBUG level. If unspecified, downgrade every dependency.

double_brackets ¤

double_brackets(message: str) -> str

Double { and } in log messages to prevent formatting errors.

Parameters:

  • message (str) –

    The message to transform.

Returns:

  • str –

    The updated message.

log_captured ¤

log_captured(
    text: str, level: str = "info", pkg: str | None = None
) -> None

Log captured text.

Parameters:

  • text (str) –

    The text to split and log.

  • level (str, default: 'info' ) –

    The log level to use.

  • pkg (str | None, default: None ) –

    Extra pkg log metadata.

redirect_output_to_logging ¤

redirect_output_to_logging(
    stdout_level: str = "info", stderr_level: str = "error"
) -> Iterator[None]

Redirect standard output and error to logging.

Parameters:

  • stdout_level (str, default: 'info' ) –

    Log level for standard output.

  • stderr_level (str, default: 'error' ) –

    Log level for standard error.

run ¤

run(*args: str | Path, **kwargs: Any) -> str

Run a subprocess, log its standard output and error, return its output.

Parameters:

  • *args (str | Path, default: () ) –

    Command line arguments.

  • **kwargs (Any, default: {} ) –

    Additional arguments to subprocess.Popen.

Returns:

  • str –

    The process standard output.

tail ¤

tail(log_file: str) -> None

Tail a log file.

Parameters:

  • log_file (str) –

    The log file to tail.