Whole refactoring.

 - A lot of refactoring in the layout. The Prompt class became Layout. - Over the whole project, parametrization of objects happens through the constructor.

Author: jonathanslenders

examples/autocompletion.py

@@ -10,14 +10,17 @@
 from __future__ import unicode_literals
 
 from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.code import Code, Completion
+from prompt_toolkit.completion import Completer, Completion
 from prompt_toolkit.line import Line
+from prompt_toolkit.layout import Layout
+from prompt_toolkit.layout.prompt import DefaultPrompt
+from prompt_toolkit.layout.menus import CompletionMenu
 
 from pygments.token import Token
 from pygments.style import Style
 
 
-class AnimalCode(Code):
+class AnimalCompleter(Completer):
  animals = [
  'alligator',
  'ant',
@@ -53,8 +56,15 @@ class AnimalCode(Code):
  'turtle',
  ]
 
- def get_completions(self):
- word_before_cursor = self.document.get_word_before_cursor()
+ def complete_after_insert_text(self, document):
+ """
+ Open completion menu when we type a character.
+ (Except if we typed whitespace.)
+ """
+ return not document.char_before_cursor.isspace()
+
+ def get_completions(self, document):
+ word_before_cursor = document.get_word_before_cursor()
 
  for a in self.animals:
  if a.startswith(word_before_cursor):
@@ -70,23 +80,12 @@ class AnimalStyle(Style):
  }
 
 
-class AnimalLine(Line):
- def complete_after_insert_text(self):
- """
- Open completion menu when we type a character.
- (Except if we typed whitespace.)
- """
- return not self.document.char_before_cursor.isspace()
-
-
-class AnimalCLI(CommandLineInterface):
- code_factory = AnimalCode
- line_factory = AnimalLine
- style = AnimalStyle
-
-
 def main():
- cli = AnimalCLI()
+ cli = CommandLineInterface(style=AnimalStyle,
+ layout=Layout(before_input=DefaultPrompt('Give some animals: '),
+ menus=[CompletionMenu()]),
+ line=Line(completer=AnimalCompleter())
+ )
 
  print('Press tab to complete')
  code_obj = cli.read_input()

examples/clock-input.py

@@ -3,26 +3,25 @@
 Example of a 'dynamic' prompt. On that shows the current time in the prompt.
 """
 from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.prompt import Prompt
+from prompt_toolkit.layout import Layout
+from prompt_toolkit.layout.prompt import Prompt
 from pygments.token import Token
 
 import datetime
 import time
 
 
 class ClockPrompt(Prompt):
- def get_tokens_before_input(self):
+ def tokens(self, cli):
  now = datetime.datetime.now()
  return [
  (Token.Prompt, '%s:%s:%s' % (now.hour, now.minute, now.second)),
  (Token.Prompt, ' Enter something: ')
  ]
 
 
-class ClockCLI(CommandLineInterface):
- prompt_factory = ClockPrompt
- enable_concurency = True
 
+class ClockCLI(CommandLineInterface):
  def on_read_input_start(self):
  self.run_in_executor(self._clock_update)
 
@@ -34,7 +33,7 @@ def _clock_update(self):
 
 
 def main():
- cli = ClockCLI()
+ cli = ClockCLI(layout=Layout(before_input=ClockPrompt()))
 
  code_obj = cli.read_input()
  print('You said: ' + code_obj.text)

examples/get-password.py

@@ -4,5 +4,5 @@
 
 
 if __name__ == '__main__':
- password = get_input('Give me some input: ', is_password=True)
+ password = get_input('Password: ', is_password=True)
  print('You said: %s' % password)

examples/html-input.py

@@ -5,25 +5,14 @@
 from pygments.lexers import HtmlLexer
 
 from prompt_toolkit import CommandLineInterface
-from prompt_toolkit.code import Code
-from prompt_toolkit.prompt import Prompt
-
-
-class HtmlCode(Code):
- lexer = HtmlLexer
-
-
-class HtmlPrompt(Prompt):
- prompt_text = 'Enter HTML: '
-
-
-class HtmlCLI(CommandLineInterface):
- code_factory = HtmlCode
- prompt_factory = HtmlPrompt
+from prompt_toolkit.layout import Layout
+from prompt_toolkit.layout.prompt import DefaultPrompt
 
 
 def main():
- cli = HtmlCLI()
+ cli = CommandLineInterface(layout=Layout(
+ before_input=DefaultPrompt('Enter HTML: '),
+ lexer=HtmlLexer))
 
  html_code_obj = cli.read_input()
  print('You said: ' + html_code_obj.text)

examples/input-validation.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+"""
+Simple example of the layout options.
+"""
+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.line import Line
+
+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:
+ raise ValidationError(message='Not a valid e-mail address')
+
+
+class TestLine(Line):
+ is_multiline = True
+
+
+class TestStyle(Style):
+ styles = {
+ Token.ValidationToolbar: 'bg:#aa0000 #ffbbbb',
+ }
+
+
+def main():
+ cli = CommandLineInterface(layout=layout, style=TestStyle, line=Line(validator=EmailValidator()))
+
+ document = cli.read_input()
+ print('You said: ' + document.text)
+
+
+if __name__ == '__main__':
+ main()

examples/layout-test.py

@@ -0,0 +1,97 @@
+#!/usr/bin/env python
+"""
+Simple example of the layout options.
+"""
+from __future__ import unicode_literals
+
+from prompt_toolkit import CommandLineInterface
+from prompt_toolkit.layout import Layout
+from prompt_toolkit.layout.prompt import DefaultPrompt, Prompt
+from prompt_toolkit.layout.margins import LeftMarginWithLineNumbers
+from prompt_toolkit.layout.menus import CompletionMenu
+from prompt_toolkit.layout.toolbars import TextToolbar, ArgToolbar, SearchToolbar, CompletionToolbar
+from prompt_toolkit.line import Line
+from prompt_toolkit.completion import Completion, Completer
+
+from pygments.token import Token
+from pygments.style import Style
+
+
+lipsum = """This is the input:
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer blandit
+elementum ante, vel fermentum massa fermentum vitae. Nulla ornare egestas
+metus, ut molestie lacus sodales lacinia. Vivamus lacinia, lectus at laoreet
+fermentum, quam ligula hendrerit massa, in vulputate velit lacus eu tortor. Sed
+mi dui, iaculis nec odio iaculis, iaculis pellentesque velit. Duis consequat,
+felis vitae hendrerit accumsan, lectus massa volutpat quam, quis scelerisque ex
+urna eu neque. Phasellus vitae pharetra tellus, dapibus viverra lectus. Quisque
+ornare risus sit amet auctor convallis. Ut vestibulum tincidunt orci vitae
+tincidunt. Quisque ornare consectetur elementum."""
+
+
+class TestCompleter(Completer):
+ def get_completions(self, document):
+ word_before_cursor = document.get_word_before_cursor()
+
+ for i in range(0, 20):
+ yield Completion('Completion %i' % i, -len(word_before_cursor))
+
+
+layout = Layout(
+ left_margin = LeftMarginWithLineNumbers(),
+ before_input = DefaultPrompt(text='Before input >> '),
+ after_input = Prompt(' << after input'),
+ top_toolbars = [
+ TextToolbar('This is a top toolbar', token=Token.TopToolbar1),
+ TextToolbar('This is another top toolbar', token=Token.TopToolbar2),
+ ],
+ bottom_toolbars = [
+ ArgToolbar(),
+ SearchToolbar(),
+ CompletionToolbar(),
+ TextToolbar('This is a bottom toolbar', token=Token.BottomToolbar1),
+ TextToolbar('This is another bottom toolbar', token=Token.BottomToolbar2),
+ ],
+ show_tildes=True,
+ menus=[CompletionMenu()])
+
+
+class TestStyle(Style):
+ styles = {
+ Token.Layout.LeftMargin: 'bg:#00aaaa #000000',
+ Token.Prompt.BeforeInput: 'bg:#aa2266 #ffffff',
+ Token.AfterInput: 'bg:#aa2266 #ffffff',
+ Token.BottomToolbar1: 'bg:#440044 #ffffff',
+ Token.BottomToolbar2: 'bg:#aa0088 #222222',
+ Token.TopToolbar1: 'bg:#aa0088 #222222',
+ Token.TopToolbar2: 'bg:#440044 #ffffff',
+
+ Token.Layout.Toolbar.Arg: 'bg:#aaaaff #000088',
+ Token.Layout.Toolbar.Arg.Text: 'bg:#aaaaff #000088 bold',
+
+ Token.CompletionMenu.Completion.Current: 'bg:#00aaaa #000000',
+ Token.CompletionMenu.Completion: 'bg:#008888 #ffffff',
+ Token.CompletionMenu.ProgressButton: 'bg:#003333',
+ Token.CompletionMenu.ProgressBar: 'bg:#00aaaa',
+
+ Token.CompletionToolbar: 'bg:#888800 #000000',
+ Token.CompletionToolbar.Arrow: 'bg:#888800 #000000',
+ Token.CompletionToolbar.Completion: 'bg:#aaaa00 #000000',
+ Token.CompletionToolbar.Completion.Current: 'bg:#ffffaa #000000 bold',
+
+ Token.SelectedText: 'bg:#000088 #ffffff',
+ }
+
+
+def main():
+ cli = CommandLineInterface(layout=layout,
+ style=TestStyle,
+ line=Line(is_multiline=True, completer=TestCompleter()))
+
+ code_obj = cli.read_input(initial_value=lipsum)
+ print('You said: ' + code_obj.text)
+
+
+if __name__ == '__main__':
+ main()

examples/python-input.py

@@ -0,0 +1,25 @@
+#!/usr/bin/env python
+"""
+Autocompletion example.
+
+Press [Tab] to complete the current word.
+- The first Tab press fills in the common part of all completions.
+- The second Tab press shows all the completions. (In the menu)
+- Any following tab press cycles through all the possible completions.
+"""
+from __future__ import unicode_literals
+
+from prompt_toolkit.contrib.python_input import PythonCommandLineInterface
+
+
+
+
+def main():
+ cli = PythonCommandLineInterface()
+
+ code_obj = cli.read_input()
+ print('You said: ' + code_obj.text)
+
+
+if __name__ == '__main__':
+ main()