Complete refactoring of the layout engine.

- prompt_toolkit.layout now has a list of containers (HSplit, VSplit, FloatContainer) as well as a list of controls (TokenListControl, BufferControl) in order to design much more complex layouts. - All examples are refactored to understand the new layout definitions. - prompt_toolkit.contrib.shortcuts.get_input has been extended.

Author: jonathanslenders

examples/asyncio-prompt.py

@@ -18,9 +18,8 @@
  sys.stdout = cli.stdout_proxy()
 """
 from __future__ import unicode_literals
-from prompt_toolkit import CommandLineInterface, AbortAction, Exit, Abort
-from prompt_toolkit.layout.prompt import DefaultPrompt
-from prompt_toolkit.layout import Layout
+from prompt_toolkit import AbortAction, Exit, Abort
+from prompt_toolkit.contrib.shortcuts import create_cli
 
 from pygments.style import Style
 from pygments.token import Token
@@ -56,9 +55,7 @@ def interactive_shell():
  Coroutine that shows the interactive command line.
  """
  # Create interface. (style/layout is only for demonstration.)
- cli = CommandLineInterface(
- layout=Layout(before_input=DefaultPrompt(text='Say something inside the event loop: ')),
- style=TestStyle)
+ cli = create_cli('Say something inside the event loop: ')
 
  # Patch stdout in something that will always print *above* the prompt when
  # something is written to stdout.

examples/autocompletion.py

@@ -9,12 +9,8 @@
 """
 from __future__ import unicode_literals
 
-from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.buffer import Buffer
-from prompt_toolkit.layout import Layout
-from prompt_toolkit.layout.prompt import DefaultPrompt
-from prompt_toolkit.layout.menus import CompletionsMenu
 from prompt_toolkit.contrib.completers import WordCompleter
+from prompt_toolkit.contrib.shortcuts import get_input
 
 from pygments.token import Token
 from pygments.style import Style
@@ -66,16 +62,8 @@ class AnimalStyle(Style):
 
 
 def main():
- cli = CommandLineInterface(
- style=AnimalStyle,
- layout=Layout(before_input=DefaultPrompt('Give some animals: '),
- menus=[CompletionsMenu()]),
- buffer=Buffer(completer=animal_completer),
- create_async_autocompleters=True)
-
- print('Press tab to complete')
- code_obj = cli.read_input()
- print('You said: ' + code_obj.text)
+ text = get_input('Give some animals: ', completer=animal_completer, style=AnimalStyle)
+ print('You said: %s' % text)
 
 
 if __name__ == '__main__':

examples/clock-input.py

@@ -3,25 +3,32 @@
 Example of a 'dynamic' prompt. On that shows the current time in the prompt.
 """
 from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.layout import Layout
-from prompt_toolkit.layout.prompt import Prompt
+from prompt_toolkit.layout import Window
+from prompt_toolkit.layout.controls import BufferControl
+from prompt_toolkit.layout.processors import Processor
+from prompt_toolkit.layout.utils import token_list_len
 from pygments.token import Token
 
 import datetime
 import time
 
 
-class ClockPrompt(Prompt):
- def tokens(self, cli):
+class ClockPrompt(Processor):
+ def run(self, cli, buffer, tokens):
  now = datetime.datetime.now()
- return [
+ before = [
  (Token.Prompt, '%s:%s:%s' % (now.hour, now.minute, now.second)),
  (Token.Prompt, ' Enter something: ')
  ]
 
+ return before + tokens, lambda i: i + token_list_len(before)
+
+ def invalidation_hash(self, cli, buffer):
+ return datetime.datetime.now()
+
 
 def main():
- cli = CommandLineInterface(layout=Layout(before_input=ClockPrompt()))
+ cli = CommandLineInterface(layout=Window(BufferControl(input_processors=[ClockPrompt()])))
 
  def on_read_start():
  """

examples/custom-key-binding.py

@@ -25,6 +25,10 @@ def _(event):
  """
  (Useless, but for demoing.)
  Typing 'xy' will insert 'z'.
+
+ Note that when you type for instance 'xa', the insertion of 'x' is
+ postponed until the 'a' is typed. because we don't know earlier whether
+ or not a 'y' will follow.
  """
  event.cli.current_buffer.insert_text('z')
 

examples/html-input.py

@@ -4,18 +4,12 @@
 """
 from pygments.lexers import HtmlLexer
 
-from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.layout import Layout
-from prompt_toolkit.layout.prompt import DefaultPrompt
+from prompt_toolkit.contrib.shortcuts import get_input
 
 
 def main():
- cli = CommandLineInterface(layout=Layout(
- before_input=DefaultPrompt('Enter HTML: '),
- lexer=HtmlLexer))
-
- html_code_obj = cli.read_input()
- print('You said: ' + html_code_obj.text)
+ text = get_input('Enter HTML: ', lexer=HtmlLexer)
+ print('You said: ' + text)
 
 
 if __name__ == '__main__':

examples/input-validation.py

@@ -1,26 +1,16 @@
 #!/usr/bin/env python
 """
-Simple example of the layout options.
+Simple example of input validation.
 """
 from __future__ import unicode_literals
 
-from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.layout import Layout
-from prompt_toolkit.layout.prompt import DefaultPrompt
-from prompt_toolkit.layout.toolbars import ValidationToolbar
 from prompt_toolkit.validation import Validator, ValidationError
-from prompt_toolkit.buffer import Buffer
+from prompt_toolkit.contrib.shortcuts import get_input
 
 from pygments.token import Token
 from pygments.style import Style
 
 
-layout = Layout(
- before_input=DefaultPrompt(text='Give an e-mail address: '),
- bottom_toolbars=[ValidationToolbar()]
-)
-
-
 class EmailValidator(Validator):
  def validate(self, document):
  if '@' not in document.text:
@@ -34,14 +24,8 @@ class TestStyle(Style):
 
 
 def main():
- cli = CommandLineInterface(
- layout=layout,
- style=TestStyle,
- buffer=Buffer(validator=EmailValidator()))
-
- document = cli.read_input()
- print('You said: ' + document.text)
-
+ text = get_input('Enter e-mail address: ', validator=EmailValidator(), style=TestStyle)
+ print('You said: %s' % text)
 
 if __name__ == '__main__':
  main()