Function expect_prefixed_markdown

e2e_playwright/shared/app_utils.py:712–757

Find the markdown with the prefix and then ensure that the `expected_markdown` is in the text as well. Splitting it into a `filter` and a `to_have_text` check has the advantage that we see the diff in case of a mismatch; this would not be the case if we just used the `filter`.

(
    locator: FrameLocator | Locator | Page,
    expected_prefix: str,
    expected_markdown: str | re.Pattern[str],
    exact_match: bool = False,
)

def expect_prefixed_markdown(
    locator: FrameLocator | Locator | Page,
    expected_prefix: str,
    expected_markdown: str | re.Pattern[str],
    exact_match: bool = False,
) -> None:
    """Find the markdown with the prefix and then ensure that the
    `expected_markdown` is in the text as well.

    Splitting it into a `filter` and a `to_have_text` check has the advantage
    that we see the diff in case of a mismatch; this would not be the case if we
    just used the `filter`.

    Only one markdown-element must be returned, otherwise an error is thrown.

    Parameters
    ----------
    locator : Locator
        The locator to search for the markdown element.

    expected_prefix : str
        The prefix of the markdown element.

    expected_markdown : str or Pattern[str]
        The markdown content that should be found. If a pattern is provided,
        the text will be matched against this pattern.

    exact_match : bool, optional
        Whether the markdown should exactly match the `expected_markdown`, by default True.
        Otherwise, the `expected_markdown` must be contained in the markdown content.

    """
    selection_text = locator.get_by_test_id("stMarkdownContainer").filter(
        has_text=expected_prefix
    )
    if exact_match:
        text_to_match: str | re.Pattern[str]
        if isinstance(expected_markdown, re.Pattern):
            # Recompile the pattern with the prefix:
            text_to_match = re.compile(f"{expected_prefix} {expected_markdown.pattern}")
        else:
            text_to_match = f"{expected_prefix} {expected_markdown}"

        expect(selection_text).to_have_text(text_to_match)
    else:
        expect(selection_text).to_contain_text(expected_markdown)


def expect_markdown(