Function test_styled_completion_sort

tests/test_completion.py:985–1020

Test that sorting is done with the display_plain field.

()

def test_styled_completion_sort() -> None:
    """Test that sorting is done with the display_plain field."""

    # First sort with strings that include ANSI style sequences.
    red_apple = "\x1b[31mApple\x1b[0m"
    green_cherry = "\x1b[32mCherry\x1b[0m"
    blue_banana = "\x1b[34mBanana\x1b[0m"

    # This sorts by ASCII: [31m (Red), [32m (Green), [34m (Blue)
    unsorted_strs = [blue_banana, red_apple, green_cherry]
    sorted_strs = sorted(unsorted_strs, key=utils.DEFAULT_STR_SORT_KEY)
    assert sorted_strs == [red_apple, green_cherry, blue_banana]

    # Now create a Completions object with these values.
    unsorted_items = [
        CompletionItem("banana", display=blue_banana),
        CompletionItem("cherry", display=green_cherry),
        CompletionItem("apple", display=red_apple),
    ]

    completions = Completions(unsorted_items)

    # Expected order: Apple (A), Banana (B), Cherry (C)
    expected_plain = ["Apple", "Banana", "Cherry"]
    expected_styled = [red_apple, blue_banana, green_cherry]

    for index, item in enumerate(completions):
        # Prove the ANSI stripping worked correctly
        assert item.display_plain == expected_plain[index]

        # Prove the sort order used the plain text, not the ANSI codes
        assert item.display == expected_styled[index]

    # Prove the order of completions is not the same as the raw string sort order
    completion_displays = [item.display for item in completions]
    assert completion_displays != sorted_strs


# Used by redirect_complete tests