Make formatted_text.split_lines accept an iterable (type annotation o…

…nly).
prompt-toolkit · Dec 12, 2023 · 8c8840c · 8c8840c
1 parent 55cde3e
commit 8c8840c
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/src/prompt_toolkit/formatted_text/__init__.py b/src/prompt_toolkit/formatted_text/__init__.py
@@ -16,6 +16,7 @@
 from .base import (
     AnyFormattedText,
     FormattedText,
+    OneStyleAndTextTuple,
     StyleAndTextTuples,
     Template,
     is_formatted_text,
@@ -35,6 +36,7 @@
 __all__ = [
     # Base.
     "AnyFormattedText",
+    "OneStyleAndTextTuple",
     "to_formatted_text",
     "is_formatted_text",
     "Template",

diff --git a/src/prompt_toolkit/formatted_text/utils.py b/src/prompt_toolkit/formatted_text/utils.py
@@ -72,13 +72,15 @@ def fragment_list_to_text(fragments: StyleAndTextTuples) -> str:
     return "".join(item[1] for item in fragments if ZeroWidthEscape not in item[0])
 
 
-def split_lines(fragments: StyleAndTextTuples) -> Iterable[StyleAndTextTuples]:
+def split_lines(
+    fragments: Iterable[OneStyleAndTextTuple],
+) -> Iterable[StyleAndTextTuples]:
     """
     Take a single list of (style_str, text) tuples and yield one such list for each
     line. Just like str.split, this will yield at least one item.
 
-    :param fragments: List of (style_str, text) or (style_str, text, mouse_handler)
-                      tuples.
+    :param fragments: Iterable of ``(style_str, text)`` or
+        ``(style_str, text, mouse_handler)`` tuples.
     """
     line: StyleAndTextTuples = []