Added print_container utility.

Author: jonathanslenders

examples/print-text/print-frame.py

@@ -0,0 +1,11 @@
+#!/usr/bin/env python
+"""
+Example usage of 'print_container', a tool to print
+any layout in a non-interactive way.
+"""
+from prompt_toolkit.shortcuts import print_container
+from prompt_toolkit.widgets import Frame, TextArea
+
+
+print_container(
+ Frame(TextArea(text='Hello world!')))

prompt_toolkit/shortcuts/__init__.py

@@ -1,7 +1,7 @@
 from __future__ import unicode_literals
 from .dialogs import yes_no_dialog, button_dialog, input_dialog, message_dialog, radiolist_dialog, progress_dialog
 from .prompt import PromptSession, prompt, confirm, create_confirm_session, CompleteStyle
-from .utils import print_formatted_text, clear, set_title, clear_title
+from .utils import print_formatted_text, print_container, clear, set_title, clear_title
 from .progress_bar import ProgressBar
 
 

prompt_toolkit/shortcuts/utils.py

@@ -1,5 +1,8 @@
 from __future__ import unicode_literals, print_function
+from prompt_toolkit.application import Application
+from prompt_toolkit.eventloop import get_event_loop
 from prompt_toolkit.formatted_text import to_formatted_text
+from prompt_toolkit.layout import Layout
 from prompt_toolkit.output import Output, ColorDepth
 from prompt_toolkit.output.defaults import create_output, get_default_output
 from prompt_toolkit.renderer import print_formatted_text as renderer_print_formatted_text
@@ -8,6 +11,7 @@
 
 __all__ = [
  'print_formatted_text',
+ 'print_container',
  'clear',
  'set_title',
  'clear_title',
@@ -121,6 +125,27 @@ def to_text(val):
  output.flush()
 
 
+def print_container(container):
+ """
+ Print any layout to the output in a non-interactive way.
+
+ Example usage::
+
+ from prompt_toolkit.widgets import Frame, TextArea
+ print_container(
+ Frame(TextArea(text='Hello world!')))
+ """
+ def exit_immediately():
+ # Use `call_from_executor` to exit "soon", so that we still render one
+ # initial time, before exiting the application.
+ get_event_loop().call_from_executor(
+ lambda: app.exit())
+
+ app = Application(
+ layout=Layout(container=container))
+ app.run(pre_run=exit_immediately)
+
+
 def clear():
  """
  Clear the screen.