Added to_plain_text utility. A function to turn formatted text into a string.

Author: jonathanslenders

prompt_toolkit/formatted_text/__init__.py

@@ -27,6 +27,7 @@
  fragment_list_to_text,
  fragment_list_width,
  split_lines,
+ to_plain_text,
 )
 
 __all__ = [
@@ -49,4 +50,5 @@
  "fragment_list_width",
  "fragment_list_to_text",
  "split_lines",
+ "to_plain_text",
 ]

prompt_toolkit/formatted_text/utils.py

@@ -8,16 +8,29 @@
 
 from prompt_toolkit.utils import get_cwidth
 
-from .base import OneStyleAndTextTuple, StyleAndTextTuples
+from .base import (
+ AnyFormattedText,
+ OneStyleAndTextTuple,
+ StyleAndTextTuples,
+ to_formatted_text,
+)
 
 __all__ = [
+ "to_plain_text",
  "fragment_list_len",
  "fragment_list_width",
  "fragment_list_to_text",
  "split_lines",
 ]
 
 
+def to_plain_text(value: AnyFormattedText) -> str:
+ """
+ Turn any kind of formatted text back into plain text.
+ """
+ return fragment_list_to_text(to_formatted_text(value))
+
+
 def fragment_list_len(fragments: StyleAndTextTuples) -> int:
  """
  Return the amount of characters in this text fragment list.