second commit
This commit is contained in:
302
env/lib/python3.11/site-packages/rich_toolkit/menu.py
vendored
Normal file
302
env/lib/python3.11/site-packages/rich_toolkit/menu.py
vendored
Normal file
@ -0,0 +1,302 @@
|
||||
from typing import Generic, List, Optional, Tuple, TypeVar, cast
|
||||
|
||||
import click
|
||||
from rich import get_console
|
||||
from rich.console import Console, Group, RenderableType
|
||||
from rich.control import Control
|
||||
from rich.segment import ControlType
|
||||
from rich.text import Text
|
||||
from rich.live_render import LiveRender
|
||||
from typing_extensions import Any, Literal, TypedDict
|
||||
|
||||
from .styles.base import BaseStyle
|
||||
from .input import TextInputHandler, LiveInput
|
||||
|
||||
ReturnValue = TypeVar("ReturnValue")
|
||||
|
||||
|
||||
class Option(TypedDict, Generic[ReturnValue]):
|
||||
name: str
|
||||
value: ReturnValue
|
||||
|
||||
|
||||
class Menu(Generic[ReturnValue], LiveInput):
|
||||
DOWN_KEYS = [TextInputHandler.DOWN_KEY, "j"]
|
||||
UP_KEYS = [TextInputHandler.UP_KEY, "k"]
|
||||
LEFT_KEYS = [TextInputHandler.LEFT_KEY, "h"]
|
||||
RIGHT_KEYS = [TextInputHandler.RIGHT_KEY, "l"]
|
||||
|
||||
current_selection_char = "●"
|
||||
selection_char = "○"
|
||||
filter_prompt = "Filter: "
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
title: str,
|
||||
options: List[Option[ReturnValue]],
|
||||
inline: bool = False,
|
||||
allow_filtering: bool = False,
|
||||
*,
|
||||
style: Optional[BaseStyle] = None,
|
||||
console: Optional[Console] = None,
|
||||
cursor_offset: int = 0,
|
||||
**metadata: Any,
|
||||
):
|
||||
self.console = console or get_console()
|
||||
|
||||
self.title = Text.from_markup(title)
|
||||
self.inline = inline
|
||||
self.allow_filtering = allow_filtering
|
||||
|
||||
self.selected = 0
|
||||
|
||||
self.metadata = metadata
|
||||
self.style = style
|
||||
|
||||
self._options = options
|
||||
|
||||
self._padding_bottom = 1
|
||||
|
||||
cursor_offset = cursor_offset + len(self.filter_prompt)
|
||||
|
||||
super().__init__(
|
||||
console=self.console,
|
||||
style=self.style,
|
||||
cursor_offset=cursor_offset,
|
||||
**metadata,
|
||||
)
|
||||
|
||||
def get_key(self) -> Optional[str]:
|
||||
char = click.getchar()
|
||||
|
||||
if char == "\r":
|
||||
return "enter"
|
||||
|
||||
if self.allow_filtering:
|
||||
left_keys, right_keys = [[self.LEFT_KEY], [self.RIGHT_KEY]]
|
||||
down_keys, up_keys = [[self.DOWN_KEY], [self.UP_KEY]]
|
||||
else:
|
||||
left_keys, right_keys = self.LEFT_KEYS, self.RIGHT_KEYS
|
||||
down_keys, up_keys = self.DOWN_KEYS, self.UP_KEYS
|
||||
|
||||
next_keys, prev_keys = (
|
||||
(right_keys, left_keys) if self.inline else (down_keys, up_keys)
|
||||
)
|
||||
|
||||
if char in next_keys:
|
||||
return "next"
|
||||
if char in prev_keys:
|
||||
return "prev"
|
||||
|
||||
if self.allow_filtering:
|
||||
return char
|
||||
|
||||
return None
|
||||
|
||||
@property
|
||||
def options(self) -> List[Option[ReturnValue]]:
|
||||
if self.allow_filtering:
|
||||
return [
|
||||
option
|
||||
for option in self._options
|
||||
if self.text.lower() in option["name"].lower()
|
||||
]
|
||||
|
||||
return self._options
|
||||
|
||||
def _update_selection(self, key: Literal["next", "prev"]) -> None:
|
||||
if key == "next":
|
||||
self.selected += 1
|
||||
elif key == "prev":
|
||||
self.selected -= 1
|
||||
|
||||
if self.selected < 0:
|
||||
self.selected = len(self.options) - 1
|
||||
|
||||
if self.selected >= len(self.options):
|
||||
self.selected = 0
|
||||
|
||||
def render_input(self) -> RenderableType:
|
||||
menu = Text(justify="left")
|
||||
|
||||
selected_prefix = Text(self.current_selection_char + " ")
|
||||
not_selected_prefix = Text(self.selection_char + " ")
|
||||
|
||||
separator = Text("\t" if self.inline else "\n")
|
||||
|
||||
for id_, option in enumerate(self.options):
|
||||
if id_ == self.selected:
|
||||
prefix = selected_prefix
|
||||
style = self.console.get_style("selected")
|
||||
else:
|
||||
prefix = not_selected_prefix
|
||||
style = self.console.get_style("text")
|
||||
|
||||
menu.append(Text.assemble(prefix, option["name"], separator, style=style))
|
||||
|
||||
# TODO: inline is not wrapped (maybe that's good?)
|
||||
|
||||
if not self.options:
|
||||
# menu.append("No results found", style=self.console.get_style("text"))
|
||||
menu = Text("No results found\n\n", style=self.console.get_style("text"))
|
||||
|
||||
h = 0
|
||||
if self._live_render._shape is not None:
|
||||
_, h = self._live_render._shape
|
||||
|
||||
filter = (
|
||||
[
|
||||
Text.assemble(
|
||||
(self.filter_prompt, self.console.get_style("text")),
|
||||
(self.text, self.console.get_style("text")),
|
||||
"\n",
|
||||
)
|
||||
]
|
||||
if self.allow_filtering
|
||||
else []
|
||||
)
|
||||
|
||||
return Group(self.title, *filter, *menu)
|
||||
|
||||
def render_result(self) -> RenderableType:
|
||||
result_text = Text()
|
||||
|
||||
result_text.append(self.title)
|
||||
result_text.append(" ")
|
||||
result_text.append(
|
||||
self.options[self.selected]["name"],
|
||||
style=self.console.get_style("result"),
|
||||
)
|
||||
|
||||
return result_text
|
||||
|
||||
def update_text(self, text: str) -> None:
|
||||
current_selection: Optional[str] = None
|
||||
|
||||
if self.options:
|
||||
current_selection = self.options[self.selected]["name"]
|
||||
|
||||
super().update_text(text)
|
||||
|
||||
if current_selection:
|
||||
matching_index = next(
|
||||
(
|
||||
index
|
||||
for index, option in enumerate(self.options)
|
||||
if option["name"] == current_selection
|
||||
),
|
||||
0,
|
||||
)
|
||||
|
||||
self.selected = matching_index
|
||||
|
||||
def _handle_enter(self) -> bool:
|
||||
if self.allow_filtering and self.text and len(self.options) == 0:
|
||||
return False
|
||||
|
||||
return True
|
||||
|
||||
def reposition_cursor(self) -> Control:
|
||||
if self.allow_filtering:
|
||||
if self._live_render._shape is None:
|
||||
return Control()
|
||||
|
||||
_, height = self._live_render._shape
|
||||
|
||||
move_down = height - 2
|
||||
|
||||
return Control(
|
||||
(ControlType.CURSOR_DOWN, move_down),
|
||||
ControlType.CARRIAGE_RETURN,
|
||||
(ControlType.ERASE_IN_LINE, 2),
|
||||
*(
|
||||
(
|
||||
(ControlType.CURSOR_UP, 1),
|
||||
(ControlType.ERASE_IN_LINE, 2),
|
||||
)
|
||||
* (height - 1)
|
||||
),
|
||||
)
|
||||
|
||||
return self._live_render.position_cursor()
|
||||
|
||||
def position_cursor(self) -> Tuple[Control, ...]:
|
||||
"""Positions the cursor at the end of the menu.
|
||||
|
||||
It moves the cursor up based on the size of the menu when filtering
|
||||
is enabled. It does by taking into account the size of the menu
|
||||
and the fact that we moved the cursor up in the previous render.
|
||||
|
||||
We use the shape of the menu to calculate the number of times we
|
||||
need to move the cursor up, we do this because the options are
|
||||
dynamic and we need the current size* of the menu to calculate
|
||||
the correct position of the cursor.
|
||||
|
||||
* Current size means the previous size of the menu, but I say
|
||||
current because we haven't rendered the updated menu yet :)
|
||||
"""
|
||||
original = super().position_cursor()
|
||||
|
||||
if self._live_render._shape is None or not self.allow_filtering:
|
||||
return original
|
||||
|
||||
_, height = self._live_render._shape
|
||||
|
||||
move_down = height - 2
|
||||
|
||||
return (
|
||||
Control(
|
||||
(ControlType.CURSOR_DOWN, move_down),
|
||||
),
|
||||
*original,
|
||||
)
|
||||
|
||||
def fix_cursor(self) -> Tuple[Control, ...]:
|
||||
"""Fixes the position of cursor after rendering the menu.
|
||||
|
||||
It moves the cursor up based on the size of the menu, but
|
||||
only if allow_filtering is enabled. (We don't show the cursor
|
||||
when filtering is disabled.)
|
||||
"""
|
||||
move_cursor = ()
|
||||
|
||||
if self.allow_filtering:
|
||||
height = len(self.options) + 1 if self.options else 2
|
||||
|
||||
move_cursor = (Control((ControlType.CURSOR_UP, height)),)
|
||||
|
||||
return (*super().fix_cursor(), *move_cursor)
|
||||
|
||||
@property
|
||||
def should_show_cursor(self) -> bool:
|
||||
return self.allow_filtering
|
||||
|
||||
def ask(self) -> ReturnValue:
|
||||
self._refresh()
|
||||
|
||||
while True:
|
||||
try:
|
||||
key = self.get_key()
|
||||
|
||||
if key == "enter":
|
||||
if self._handle_enter():
|
||||
break
|
||||
|
||||
elif key is not None:
|
||||
if key in ["next", "prev"]:
|
||||
key = cast(Literal["next", "prev"], key)
|
||||
self._update_selection(key)
|
||||
else:
|
||||
self.update_text(key)
|
||||
|
||||
except KeyboardInterrupt:
|
||||
exit()
|
||||
|
||||
self._refresh()
|
||||
|
||||
self._refresh(show_result=True)
|
||||
|
||||
for _ in range(self._padding_bottom):
|
||||
self.console.print()
|
||||
|
||||
return self.options[self.selected]["value"]
|
||||
Reference in New Issue
Block a user