Add examples of prompt_toolkit

cli/rprompt.py

@@ -0,0 +1,54 @@
+#!/usr/bin/env python
+"""
+Example of a right prompt. This is an additional prompt that is displayed on
+the right side of the terminal. It will be hidden automatically when the input
+is long enough to cover the right side of the terminal.
+
+This is similar to RPROMPT is Zsh.
+"""
+import time
+from prompt_toolkit import prompt
+from prompt_toolkit.formatted_text import ANSI, HTML
+from prompt_toolkit.styles import Style
+
+example_style = Style.from_dict(
+    {
+        # The 'rprompt' gets by default the 'rprompt' class. We can use this
+        # for the styling.
+        "rprompt": "bg:#D08770 #ffffff",
+    }
+)
+
+
+def get_rprompt_text():
+    return [
+        ("", "  "),
+        ("underline", f"{time.ctime()}"),
+        ("", "  "),
+    ]
+
+
+def main():
+    # Option 1: pass a string to 'rprompt':
+    answer = prompt("> ", rprompt=" <rprompt> ", style=example_style)
+    print(f"You said: {answer}")
+
+    # Option 2: pass HTML:
+    answer = prompt("> ", rprompt=HTML(" <u>&lt;rprompt&gt;</u> "), style=example_style)
+    print(f"You said: {answer}")
+
+    # Option 3: pass ANSI:
+    answer = prompt(
+        "> ", rprompt=ANSI(" \x1b[4m<rprompt>\x1b[0m "), style=example_style
+    )
+    print(f"You said: {answer}")
+
+    # Option 4: Pass a callable. (This callable can either return plain text,
+    #           an HTML object, an ANSI object or a list of (style, text)
+    #           tuples.
+    answer = prompt("> ", rprompt=get_rprompt_text, style=example_style, refresh_interval=1)
+    print(f"You said: {answer}")
+
+
+if __name__ == "__main__":
+    main()