Skip to content

Console

🤖 AI-Generated Content

This documentation was generated with AI assistance and is still being audited. Some, or potentially a lot, of this information may be inaccurate. Learn more.

provide.foundation.streams.console

Classes

Functions

get_console_stream 

get_console_stream() -> TextIO

Get the appropriate console stream for output.

Source code in provide/foundation/streams/console.py 
23
24
25
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 
28
29
30
31
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 
34
35
36
37
38
39
40
41
42
43
44
45
def supports_color() -> bool:
    """Check if the current stream supports color output."""
    config = StreamConfig.from_env()

    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 
 48
 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
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
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 UnicodeEncodeError:
        # Stream cannot encode the message (e.g., emoji on Windows cp1252).
        # Encode to UTF-8 with replacement and decode back to get safe text.
        safe_message = message.encode("utf-8", errors="replace").decode("ascii", errors="replace")
        try:
            target_stream.write(safe_message)
            target_stream.flush()
        except Exception:
            # Last resort: write to stderr
            sys.stderr.write(safe_message)
            sys.stderr.flush()
        return
    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()