"""Rich Module.""" __docformat__ = "numpy" from typing import Dict, List 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]", ] class MenuText: """Create menu text with rich colors to be displayed by CLI.""" CMD_NAME_LENGTH = 18 CMD_DESCRIPTION_LENGTH = 65 CMD_PROVIDERS_LENGTH = 23 SECTION_SPACING = 4 def __init__(self, path: str = ""): """Initialize menu help.""" self.menu_text = "" self.menu_path = path self.warnings: List[Dict[str, str]] = [] @staticmethod def _get_providers(command_path: str) -> List: """Return the preferred provider for the given command. Parameters ---------- command_path: str The command to find the provider for. E.g. "/equity/price/historical Returns ------- List The list of providers 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 [] def _format_cmd_name(self, name: str) -> str: """Truncate command name length if it is too long.""" if len(name) > self.CMD_NAME_LENGTH: new_name = name[ : self.CMD_NAME_LENGTH ] # Default to trimming to 18 characters if "_" in name: name_split = name.split("_") new_name = ( "_".join(name_split[:2]) if len(name_split) > 2 else name_split[0] ) if len(new_name) > self.CMD_NAME_LENGTH: new_name = new_name[: self.CMD_NAME_LENGTH] if new_name != name: self.warnings.append( { "warning": "Command name too long", "command": name, "trimmed_command": new_name, } ) name = new_name return name def _format_cmd_description( self, name: str, description: str, trim: bool = True ) -> str: """Truncate command description length if it is too long.""" if not description: description = i18n.t(self.menu_path + name) if description == self.menu_path + name: description = "" return ( description[: self.CMD_DESCRIPTION_LENGTH - 3] + "..." if len(description) > self.CMD_DESCRIPTION_LENGTH and trim else description ) def add_raw(self, text: str): """Append raw text (without translation).""" self.menu_text += text def add_section( self, text: str, description: str = "", leading_new_line: bool = False ): """Append raw text (without translation).""" spacing = (self.CMD_NAME_LENGTH - len(text) + self.SECTION_SPACING) * " " left_spacing = self.SECTION_SPACING * " " if description: text = f"{left_spacing}{text}{spacing}{description}\n" if leading_new_line: self.menu_text += "\n" + text else: self.menu_text += text def add_custom(self, name: str): """Append custom text (after translation).""" self.menu_text += f"{i18n.t(self.menu_path + name)}" def add_info(self, text: str): """Append information text (after translation).""" self.menu_text += f"[info]{i18n.t(self.menu_path + text)}:[/info]\n" def add_param(self, name: str, value: str, col_align: int = 0): """Append parameter (after translation).""" parameter_translated = i18n.t(self.menu_path + name) 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 add_cmd(self, name: str, description: str = "", disable: bool = False): """Append command text (after translation).""" formatted_name = self._format_cmd_name(name) name_padding = (self.CMD_NAME_LENGTH - len(formatted_name)) * " " providers = self._get_providers(f"{self.menu_path}{name}") formatted_description = self._format_cmd_description( formatted_name, description, bool(providers), ) description_padding = ( self.CMD_DESCRIPTION_LENGTH - len(formatted_description) ) * " " spacing = self.SECTION_SPACING * " " description_padding = ( self.CMD_DESCRIPTION_LENGTH - len(formatted_description) ) * " " cmd = f"{spacing}{formatted_name + name_padding}{spacing}{formatted_description+description_padding}" cmd = f"[unvl]{cmd}[/unvl]" if disable else f"[cmds]{cmd}[/cmds]" if providers: cmd += rf"{spacing}[src]\[{', '.join(providers)}][/src]" self.menu_text += cmd + "\n" def add_menu( self, name: str, description: str = "", disable: bool = False, ): """Append menu text (after translation).""" spacing = (self.CMD_NAME_LENGTH - len(name) + self.SECTION_SPACING) * " " if not description: description = i18n.t(self.menu_path + name) if description == self.menu_path + name: description = "" if len(description) > self.CMD_DESCRIPTION_LENGTH: description = description[: self.CMD_DESCRIPTION_LENGTH - 3] + "..." menu = f"{name}{spacing}{description}" tag = "unvl" if disable else "menu" self.menu_text += f"[{tag}]> {menu}[/{tag}]\n" def add_setting(self, name: str, status: bool = True): """Append menu text (after translation).""" spacing = (self.CMD_NAME_LENGTH - len(name) + self.SECTION_SPACING) * " " indentation = self.SECTION_SPACING * " " color = "green" if status else "red" self.menu_text += f"[{color}]{indentation}{name}{spacing}{i18n.t(self.menu_path + name)}[/{color}]\n"