Skip to content

Console

provide.foundation.streams.console

TODO: Add module docstring.

Functions

get_console_stream 

get_console_stream() -> TextIO

Get the appropriate console stream for output.

Source code in provide/foundation/streams/console.py 
24
25
26
def get_console_stream() -> TextIO:
    """Get the appropriate console stream for output."""
    return get_log_stream()

is_tty 

is_tty() -> bool

Check if the current stream is a TTY (terminal).

Source code in provide/foundation/streams/console.py 
29
30
31
32
def is_tty() -> bool:
    """Check if the current stream is a TTY (terminal)."""
    stream = get_log_stream()
    return hasattr(stream, "isatty") and stream.isatty()

supports_color 

supports_color() -> bool

Check if the current stream supports color output.

Source code in provide/foundation/streams/console.py 
35
36
37
38
39
40
41
42
43
44
45
46
def supports_color() -> bool:
    """Check if the current stream supports color output."""
    config = get_stream_config()

    if config.no_color:
        return False

    if config.force_color:
        return True

    # Check if we're in a TTY
    return is_tty()

write_to_console 

write_to_console(
    message: str,
    stream: TextIO | None = None,
    log_fallback: bool = True,
) -> None

Write a message to the console stream.

Parameters:

Name Type Description Default
message str

Message to write

 required
stream TextIO | None

Optional specific stream to write to, defaults to current console stream

 None
log_fallback bool

Whether to log when falling back to stderr

 True
Source code in provide/foundation/streams/console.py 
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
def write_to_console(message: str, stream: TextIO | None = None, log_fallback: bool = True) -> None:
    """Write a message to the console stream.

    Args:
        message: Message to write
        stream: Optional specific stream to write to, defaults to current console stream
        log_fallback: Whether to log when falling back to stderr

    """
    target_stream = stream or get_console_stream()
    try:
        target_stream.write(message)
        target_stream.flush()
    except Exception as e:
        # Log the fallback for debugging if requested
        if log_fallback:
            try:
                from provide.foundation.hub.foundation import get_foundation_logger

                get_foundation_logger().debug(
                    "Console write failed, falling back to stderr",
                    error=str(e),
                    error_type=type(e).__name__,
                    stream_type=type(target_stream).__name__,
                )
            except Exception as log_error:
                # Foundation logger failed, fall back to direct stderr logging
                try:
                    sys.stderr.write(
                        f"[DEBUG] Console write failed (logging also failed): "
                        f"{e.__class__.__name__}: {e} (log_error: {log_error.__class__.__name__})\n"
                    )
                    sys.stderr.flush()
                except Exception:
                    # Even stderr failed - this is a critical system failure, we cannot continue
                    raise RuntimeError(
                        "Critical system failure: unable to write debug information to any stream"
                    ) from e

        # Fallback to stderr - if this fails, let it propagate
        sys.stderr.write(message)
        sys.stderr.flush()