mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-10-28 13:01:38 +00:00
cc15a770da
* rename terminal folder * docstring * Rename to openbb_cli * rename constant * rename .his file * pyproject.toml * Update pre-commit and remove docker-build.yml
263 lines
8.2 KiB
Python
263 lines
8.2 KiB
Python
"""Rich Module."""
|
|
|
|
__docformat__ = "numpy"
|
|
|
|
from typing import Dict, List, Optional, Union
|
|
|
|
import i18n
|
|
from openbb import obb
|
|
|
|
# https://rich.readthedocs.io/en/stable/appendix/colors.html#appendix-colors
|
|
# https://rich.readthedocs.io/en/latest/highlighting.html#custom-highlighters
|
|
|
|
|
|
RICH_TAGS = [
|
|
"[menu]",
|
|
"[/menu]",
|
|
"[cmds]",
|
|
"[/cmds]",
|
|
"[info]",
|
|
"[/info]",
|
|
"[param]",
|
|
"[/param]",
|
|
"[src]",
|
|
"[/src]",
|
|
"[help]",
|
|
"[/help]",
|
|
]
|
|
|
|
USE_COLOR = True
|
|
|
|
|
|
def get_ordered_list_sources(command_path: str) -> List:
|
|
"""Return the preferred source for the given command.
|
|
|
|
Parameters
|
|
----------
|
|
command_path: str
|
|
The command to find the source for. E.g. "/equity/price/historical
|
|
|
|
Returns
|
|
-------
|
|
List
|
|
The list of sources for the given command.
|
|
"""
|
|
command_reference = obb.reference.get("paths", {}).get(command_path, {}) # type: ignore
|
|
if command_reference:
|
|
providers = list(command_reference["parameters"].keys())
|
|
return [provider for provider in providers if provider != "standard"]
|
|
return []
|
|
|
|
|
|
class MenuText:
|
|
"""Create menu text with rich colors to be displayed by CLI."""
|
|
|
|
def __init__(self, path: str = "", column_sources: int = 100):
|
|
"""Initialize menu help.
|
|
|
|
Parameters
|
|
----------
|
|
path : str
|
|
path to the menu that is being created
|
|
column_sources : int
|
|
column width from which to start displaying sources
|
|
"""
|
|
self.menu_text = ""
|
|
self.menu_path = path
|
|
self.col_src = column_sources
|
|
self.warnings: List[Dict[str, str]] = []
|
|
|
|
def add_raw(self, raw_text: str):
|
|
"""Append raw text (no translation) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
raw_text : str
|
|
raw text to be appended to the menu
|
|
"""
|
|
self.menu_text += raw_text
|
|
|
|
def add_custom(self, key: str):
|
|
"""Append custom text (after translation from key) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
key : str
|
|
key to get translated text and add to the menu
|
|
"""
|
|
self.menu_text += f"{i18n.t(self.menu_path + key)}"
|
|
|
|
def add_info(self, key_info: str):
|
|
"""Append info text (after translation from key) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
key_info : str
|
|
key to get translated text and add to the menu as info
|
|
"""
|
|
self.menu_text += f"[info]{i18n.t(self.menu_path + key_info)}:[/info]\n"
|
|
|
|
def add_param(self, key_param: str, value: str, col_align: int = 0):
|
|
"""Append info text (after translation from key) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
key_param : str
|
|
key to get translated text and add to the menu as parameter
|
|
value : str
|
|
value to display in front of the parameter
|
|
col_align : int
|
|
column alignment for the value. This allows for a better UX experience.
|
|
"""
|
|
parameter_translated = i18n.t(self.menu_path + key_param)
|
|
space = (
|
|
(col_align - len(parameter_translated)) * " "
|
|
if col_align > len(parameter_translated)
|
|
else ""
|
|
)
|
|
self.menu_text += f"[param]{parameter_translated}{space}:[/param] {value}\n"
|
|
|
|
def _adjust_command_length(self, key_command: str) -> str:
|
|
"""Adjust the length of the command if it is too long.
|
|
|
|
Parameters
|
|
----------
|
|
key_command : str
|
|
command to be adjusted
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
adjusted command
|
|
"""
|
|
if len(key_command) > 18:
|
|
new_key_command = key_command[:18] # Default to trimming to 18 characters
|
|
|
|
if "_" in key_command:
|
|
key_command_split = key_command.split("_")
|
|
|
|
new_key_command = (
|
|
"_".join(key_command_split[:2])
|
|
if len(key_command_split) > 2
|
|
else key_command_split[0]
|
|
)
|
|
|
|
if len(new_key_command) > 18:
|
|
new_key_command = new_key_command[:18]
|
|
|
|
if new_key_command != key_command:
|
|
self.warnings.append(
|
|
{
|
|
"warning": "Command name too long",
|
|
"command": key_command,
|
|
"trimmed_command": new_key_command,
|
|
}
|
|
)
|
|
key_command = new_key_command
|
|
|
|
return key_command
|
|
|
|
def _handle_command_description(
|
|
self, key_command: str, command_description: str
|
|
) -> str:
|
|
"""Handle the command description.
|
|
|
|
Parameters
|
|
----------
|
|
key_command : str
|
|
command to be adjusted
|
|
command_description : str
|
|
description of the command
|
|
|
|
Returns
|
|
-------
|
|
str
|
|
adjusted command description
|
|
"""
|
|
if not command_description:
|
|
command_description = i18n.t(self.menu_path + key_command)
|
|
if command_description == self.menu_path + key_command:
|
|
command_description = ""
|
|
return (
|
|
command_description[:88] + "..."
|
|
if len(command_description) > 91
|
|
else command_description
|
|
)
|
|
|
|
def add_cmd(
|
|
self, key_command: str, condition: bool = True, command_description: str = ""
|
|
):
|
|
"""Append command text (after translation from key) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
key_command : str
|
|
key command to be executed by user. It is also used as a key to get description of command.
|
|
condition : bool
|
|
condition in which command is available to user. I.e. displays command and description.
|
|
If condition is false, the command line is greyed out.
|
|
"""
|
|
key_command = self._adjust_command_length(key_command)
|
|
command_description = self._handle_command_description(
|
|
key_command, command_description
|
|
)
|
|
spacing = (23 - (len(key_command) + 4)) * " "
|
|
|
|
cmd = f"{key_command}{spacing}{command_description}"
|
|
cmd = f"[cmds] {cmd}[/cmds]" if condition else f"[unvl] {cmd}[/unvl]"
|
|
|
|
sources = get_ordered_list_sources(f"{self.menu_path}{key_command}")
|
|
|
|
if sources:
|
|
space = (self.col_src - len(cmd)) * " " if self.col_src > len(cmd) else " "
|
|
cmd += f"{space}[src][{', '.join(sources)}][/src]"
|
|
|
|
self.menu_text += cmd + "\n"
|
|
|
|
def add_menu(
|
|
self,
|
|
key_menu: str,
|
|
condition: Optional[Union[bool, str]] = True,
|
|
menu_description: str = "",
|
|
):
|
|
"""Append menu text (after translation from key) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
key_menu : str
|
|
key menu to be executed by user. It is also used as a key to get description of menu.
|
|
condition : bool
|
|
condition in which menu is available to user. I.e. displays menu and description.
|
|
If condition is false, the menu line is greyed out.
|
|
"""
|
|
spacing = (23 - (len(key_menu) + 4)) * " "
|
|
|
|
if menu_description:
|
|
menu = f"{key_menu}{spacing}{menu_description}"
|
|
else:
|
|
menu_description = i18n.t(self.menu_path + key_menu)
|
|
if menu_description == self.menu_path + key_menu:
|
|
menu_description = ""
|
|
menu = f"{key_menu}{spacing}{menu_description}"
|
|
|
|
if condition:
|
|
self.menu_text += f"[menu]> {menu}[/menu]\n"
|
|
else:
|
|
self.menu_text += f"[unvl]> {menu}[/unvl]\n"
|
|
|
|
def add_setting(self, key_setting: str, status: bool = True):
|
|
"""Append menu text (after translation from key) to a menu.
|
|
|
|
Parameters
|
|
----------
|
|
key_setting : str
|
|
key setting to be set by user. It is also used as a key to get description of the setting.
|
|
status : bool
|
|
status of the current setting. If true the line will be green, otherwise red.
|
|
"""
|
|
spacing = (23 - (len(key_setting) + 4)) * " "
|
|
if status:
|
|
self.menu_text += f"[green] {key_setting}{spacing}{i18n.t(self.menu_path + key_setting)}[/green]\n"
|
|
else:
|
|
self.menu_text += f"[red] {key_setting}{spacing}{i18n.t(self.menu_path + key_setting)}[/red]\n"
|