Merge branch 'develop' of https://github.com/OpenBB-finance/OpenBBTerminal into feature/effr

11 files changed, 336 insertions, 492 deletions

diff --git a/build/docker/api.dockerfile b/build/docker/platform.dockerfile
index e8b7ac7e643..3bbfb2ae436 100644
--- a/build/docker/api.dockerfile
+++ b/build/docker/platform.dockerfile
@@ -34,7 +34,7 @@
 
     COPY ./openbb_platform ./openbb_platform
 
-    # Install the SDK
+    # Install the Platform
     RUN pip install /openbb/openbb_platform[all]
     RUN pip install openbb-devtools
 
@@ -43,5 +43,5 @@
 
     COPY --from=builder /usr/local /usr/local
 
-    # Specify the command to run
+    # Launch the API
     CMD ["uvicorn", "openbb_core.api.rest_api:app", "--host", "0.0.0.0", "--port", "8000", "--reload"]
diff --git a/cli/openbb_cli/argparse_translator/utils.py b/cli/openbb_cli/argparse_translator/utils.py
index d9ab81c5327..3aa274a5736 100644
--- a/cli/openbb_cli/argparse_translator/utils.py
+++ b/cli/openbb_cli/argparse_translator/utils.py
@@ -64,7 +64,9 @@ def get_argument_optional_choices(parser: ArgumentParser, argument_name: str) ->
             or action.dest == argument_name
             and hasattr(action, "optional_choices")
         ):
-            return action.optional_choices
+            return (
+                action.optional_choices  # pylint: disable=no-member # this is a custom attribute
+            )
     return False
 
 
diff --git a/cli/openbb_cli/controllers/base_controller.py b/cli/openbb_cli/controllers/base_controller.py
index 2aa1ef0c633..00ed8da88b4 100644
--- a/cli/openbb_cli/controllers/base_controller.py
+++ b/cli/openbb_cli/controllers/base_controller.py
@@ -138,27 +138,10 @@ class BaseController(metaclass=ABCMeta):
 
     def load_class(self, class_ins, *args, **kwargs):
         """Check for an existing instance of the controller before creating a new one."""
-        settings = session.settings
         self.save_class()
         arguments = len(args) + len(kwargs)
-        # Due to the 'arguments == 1' condition, we actually NEVER load a class
-        # that has arguments (The 1 argument corresponds to self.queue)
-        # Advantage: If the user changes something on one controller and then goes to the
-        # controller below, it will create such class from scratch bringing all new variables
-        # in and considering latest changes.
-        # Disadvantage: If the user goes on a controller below and we have been there before
-        # it will not load that previous class, but create a new one from scratch.
-        # SCENARIO: If the user is in stocks and does load AAPL/ta the TA menu will get AAPL,
-        # and if then the user goes back to the stocks menu using .. that menu will have AAPL
-        # Now, if "arguments == 1" condition exists, if the user does "load TSLA" and then
-        # goes into "TA", the "TSLA" ticker will appear. If that condition doesn't exist
-        # the previous class will be loaded and even if the user changes the ticker on
-        # the stocks context it will not impact the one of TA menu - unless changes are done.
-        if (
-            class_ins.PATH in controllers
-            and arguments == 1
-            and settings.REMEMBER_CONTEXTS
-        ):
+
+        if class_ins.PATH in controllers and arguments == 1:
             old_class = controllers[class_ins.PATH]
             old_class.queue = self.queue
             return old_class.menu()
@@ -166,8 +149,7 @@ class BaseController(metaclass=ABCMeta):
 
     def save_class(self) -> None:
         """Save the current instance of the class to be loaded later."""
-        if session.settings.REMEMBER_CONTEXTS:
-            controllers[self.PATH] = self
+        controllers[self.PATH] = self
 
     def custom_reset(self) -> List[str]:
         """Implement custom reset.
diff --git a/cli/openbb_cli/controllers/base_platform_controller.py b/cli/openbb_cli/controllers/base_platform_controller.py
index acbec34d165..658e73b8a9f 100644
--- a/cli/openbb_cli/controllers/base_platform_controller.py
+++ b/cli/openbb_cli/controllers/base_platform_controller.py
@@ -6,6 +6,7 @@ from types import MethodType
 from typing import Dict, List, Optional
 
 import pandas as pd
+from openbb import obb
 from openbb_charting.core.openbb_figure import OpenBBFigure
 from openbb_cli.argparse_translator.argparse_class_processor import (
     ArgparseClassProcessor,
@@ -16,8 +17,6 @@ from openbb_cli.controllers.utils import export_data, print_rich_table
 from openbb_cli.session import Session
 from openbb_core.app.model.obbject import OBBject
 
-from openbb import obb
-
 session = Session()
 
 
@@ -186,30 +185,33 @@ class PlatformController(BaseController):
                                 )
 
                             # making the dataframe available
-                            # either for printing or exporting (or both)
+                            # either for printing or exporting
                             df = obbject.to_dataframe()
 
+                            export = hasattr(ns_parser, "export") and ns_parser.export
+
                             if hasattr(ns_parser, "chart") and ns_parser.chart:
-                                obbject.show()
                                 fig = obbject.chart.fig if obbject.chart else None
+                                if not export:
+                                    obbject.show()
                             else:
                                 if isinstance(df.columns, pd.RangeIndex):
                                     df.columns = [str(i) for i in df.columns]
 
-                                print_rich_table(df=df, show_index=True, title=title)
+                                print_rich_table(
+                                    df=df, show_index=True, title=title, export=export
+                                )
 
                         elif isinstance(obbject, dict):
                             df = pd.DataFrame.from_dict(obbject, orient="columns")
-                            print_rich_table(df=df, show_index=True, title=title)
+                            print_rich_table(
+                                df=df, show_index=True, title=title, export=export
+                            )
 
                         elif not isinstance(obbject, OBBject):
                             session.console.print(obbject)
 
-                    if (
-                        hasattr(ns_parser, "export")
-                        and ns_parser.export
-                        and not df.empty
-                    ):
+                    if export and not df.empty:
                         sheet_name = getattr(ns_parser, "sheet_name", None)
                         if sheet_name and isinstance(sheet_name, list):
                             sheet_name = sheet_name[0]
@@ -222,7 +224,7 @@ class PlatformController(BaseController):
                             sheet_name=sheet_name,
                             figure=fig,
                         )
-                    elif hasattr(ns_parser, "export") and ns_parser.export and df.empty:
+                    elif export and df.empty:
                         session.console.print("[yellow]No data to export.[/yellow]")
 
                 except Exception as e:
diff --git a/cli/openbb_cli/controllers/settings_controller.py b/cli/openbb_cli/controllers/settings_controller.py
index f93501a5063..da8add50b52 100644
--- a/cli/openbb_cli/controllers/settings_controller.py
+++ b/cli/openbb_cli/controllers/settings_controller.py
@@ -1,15 +1,13 @@
 """Settings Controller Module."""
 
 import argparse
-from typing import List, Optional
+from functools import partial, update_wrapper
+from types import MethodType
+from typing import List, Literal, Optional, get_origin
 
-from openbb_cli.config.constants import AVAILABLE_FLAIRS
 from openbb_cli.config.menu_text import MenuText
-
-# pylint: disable=too-many-lines,no-member,too-many-public-methods,C0302
-# pylint:disable=import-outside-toplevel
 from openbb_cli.controllers.base_controller import BaseController
-from openbb_cli.controllers.utils import all_timezones, is_timezone_valid
+from openbb_cli.models.settings import SettingGroups
 from openbb_cli.session import Session
 
 session = Session()
@@ -18,356 +16,127 @@ session = Session()
 class SettingsController(BaseController):
     """Settings Controller class."""
 
-    CHOICES_COMMANDS: List[str] = [
-        "interactive",
-        "cls",
-        "promptkit",
-        "exithelp",
-        "rcontext",
-        "richpanel",
-        "tbhint",
-        "overwrite",
-        "version",
-        "console_style",
-        "flair",
-        "timezone",
-        "n_rows",
-        "n_cols",
-        "obbject_msg",
-        "obbject_res",
-        "obbject_display",
-    ]
+    _COMMANDS = {
+        v.json_schema_extra.get("command"): {
+            "command": (v.json_schema_extra or {}).get("command"),
+            "group": (v.json_schema_extra or {}).get("group"),
+            "description": v.description,
+            "annotation": v.annotation,
+            "field_name": k,
+        }
+        for k, v in sorted(
+            session.settings.model_fields.items(),
+            key=lambda item: (item[1].json_schema_extra or {}).get("command", ""),
+        )
+        if v.json_schema_extra
+    }
+    CHOICES_COMMANDS: List[str] = list(_COMMANDS.keys())
     PATH = "/settings/"
     CHOICES_GENERATION = True
 
     def __init__(self, queue: Optional[List[str]] = None):
         """Initialize the Constructor."""
         super().__init__(queue)
-
+        for cmd, field in self._COMMANDS.items():
+            group = field.get("group")
+            if group == SettingGroups.feature_flags:
+                self._generate_command(cmd, field, "toggle")
+            elif group == SettingGroups.preferences:
+                self._generate_command(cmd, field, "set")
         self.update_completer(self.choices_default)
 
     def print_help(self):
         """Print help."""
-        settings = session.settings
-
         mt = MenuText("settings/")
-        mt.add_info("Feature flags")
-        mt.add_setting(
-            "interactive",
-            settings.USE_INTERACTIVE_DF,
-            description="open dataframes in interactive window",
-        )
-        mt.add_setting(
-            "cls",
-            settings.USE_CLEAR_AFTER_CMD,
-            description="clear console after each command",
-        )
-        mt.add_setting(
-            "promptkit",
-            settings.USE_PROMPT_TOOLKIT,
-            description="enable prompt toolkit (autocomplete and history)",
-        )
-        mt.add_setting(
-            "exithelp",
-            settings.ENABLE_EXIT_AUTO_HELP,
-            description="automatically print help when quitting menu",
-        )
-        mt.add_setting(
-            "rcontext",
-            settings.REMEMBER_CONTEXTS,
-            description="remember contexts between menus",
-        )
-        mt.add_setting(
-            "richpanel",
-            settings.ENABLE_RICH_PANEL,
-            description="colorful rich CLI panel",
-        )
-        mt.add_setting(
-            "tbhint",
-            settings.TOOLBAR_HINT,
-            description="displays usage hints in the bottom toolbar",
-        )
-        mt.add_setting(
-            "overwrite",
-            settings.FILE_OVERWRITE,
-            description="whether to overwrite Excel files if they already exists",
-        )
-        mt.add_setting(
-            "version",
-            settings.SHOW_VERSION,
-            description="whether to show the version in the bottom right corner",
-        )
-        mt.add_setting(
-            "obbject_msg",
-            settings.SHOW_MSG_OBBJECT_REGISTRY,
-            description="show obbject registry message after a new result is added",
-        )
+        mt.add_info("Feature Flags")
+        for k, f in self._COMMANDS.items():
+            if f.get("group") == SettingGroups.feature_flags:
+                mt.add_setting(
+                    name=k,
+                    status=getattr(session.settings, f["field_name"]),
+                    description=f["description"],
+                )
         mt.add_raw("\n")
         mt.add_info("Preferences")
-        mt.add_cmd("console_style", description="apply a custom rich style to the CLI")
-        mt.add_cmd("flair", description="choose flair icon")
-        mt.add_cmd("timezone", description="pick timezone")
-        mt.add_cmd(
-            "n_rows", description="number of rows to show on non interactive tables"
-        )
-        mt.add_cmd(
-            "n_cols", description="number of columns to show on non interactive tables"
-        )
-        mt.add_cmd(
-            "obbject_res",
-            description="define the maximum number of obbjects allowed in the registry",
-        )
-        mt.add_cmd(
-            "obbject_display",
-            description="define the maximum number of cached results to display on the help menu",
-        )
-
+        for k, f in self._COMMANDS.items():
+            if f.get("group") == SettingGroups.preferences:
+                mt.add_cmd(
+                    name=k,
+                    description=f["description"],
+                )
         session.console.print(text=mt.menu_text, menu="Settings")
 
-    def call_overwrite(self, _):
-        """Process overwrite command."""
-        session.settings.set_item("FILE_OVERWRITE", not session.settings.FILE_OVERWRITE)
-
-    def call_version(self, _):
-        """Process version command."""
-        session.settings.SHOW_VERSION = not session.settings.SHOW_VERSION
-
-    def call_interactive(self, _):
-        """Process interactive command."""
-        session.settings.set_item(
-            "USE_INTERACTIVE_DF", not session.settings.USE_INTERACTIVE_DF
-        )
-
-    def call_cls(self, _):
-        """Process cls command."""
-        session.settings.set_item(
-            "USE_CLEAR_AFTER_CMD", not session.settings.USE_CLEAR_AFTER_CMD
-        )
-
-    def call_promptkit(self, _):
-        """Process promptkit command."""
-        session.settings.set_item(
-            "USE_PROMPT_TOOLKIT", not session.settings.USE_PROMPT_TOOLKIT
-        )
-
-    def call_exithelp(self, _):
-        """Process exithelp command."""
-        session.settings.set_item(
-            "ENABLE_EXIT_AUTO_HELP", not session.settings.ENABLE_EXIT_AUTO_HELP
-        )
-
-    def call_rcontext(self, _):
-        """Process rcontext command."""
-        session.settings.set_item(
-            "REMEMBER_CONTEXTS", not session.settings.REMEMBER_CONTEXTS
-        )
-
-    def call_dt(self, _):
-        """Process dt command."""
-        session.settings.set_item("USE_DATETIME", not session.settings.USE_DATETIME)
-
-    def call_richpanel(self, _):
-        """Process richpanel command."""
-        session.settings.set_item(
-            "ENABLE_RICH_PANEL", not session.settings.ENABLE_RICH_PANEL
-        )
-
-    def call_tbhint(self, _):
-        """Process tbhint command."""
-        if session.settings.TOOLBAR_HINT:
-            session.console.print("Will take effect when running CLI again.")
-        session.settings.set_item("TOOLBAR_HINT", not session.settings.TOOLBAR_HINT)
-
-    def call_obbject_msg(self, _):
-        """Process obbject_msg command."""
-        session.settings.set_item(
-            "SHOW_MSG_OBBJECT_REGISTRY",
-            not session.settings.SHOW_MSG_OBBJECT_REGISTRY,
-        )
-
-    def call_console_style(self, other_args: List[str]) -> None:
-        """Process cosole_style command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="console_style",
-            description="Change your custom console style.",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-s",
-            "--style",
-            dest="style",
-            action="store",
-            required=False,
-            choices=session.style.available_styles,
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.style:
-            session.style.apply(ns_parser.style)
-            session.settings.set_item("RICH_STYLE", ns_parser.style)
-        elif not other_args:
-            session.console.print(
-                f"Current console style: {session.settings.RICH_STYLE}"
+    def _generate_command(
+        self, cmd_name: str, field: dict, action_type: Literal["toggle", "set"]
+    ):
+        """Generate command call."""
+
+        def _toggle(self, other_args: List[str], field=field) -> None:
+            """Toggle setting value."""
+            field_name = field["field_name"]
+            parser = argparse.ArgumentParser(
+                formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+                prog=field["command"],
+                description=field["description"],
+                add_help=False,
             )
-
-    def call_flair(self, other_args: List[str]) -> None:
-        """Process flair command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="flair",
-            description="Change your custom flair.",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-f",
-            "--flair",
-            dest="flair",
-            action="store",
-            required=False,
-            choices=list(AVAILABLE_FLAIRS.keys()),
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.flair:
-            session.settings.set_item("FLAIR", ns_parser.flair)
-        elif not other_args:
-            session.console.print(f"Current flair: {session.settings.FLAIR}")
-
-    def call_timezone(self, other_args: List[str]) -> None:
-        """Process timezone command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="timezone",
-            description="Change your custom timezone.",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-t",
-            "--timezone",
-            dest="timezone",
-            action="store",
-            required=False,
-            type=str,
-            choices=all_timezones,
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.timezone:
-            if is_timezone_valid(ns_parser.timezone):
-                session.settings.set_item("TIMEZONE", ns_parser.timezone)
-            else:
-                session.console.print(
-                    "Invalid timezone. Please enter a valid timezone."
-                )
-                session.console.print(
-                    f"Available timezones are: {', '.join(all_timezones)}"
+            ns_parser = self.parse_simple_args(parser, other_args)
+            if ns_parser:
+                session.settings.set_item(
+                    field_name, not getattr(session.settings, field_name)
                 )
-        elif not other_args:
-            session.console.print(f"Current timezone: {session.settings.TIMEZONE}")
-
-    def call_n_rows(self, other_args: List[str]) -> None:
-        """Process n_rows command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="n_rows",
-            description="Number of rows to show (when not using interactive tables).",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-r",
-            "--rows",
-            dest="rows",
-            action="store",
-            required=False,
-            type=int,
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.rows:
-            session.settings.set_item("ALLOWED_NUMBER_OF_ROWS", ns_parser.rows)
 
-        elif not other_args:
-            session.console.print(
-                f"Current number of rows: {session.settings.ALLOWED_NUMBER_OF_ROWS}"
+        def _set(self, other_args: List[str], field=field) -> None:
+            """Set preference value."""
+            field_name = field["field_name"]
+            annotation = field["annotation"]
+            command = field["command"]
+            type_ = str if get_origin(annotation) is Literal else annotation
+            choices = None
+            if get_origin(annotation) is Literal:
+                choices = annotation.__args__
+            elif command == "console_style":
+                # To have updated choices for console style
+                choices = session.style.available_styles
+            parser = argparse.ArgumentParser(
+                formatter_class=argparse.ArgumentDefaultsHelpFormatter,
+                prog=command,
+                description=field["description"],
+                add_help=False,
             )
-
-    def call_n_cols(self, other_args: List[str]) -> None:
-        """Process n_cols command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="n_cols",
-            description="Number of columns to show (when not using interactive tables).",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-c",
-            "--columns",
-            dest="columns",
-            action="store",
-            required=False,
-            type=int,
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.columns:
-            session.settings.set_item("ALLOWED_NUMBER_OF_COLUMNS", ns_parser.columns)
-
-        elif not other_args:
-            session.console.print(
-                f"Current number of columns: {session.settings.ALLOWED_NUMBER_OF_COLUMNS}"
-            )
-
-    def call_obbject_res(self, other_args: List[str]):
-        """Process obbject_res command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="obbject_res",
-            description="Maximum allowed number of results to keep in the OBBject Registry.",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-n",
-            "--number",
-            dest="number",
-            action="store",
-            required=False,
-            type=int,
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.number:
-            session.settings.set_item("N_TO_KEEP_OBBJECT_REGISTRY", ns_parser.number)
-
-        elif not other_args:
-            session.console.print(
-                f"Current maximum allowed number of results to keep in the OBBject registry:"
-                f" {session.settings.N_TO_KEEP_OBBJECT_REGISTRY}"
-            )
-
-    def call_obbject_display(self, other_args: List[str]):
-        """Process obbject_display command."""
-        parser = argparse.ArgumentParser(
-            formatter_class=argparse.ArgumentDefaultsHelpFormatter,
-            prog="obbject_display",
-            description="Number of results to display from the OBBject Registry.",
-            add_help=False,
-        )
-        parser.add_argument(
-            "-n",
-            "--number",
-            dest="number",
-            action="store",
-            required=False,
-            type=int,
-        )
-        ns_parser = self.parse_simple_args(parser, other_args)
-
-        if ns_parser and ns_parser.number:
-            session.settings.set_item("N_TO_DISPLAY_OBBJECT_REGISTRY", ns_parser.number)
-
-        elif not other_args:
-            session.console.print(
-                f"Current number of results to display from the OBBject registry:"
-                f" {session.settings.N_TO_DISPLAY_OBBJECT_REGISTRY}"
+            parser.add_argument(
+                "-v",
+                "--value",
+                dest="value",
+                action="store",
+                required=False,
+                type=type_,  # type: ignore[arg-type]
+                choices=choices,
             )
+            ns_parser = self.parse_simple_args(parser, other_args)
+            if ns_parser:
+                if ns_parser.value:
+                    # Console style is applied immediately
+                    if command == "console_style":
+                        session.style.apply(ns_parser.value)
+                    session.settings.set_item(field_name, ns_parser.value)
+                    session.console.print(
+                        f"[info]Current value:[/info] {getattr(session.settings, field_name)}"
+                    )
+                elif not other_args:
+                    session.console.print(
+                        f"[info]Current value:[/info] {getattr(session.settings, field_name)}"
+                    )
+
+        action = None
+        if action_type == "toggle":
+            action = _toggle
+        elif action_type == "set":
+            action = _set
+        else:
+            raise ValueError(f"Action type '{action_type}' not allowed.")
+
+        bound_method = update_wrapper(
+            wrapper=partial(MethodType(action, self), field=field), wrapped=action
+        )
+        setattr(self, f"call_{cmd_name}", bound_method)
diff --git a/cli/openbb_cli/controllers/utils.py b/cli/openbb_cli/controllers/utils.py
index a77c93eb683..c85bf236c5d 100644
--- a/cli/openbb_cli/controllers/utils.py
+++ b/cli/openbb_cli/controllers/utils.py
@@ -16,6 +16,7 @@ from typing import TYPE_CHECKING, Dict, List, Optional, Tuple, Union
 import numpy as np
 import pandas as pd
 import requests
+from openbb import obb
 from openbb_charting.core.backend import create_backend, get_backend
 from openbb_cli.config.constants import AVAILABLE_FLAIRS, ENV_FILE_SETTINGS
 from openbb_cli.session import Session
@@ -23,8 +24,6 @@ from openbb_core.app.model.charts.charting_settings import ChartingSettings
 from pytz import all_timezones, timezone
 from rich.table import Table
 
-from openbb import obb
-
 if TYPE_CHECKING:
     from openbb_charting.core.openbb_figure import OpenBBFigure
 
@@ -33,6 +32,8 @@ if TYPE_CHECKING:
 
 # pylint: disable=too-many-statements,no-member,too-many-branches,C0302
 
+session = Session()
+
 
 def remove_file(path: Path) -> bool:
     """Remove path.
@@ -55,7 +56,7 @@ def remove_file(path: Path) -> bool:
             shutil.rmtree(path)
         return True
     except Exception:
-        Session().console.print(
+        session.console.print(
             f"\n[bold red]Failed to remove {path}"
             "\nPlease delete this manually![/bold red]"
         )
@@ -88,17 +89,17 @@ Please feel free to check out our other products:
 [bold]OpenBB Platform:[/]     [cmds]https://openbb.co/products/platform[/cmds]
 [bold]OpenBB Bot[/]:          [cmds]https://openbb.co/products/bot[/cmds]
     """
-    Session().console.print(text)
+    sessio