Spaces:
Sleeping
Sleeping
File size: 1,273 Bytes
2d876d1 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 |
"""Module contains :class:`.InstructionWindow` which can be used to display long instructions."""
from typing import TYPE_CHECKING
from prompt_toolkit.layout.containers import ConditionalContainer, Window
from prompt_toolkit.layout.controls import FormattedTextControl
if TYPE_CHECKING:
from prompt_toolkit.filters.base import FilterOrBool
from prompt_toolkit.formatted_text.base import AnyFormattedText
class InstructionWindow(ConditionalContainer):
"""Conditional `prompt_toolkit` :class:`~prompt_toolkit.layout.Window` that displays long instructions.
Args:
message: Long instructions to display.
filter: Condition to display the instruction window.
"""
def __init__(self, message: str, filter: "FilterOrBool", **kwargs) -> None:
self._message = message
super().__init__(
Window(
FormattedTextControl(text=self._get_message),
dont_extend_height=True,
**kwargs
),
filter=filter,
)
def _get_message(self) -> "AnyFormattedText":
"""Get long instruction to display.
Returns:
FormattedText in list of tuple format.
"""
return [("class:long_instruction", self._message)]
|