Class Content

src/textual/content.py:133–1718

Text content with marked up spans. This object can be considered immutable, although it might update its internal state in a way that is consistent with immutability.

@rich.repr.auto
@total_ordering
class Content(Visual):
    """Text content with marked up spans.

    This object can be considered immutable, although it might update its internal state
    in a way that is consistent with immutability.

    """

    __slots__ = ["_text", "_spans", "_cell_length"]

    _NORMALIZE_TEXT_ALIGN = {"start": "left", "end": "right", "justify": "full"}

    def __init__(
        self,
        text: str = "",
        spans: list[Span] | None = None,
        cell_length: int | None = None,
        strip_control_codes: bool = True,
    ) -> None:
        """
        Initialize a Content object.

        Args:
            text: text content.
            spans: Optional list of spans.
            cell_length: Cell length of text if known, otherwise `None`.
            strip_control_codes: Strip control codes that may break output?
        """

        self._text: str = (
            _strip_control_codes(text) if strip_control_codes and text else text
        )
        self._spans: list[Span] = [] if spans is None else spans
        self._cell_length = cell_length
        self._optimal_width_cache: int | None = None
        self._minimal_width_cache: int | None = None
        self._height_cache: tuple[tuple[int, str, bool] | None, int] = (None, 0)
        self._divide_cache: (
            FIFOCache[Sequence[int], list[tuple[Span, int, int]]] | None
        ) = None
        self._split_cache: FIFOCache[tuple[str, bool, bool], list[Content]] | None = (
            None
        )
        # If there are 1 or 0 spans, it can't be simplified further
        self._simplified = len(self._spans) <= 1

    def __str__(self) -> str:
        return self._text

    @property
    def _is_regular(self) -> bool:
        """Check if the line is regular (spans.end > span.start for all spans).

        This is a debugging aid, and unlikely to be useful in your app.

        Returns:
            `True` if the content is regular, `False` if it is not (and broken).
        """