You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ORPA-pyOpenRPA/Resources/WPy64-3720/python-3.7.2.amd64/Lib/site-packages/prompt_toolkit/widgets/base.py

738 lines
24 KiB

"""
Collection of reusable components for building full screen applications.
All of these widgets implement the ``__pt_container__`` method, which makes
them usable in any situation where we are expecting a `prompt_toolkit`
container object.
.. warning::
At this point, the API for these widgets is considered unstable, and can
potentially change between minor releases (we try not too, but no
guarantees are made yet). The public API in
`prompt_toolkit.shortcuts.dialogs` on the other hand is considered stable.
"""
from __future__ import unicode_literals
from functools import partial
import six
from prompt_toolkit.application.current import get_app
from prompt_toolkit.auto_suggest import DynamicAutoSuggest
from prompt_toolkit.buffer import Buffer
from prompt_toolkit.completion import DynamicCompleter
from prompt_toolkit.document import Document
from prompt_toolkit.filters import to_filter, Condition, is_true, has_focus, is_done
from prompt_toolkit.formatted_text import to_formatted_text, Template, is_formatted_text
from prompt_toolkit.formatted_text.utils import fragment_list_to_text
from prompt_toolkit.key_binding.key_bindings import KeyBindings
from prompt_toolkit.layout.containers import Window, VSplit, HSplit, FloatContainer, Float, WindowAlign, is_container, ConditionalContainer, DynamicContainer
from prompt_toolkit.layout.controls import BufferControl, FormattedTextControl
from prompt_toolkit.layout.dimension import Dimension as D
from prompt_toolkit.layout.dimension import is_dimension, to_dimension
from prompt_toolkit.layout.margins import ScrollbarMargin, NumberedMargin
from prompt_toolkit.layout.processors import PasswordProcessor, ConditionalProcessor, BeforeInput, AppendAutoSuggestion
from prompt_toolkit.lexers import DynamicLexer
from prompt_toolkit.mouse_events import MouseEventType
from prompt_toolkit.utils import get_cwidth
from prompt_toolkit.keys import Keys
from .toolbars import SearchToolbar
__all__ = [
'TextArea',
'Label',
'Button',
'Frame',
'Shadow',
'Box',
'VerticalLine',
'HorizontalLine',
'RadioList',
'Checkbox', # XXX: refactor into CheckboxList.
'ProgressBar',
]
class Border:
" Box drawing characters. (Thin) "
HORIZONTAL = '\u2500'
VERTICAL = '\u2502'
TOP_LEFT = '\u250c'
TOP_RIGHT = '\u2510'
BOTTOM_LEFT = '\u2514'
BOTTOM_RIGHT = '\u2518'
class TextArea(object):
"""
A simple input field.
This is a higher level abstraction on top of several other classes with
sane defaults.
This widget does have the most common options, but it does not intend to
cover every single use case. For more configurations options, you can
always build a text area manually, using a
:class:`~prompt_toolkit.buffer.Buffer`,
:class:`~prompt_toolkit.layout.BufferControl` and
:class:`~prompt_toolkit.layout.Window`.
Buffer attributes:
:param text: The initial text.
:param multiline: If True, allow multiline input.
:param completer: :class:`~prompt_toolkit.completion.Completer` instance
for auto completion.
:param complete_while_typing: Boolean.
:param accept_handler: Called when `Enter` is pressed (This should be a
callable that takes a buffer as input).
:param history: :class:`~prompt_toolkit.history.History` instance.
:param auto_suggest: :class:`~prompt_toolkit.auto_suggest.AutoSuggest`
instance for input suggestions.
BufferControl attributes:
:param password: When `True`, display using asterisks.
:param focusable: When `True`, allow this widget to receive the focus.
:param focus_on_click: When `True`, focus after mouse click.
:param input_processors: `None` or a list of
:class:`~prompt_toolkit.layout.Processor` objects.
Window attributes:
:param lexer: :class:`~prompt_toolkit.lexers.Lexer` instance for syntax
highlighting.
:param wrap_lines: When `True`, don't scroll horizontally, but wrap lines.
:param width: Window width. (:class:`~prompt_toolkit.layout.Dimension` object.)
:param height: Window height. (:class:`~prompt_toolkit.layout.Dimension` object.)
:param scrollbar: When `True`, display a scroll bar.
:param style: A style string.
:param dont_extend_width: When `True`, don't take up more width then the
preferred width reported by the control.
:param dont_extend_height: When `True`, don't take up more width then the
preferred height reported by the control.
:param get_line_prefix: None or a callable that returns formatted text to
be inserted before a line. It takes a line number (int) and a
wrap_count and returns formatted text. This can be used for
implementation of line continuations, things like Vim "breakindent" and
so on.
Other attributes:
:param search_field: An optional `SearchToolbar` object.
"""
def __init__(self, text='', multiline=True, password=False,
lexer=None, auto_suggest=None, completer=None,
complete_while_typing=True, accept_handler=None, history=None,
focusable=True, focus_on_click=False, wrap_lines=True,
read_only=False, width=None, height=None,
dont_extend_height=False, dont_extend_width=False,
line_numbers=False, get_line_prefix=None, scrollbar=False,
style='', search_field=None, preview_search=True, prompt='',
input_processors=None):
assert isinstance(text, six.text_type)
assert search_field is None or isinstance(search_field, SearchToolbar)
if search_field is None:
search_control = None
elif isinstance(search_field, SearchToolbar):
search_control = search_field.control
if input_processors is None:
input_processors = []
# Writeable attributes.
self.completer = completer
self.complete_while_typing = complete_while_typing
self.lexer = lexer
self.auto_suggest = auto_suggest
self.read_only = read_only
self.wrap_lines = wrap_lines
self.buffer = Buffer(
document=Document(text, 0),
multiline=multiline,
read_only=Condition(lambda: is_true(self.read_only)),
completer=DynamicCompleter(lambda: self.completer),
complete_while_typing=Condition(
lambda: is_true(self.complete_while_typing)),
auto_suggest=DynamicAutoSuggest(lambda: self.auto_suggest),
accept_handler=accept_handler,
history=history)
self.control = BufferControl(
buffer=self.buffer,
lexer=DynamicLexer(lambda: self.lexer),
input_processors=[
ConditionalProcessor(
AppendAutoSuggestion(),
has_focus(self.buffer) & ~is_done),
ConditionalProcessor(
processor=PasswordProcessor(),
filter=to_filter(password)
),
BeforeInput(prompt, style='class:text-area.prompt'),
] + input_processors,
search_buffer_control=search_control,
preview_search=preview_search,
focusable=focusable,
focus_on_click=focus_on_click)
if multiline:
if scrollbar:
right_margins = [ScrollbarMargin(display_arrows=True)]
else:
right_margins = []
if line_numbers:
left_margins = [NumberedMargin()]
else:
left_margins = []
else:
height = D.exact(1)
left_margins = []
right_margins = []
style = 'class:text-area ' + style
self.window = Window(
height=height,
width=width,
dont_extend_height=dont_extend_height,
dont_extend_width=dont_extend_width,
content=self.control,
style=style,
wrap_lines=Condition(lambda: is_true(self.wrap_lines)),
left_margins=left_margins,
right_margins=right_margins,
get_line_prefix=get_line_prefix)
@property
def text(self):
"""
The `Buffer` text.
"""
return self.buffer.text
@text.setter
def text(self, value):
self.buffer.set_document(Document(value, 0), bypass_readonly=True)
@property
def document(self):
"""
The `Buffer` document (text + cursor position).
"""
return self.buffer.document
@document.setter
def document(self, value):
self.buffer.document = value
@property
def accept_handler(self):
"""
The accept handler. Called when the user accepts the input.
"""
return self.buffer.accept_handler
@accept_handler.setter
def accept_handler(self, value):
self.buffer.accept_handler = value
def __pt_container__(self):
return self.window
class Label(object):
"""
Widget that displays the given text. It is not editable or focusable.
:param text: The text to be displayed. (This can be multiline. This can be
formatted text as well.)
:param style: A style string.
:param width: When given, use this width, rather than calculating it from
the text size.
"""
def __init__(self, text, style='', width=None,
dont_extend_height=True, dont_extend_width=False):
assert is_formatted_text(text)
self.text = text
def get_width():
if width is None:
text_fragments = to_formatted_text(self.text)
text = fragment_list_to_text(text_fragments)
if text:
longest_line = max(get_cwidth(line) for line in text.splitlines())
else:
return D(preferred=0)
return D(preferred=longest_line)
else:
return width
self.formatted_text_control = FormattedTextControl(
text=lambda: self.text)
self.window = Window(
content=self.formatted_text_control,
width=get_width,
style='class:label ' + style,
dont_extend_height=dont_extend_height,
dont_extend_width=dont_extend_width)
def __pt_container__(self):
return self.window
class Button(object):
"""
Clickable button.
:param text: The caption for the button.
:param handler: `None` or callable. Called when the button is clicked.
:param width: Width of the button.
"""
def __init__(self, text, handler=None, width=12):
assert isinstance(text, six.text_type)
assert handler is None or callable(handler)
assert isinstance(width, int)
self.text = text
self.handler = handler
self.width = width
self.control = FormattedTextControl(
self._get_text_fragments,
key_bindings=self._get_key_bindings(),
focusable=True)
def get_style():
if get_app().layout.has_focus(self):
return 'class:button.focused'
else:
return 'class:button'
self.window = Window(
self.control,
align=WindowAlign.CENTER,
height=1,
width=width,
style=get_style,
dont_extend_width=True,
dont_extend_height=True)
def _get_text_fragments(self):
text = ('{:^%s}' % (self.width - 2)).format(self.text)
def handler(mouse_event):
if mouse_event.event_type == MouseEventType.MOUSE_UP:
self.handler()
return [
('class:button.arrow', '<', handler),
('[SetCursorPosition]', ''),
('class:button.text', text, handler),
('class:button.arrow', '>', handler),
]
def _get_key_bindings(self):
" Key bindings for the Button. "
kb = KeyBindings()
@kb.add(' ')
@kb.add('enter')
def _(event):
if self.handler is not None:
self.handler()
return kb
def __pt_container__(self):
return self.window
class Frame(object):
"""
Draw a border around any container, optionally with a title text.
Changing the title and body of the frame is possible at runtime by
assigning to the `body` and `title` attributes of this class.
:param body: Another container object.
:param title: Text to be displayed in the top of the frame (can be formatted text).
:param style: Style string to be applied to this widget.
"""
def __init__(self, body, title='', style='', width=None, height=None,
key_bindings=None, modal=False):
assert is_container(body)
assert is_formatted_text(title)
assert isinstance(style, six.text_type)
assert is_dimension(width)
assert is_dimension(height)
assert key_bindings is None or isinstance(key_bindings, KeyBindings)
assert isinstance(modal, bool)
self.title = title
self.body = body
fill = partial(Window, style='class:frame.border')
style = 'class:frame ' + style
top_row_with_title = VSplit([
fill(width=1, height=1, char=Border.TOP_LEFT),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char='|'),
# Notice: we use `Template` here, because `self.title` can be an
# `HTML` object for instance.
Label(lambda: Template(' {} ').format(self.title),
style='class:frame.label',
dont_extend_width=True),
fill(width=1, height=1, char='|'),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char=Border.TOP_RIGHT),
], height=1)
top_row_without_title = VSplit([
fill(width=1, height=1, char=Border.TOP_LEFT),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char=Border.TOP_RIGHT),
], height=1)
@Condition
def has_title():
return bool(self.title)
self.container = HSplit([
ConditionalContainer(
content=top_row_with_title,
filter=has_title),
ConditionalContainer(
content=top_row_without_title,
filter=~has_title),
VSplit([
fill(width=1, char=Border.VERTICAL),
DynamicContainer(lambda: self.body),
fill(width=1, char=Border.VERTICAL),
# Padding is required to make sure that if the content is
# too small, the right frame border is still aligned.
], padding=0),
VSplit([
fill(width=1, height=1, char=Border.BOTTOM_LEFT),
fill(char=Border.HORIZONTAL),
fill(width=1, height=1, char=Border.BOTTOM_RIGHT),
]),
], width=width, height=height, style=style, key_bindings=key_bindings,
modal=modal)
def __pt_container__(self):
return self.container
class Shadow(object):
"""
Draw a shadow underneath/behind this container.
(This applies `class:shadow` the the cells under the shadow. The Style
should define the colors for the shadow.)
:param body: Another container object.
"""
def __init__(self, body):
assert is_container(body)
self.container = FloatContainer(
content=body,
floats=[
Float(bottom=-1, height=1, left=1, right=-1,
transparent=True,
content=Window(style='class:shadow')),
Float(bottom=-1, top=1, width=1, right=-1,
transparent=True,
content=Window(style='class:shadow')),
]
)
def __pt_container__(self):
return self.container
class Box(object):
"""
Add padding around a container.
This also makes sure that the parent can provide more space than required by
the child. This is very useful when wrapping a small element with a fixed
size into a ``VSplit`` or ``HSplit`` object. The ``HSplit`` and ``VSplit``
try to make sure to adapt respectively the width and height, possibly
shrinking other elements. Wrapping something in a ``Box`` makes it flexible.
:param body: Another container object.
:param padding: The margin to be used around the body. This can be
overridden by `padding_left`, padding_right`, `padding_top` and
`padding_bottom`.
:param style: A style string.
:param char: Character to be used for filling the space around the body.
(This is supposed to be a character with a terminal width of 1.)
"""
def __init__(self, body, padding=None,
padding_left=None, padding_right=None,
padding_top=None, padding_bottom=None,
width=None, height=None,
style='', char=None, modal=False, key_bindings=None):
assert is_container(body)
if padding is None:
padding = D(preferred=0)
def get(value):
if value is None:
value = padding
return to_dimension(value)
self.padding_left = get(padding_left)
self.padding_right = get(padding_right)
self.padding_top = get(padding_top)
self.padding_bottom = get(padding_bottom)
self.body = body
self.container = HSplit([
Window(height=self.padding_top, char=char),
VSplit([
Window(width=self.padding_left, char=char),
body,
Window(width=self.padding_right, char=char),
]),
Window(height=self.padding_bottom, char=char),
],
width=width, height=height, style=style, modal=modal,
key_bindings=None)
def __pt_container__(self):
return self.container
class Checkbox(object):
def __init__(self, text=''):
assert is_formatted_text(text)
self.checked = True
kb = KeyBindings()
@kb.add(' ')
@kb.add('enter')
def _(event):
self.checked = not self.checked
self.control = FormattedTextControl(
self._get_text_fragments,
key_bindings=kb,
focusable=True)
self.window = Window(
width=3, content=self.control, height=1)
self.container = VSplit([
self.window,
Label(text=Template(' {}').format(text))
], style='class:checkbox')
def _get_text_fragments(self):
result = [('', '[')]
result.append(('[SetCursorPosition]', ''))
if self.checked:
result.append(('', '*'))
else:
result.append(('', ' '))
result.append(('', ']'))
return result
def __pt_container__(self):
return self.container
class RadioList(object):
"""
List of radio buttons. Only one can be checked at the same time.
:param values: List of (value, label) tuples.
"""
def __init__(self, values):
assert isinstance(values, list)
assert len(values) > 0
assert all(isinstance(i, tuple) and len(i) == 2
for i in values)
self.values = values
self.current_value = values[0][0]
self._selected_index = 0
# Key bindings.
kb = KeyBindings()
@kb.add('up')
def _(event):
self._selected_index = max(0, self._selected_index - 1)
@kb.add('down')
def _(event):
self._selected_index = min(
len(self.values) - 1, self._selected_index + 1)
@kb.add('pageup')
def _(event):
w = event.app.layout.current_window
self._selected_index = max(
0,
self._selected_index - len(w.render_info.displayed_lines)
)
@kb.add('pagedown')
def _(event):
w = event.app.layout.current_window
self._selected_index = min(
len(self.values) - 1,
self._selected_index + len(w.render_info.displayed_lines)
)
@kb.add('enter')
@kb.add(' ')
def _(event):
self.current_value = self.values[self._selected_index][0]
@kb.add(Keys.Any)
def _(event):
# We first check values after the selected value, then all values.
for value in self.values[self._selected_index + 1:] + self.values:
if value[1].startswith(event.data):
self._selected_index = self.values.index(value)
return
# Control and window.
self.control = FormattedTextControl(
self._get_text_fragments,
key_bindings=kb,
focusable=True)
self.window = Window(
content=self.control,
style='class:radio-list',
right_margins=[
ScrollbarMargin(display_arrows=True),
],
dont_extend_height=True)
def _get_text_fragments(self):
def mouse_handler(mouse_event):
"""
Set `_selected_index` and `current_value` according to the y
position of the mouse click event.
"""
if mouse_event.event_type == MouseEventType.MOUSE_UP:
self._selected_index = mouse_event.position.y
self.current_value = self.values[self._selected_index][0]
result = []
for i, value in enumerate(self.values):
checked = (value[0] == self.current_value)
selected = (i == self._selected_index)
style = ''
if checked:
style += ' class:radio-checked'
if selected:
style += ' class:radio-selected'
result.append((style, '('))
if selected:
result.append(('[SetCursorPosition]', ''))
if checked:
result.append((style, '*'))
else:
result.append((style, ' '))
result.append((style, ')'))
result.append(('class:radio', ' '))
result.extend(to_formatted_text(value[1], style='class:radio'))
result.append(('', '\n'))
# Add mouse handler to all fragments.
for i in range(len(result)):
result[i] = (result[i][0], result[i][1], mouse_handler)
result.pop() # Remove last newline.
return result
def __pt_container__(self):
return self.window
class VerticalLine(object):
"""
A simple vertical line with a width of 1.
"""
def __init__(self):
self.window = Window(
char=Border.VERTICAL,
style='class:line,vertical-line',
width=1)
def __pt_container__(self):
return self.window
class HorizontalLine(object):
"""
A simple horizontal line with a height of 1.
"""
def __init__(self):
self.window = Window(
char=Border.HORIZONTAL,
style='class:line,horizontal-line',
height=1)
def __pt_container__(self):
return self.window
class ProgressBar(object):
def __init__(self):
self._percentage = 60
self.label = Label('60%')
self.container = FloatContainer(
content=Window(height=1),
floats=[
# We first draw the label, then the actual progress bar. Right
# now, this is the only way to have the colors of the progress
# bar appear on top of the label. The problem is that our label
# can't be part of any `Window` below.
Float(content=self.label, top=0, bottom=0),
Float(left=0, top=0, right=0, bottom=0, content=VSplit([
Window(style='class:progress-bar.used',
width=lambda: D(weight=int(self._percentage))),
Window(style='class:progress-bar',
width=lambda: D(weight=int(100 - self._percentage))),
])),
])
@property
def percentage(self):
return self._percentage
@percentage.setter
def percentage(self, value):
assert isinstance(value, int)
self._percentage = value
self.label.text = '{0}%'.format(value)
def __pt_container__(self):
return self.container