Back to Repositories

Testing LiveRender Terminal Output Management in Textualize/rich

This test suite validates the LiveRender component in Rich, focusing on cursor positioning, rendering, and style handling. It ensures proper terminal output manipulation and console rendering functionality.

Test Coverage Overview

The test suite provides comprehensive coverage of LiveRender’s core functionality.

Renderable content management and updates
Cursor positioning and restoration
Console rendering with style applications
Terminal dimension handling

Implementation Analysis

The testing approach utilizes pytest fixtures for consistent LiveRender instance management. Tests employ direct assertions for string content validation and complex console rendering scenarios.

Fixture-based test setup
ANSI escape sequence validation
Style parsing verification
Console dimension configurations

Technical Details

Testing Framework: pytest
Key Components: LiveRender, Console, ConsoleDimensions
Style Management: Rich Style parsing
Terminal Control: ANSI escape sequences
Console Options: Encoding, dimensions, terminal capabilities

Best Practices Demonstrated

The test suite exemplifies strong testing practices through isolated test cases and comprehensive functionality coverage.

Fixture usage for setup consistency
Explicit state verification
Edge case handling for terminal dimensions
Component isolation in test cases

textualize/rich

tests/test_live_render.py

            
import pytest
from rich.live_render import LiveRender
from rich.console import Console, ConsoleDimensions, ConsoleOptions
from rich.style import Style
from rich.segment import Segment


@pytest.fixture
def live_render():
    return LiveRender(renderable="my string")


def test_renderable(live_render):
    assert live_render.renderable == "my string"
    live_render.set_renderable("another string")
    assert live_render.renderable == "another string"


def test_position_cursor(live_render):
    assert str(live_render.position_cursor()) == ""
    live_render._shape = (80, 2)
    assert str(live_render.position_cursor()) == "\r\x1b[2K\x1b[1A\x1b[2K"


def test_restore_cursor(live_render):
    assert str(live_render.restore_cursor()) == ""
    live_render._shape = (80, 2)
    assert str(live_render.restore_cursor()) == "\r\x1b[1A\x1b[2K\x1b[1A\x1b[2K"


def test_rich_console(live_render):
    options = ConsoleOptions(
        ConsoleDimensions(80, 25),
        max_height=25,
        legacy_windows=False,
        min_width=10,
        max_width=20,
        is_terminal=False,
        encoding="utf-8",
    )
    rich_console = live_render.__rich_console__(Console(), options)
    assert [Segment("my string", None)] == list(rich_console)
    live_render.style = "red"
    rich_console = live_render.__rich_console__(Console(), options)
    assert [Segment("my string", Style.parse("red"))] == list(rich_console)