openbb-cli 1.0.2__tar.gz → 1.0.4__tar.gz

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: openbb-cli
-Version: 1.0.2
+Version: 1.0.4
 Summary: Investment Research for Everyone, Anywhere.
 Home-page: https://openbb.co
 License: AGPL-3.0-only
@@ -12,8 +12,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Requires-Dist: openbb-core (>=1.2.4,<2.0.0)
-Requires-Dist: openbb[all] (>=4.2.1,<5.0.0)
+Requires-Dist: openbb[all] (>=4.2.3,<5.0.0)
 Requires-Dist: openpyxl (>=3.1.2,<4.0.0)
 Requires-Dist: prompt-toolkit (>=3.0.16,<4.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/argparse_translator/obbject_registry.py

@@ -1,7 +1,7 @@
 """Registry for OBBjects."""
 
 import json
-from typing import Dict, List
+from typing import Dict, List, Optional, Union
 
 from openbb_core.app.model.obbject import OBBject
 
@@ -29,11 +29,32 @@ class Registry:
             return True
         return False
 
-    def get(self, idx: int) -> OBBject:
+    def get(self, arg: Union[int, str]) -> Optional[OBBject]:
+        """Return the obbject with index or key."""
+        if isinstance(arg, int):
+            return self._get_by_index(arg)
+        if isinstance(arg, str):
+            return self._get_by_key(arg)
+
+        raise ValueError("Couldn't get the `OBBject` with the provided argument.")
+
+    def _get_by_key(self, key: str) -> Optional[OBBject]:
+        """Return the obbject with key."""
+        for obbject in self._obbjects:
+            if obbject.extra.get("register_key", "") == key:
+                return obbject
+        return None
+
+    def _get_by_index(self, idx: int) -> Optional[OBBject]:
         """Return the obbject at index idx."""
         # the list should work as a stack
         # i.e., the last element needs to be accessed by idx=0 and so on
         reversed_list = list(reversed(self._obbjects))
+
+        # check if the index is out of bounds
+        if idx >= len(reversed_list):
+            return None
+
         return reversed_list[idx]
 
     def remove(self, idx: int = -1):
@@ -46,22 +67,24 @@ class Registry:
 
     @property
     def all(self) -> Dict[int, Dict]:
-        """Return all obbjects in the registry"""
+        """Return all obbjects in the registry."""
 
         def _handle_standard_params(obbject: OBBject) -> str:
-            """Handle standard params for obbjects"""
+            """Handle standard params for obbjects."""
             standard_params_json = ""
-            std_params = obbject._standard_params  # pylint: disable=protected-access
-            if hasattr(std_params, "__dict__"):
+            std_params = getattr(
+                obbject, "_standard_params", {}
+            )  # pylint: disable=protected-access
+            if std_params:
                 standard_params = {
-                    k: str(v)[:30] for k, v in std_params.__dict__.items() if v
+                    k: str(v)[:30] for k, v in std_params.items() if v and k != "data"
                 }
                 standard_params_json = json.dumps(standard_params)
 
             return standard_params_json
 
         def _handle_data_repr(obbject: OBBject) -> str:
-            """Handle data representation for obbjects"""
+            """Handle data representation for obbjects."""
             data_repr = ""
             if hasattr(obbject, "results") and obbject.results:
                 data_schema = (
@@ -84,11 +107,21 @@ class Registry:
                 "standard params": _handle_standard_params(obbject),
                 "data": _handle_data_repr(obbject),
                 "command": obbject.extra.get("command", ""),
+                "key": obbject.extra.get("register_key", ""),
             }
 
         return obbjects
 
     @property
     def obbjects(self) -> List[OBBject]:
-        """Return all obbjects in the registry"""
+        """Return all obbjects in the registry."""
         return self._obbjects
+
+    @property
+    def obbject_keys(self) -> List[str]:
+        """Return all obbject keys in the registry."""
+        return [
+            obbject.extra["register_key"]
+            for obbject in self._obbjects
+            if "register_key" in obbject.extra
+        ]

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/argparse_translator/reference_processor.py

@@ -1,8 +1,13 @@
 """Module for the ReferenceToArgumentsProcessor class."""
 
+# `ForwardRef`needs to be imported because the usage of `eval()`,
+# which creates a ForwardRef
+# which would raise a not defined error if it's not imported here.
+# pylint: disable=unused-import
 from typing import (
     Any,
     Dict,
+    ForwardRef,  # noqa: F401
     List,
     Literal,
     Optional,

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/argparse_translator/utils.py

@@ -59,9 +59,14 @@ def get_argument_optional_choices(parser: ArgumentParser, argument_name: str) ->
     """Get the optional_choices attribute of an argument from an ArgumentParser."""
     for action in parser._actions:  # pylint: disable=protected-access
         opts = action.option_strings
-        if (opts and opts[0] == argument_name) or action.dest == argument_name:
-            if hasattr(action, "optional_choices"):
-                return action.optional_choices
+        if (
+            (opts and opts[0] == argument_name)
+            or action.dest == argument_name
+            and hasattr(action, "optional_choices")
+        ):
+            return (
+                action.optional_choices  # type: ignore[attr-defined] # this is a custom attribute
+            )
     return False
 
 

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/cli.py

@@ -2,6 +2,8 @@
 
 import sys
 
+from openbb_cli.utils.utils import change_logging_sub_app, reset_logging_sub_app
+
 
 def main():
     """Use the main entry point for the OpenBB Platform CLI."""
@@ -20,4 +22,10 @@ def main():
 
 
 if __name__ == "__main__":
-    main()
+    initial_logging_sub_app = change_logging_sub_app()
+    try:
+        main()
+    except Exception:
+        pass
+    finally:
+        reset_logging_sub_app(initial_logging_sub_app)

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/controllers/base_controller.py

@@ -24,6 +24,7 @@ from openbb_cli.controllers.utils import (
     print_rich_table,
     remove_file,
     system_clear,
+    validate_register_key,
 )
 from openbb_cli.session import Session
 from prompt_toolkit.formatted_text import HTML
@@ -138,27 +139,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 +150,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.
@@ -646,19 +629,77 @@ class BaseController(metaclass=ABCMeta):
             "'OBBjects' where all execution results are stored. "
             "It is organized as a stack, with the most recent result at index 0.",
         )
+        parser.add_argument("--index", dest="index", help="Index of the result.")
+        parser.add_argument("--key", dest="key", help="Key of the result.")
+        parser.add_argument(
+            "--chart", action="store_true", dest="chart", help="Display chart."
+        )
+        parser.add_argument(
+            "--export", dest="export", help="Export data.", nargs="+", default=None
+        )
+
         ns_parser = self.parse_simple_args(parser, other_args)
         if ns_parser:
-            results = session.obbject_registry.all
-            if results:
-                df = pd.DataFrame.from_dict(results, orient="index")
-                print_rich_table(
-                    df,
-                    show_index=True,
-                    index_name="stack index",
-                    title="OBBject Results",
-                )
-            else:
-                session.console.print("[info]No results found.[/info]")
+            if not ns_parser.index and not ns_parser.key:
+                results = session.obbject_registry.all
+                if results:
+                    df = pd.DataFrame.from_dict(results, orient="index")
+                    print_rich_table(
+                        df,
+                        show_index=True,
+                        index_name="stack index",
+                        title="OBBject Results",
+                    )
+                else:
+                    session.console.print("[info]No results found.[/info]")
+            elif ns_parser.index:
+                try:
+                    index = int(ns_parser.index)
+                    obbject = session.obbject_registry.get(index)
+                    if obbject:
+                        if ns_parser.chart and obbject.chart:
+                            obbject.show()
+                        else:
+                            title = obbject.extra.get("command", "")
+                            df = obbject.to_dataframe()
+                            print_rich_table(
+                                df=df,
+                                show_index=True,
+                                title=title,
+                                export=ns_parser.export,
+                            )
+                            if ns_parser.chart and not obbject.chart:
+                                session.console.print(
+                                    "[info]No chart available.[/info]"
+                                )
+                    else:
+                        session.console.print(
+                            f"[info]No result found at index {index}.[/info]"
+                        )
+                except ValueError:
+                    session.console.print(
+                        f"[red]Index must be an integer, not '{ns_parser.index}'.[/red]"
+                    )
+            elif ns_parser.key:
+                obbject = session.obbject_registry.get(ns_parser.key)
+                if obbject:
+                    if ns_parser.chart and obbject.chart:
+                        obbject.show()
+                    else:
+                        title = obbject.extra.get("command", "")
+                        df = obbject.to_dataframe()
+                        print_rich_table(
+                            df=df,
+                            show_index=True,
+                            title=title,
+                            export=ns_parser.export,
+                        )
+                        if ns_parser.chart and not obbject.chart:
+                            session.console.print("[info]No chart available.[/info]")
+                else:
+                    session.console.print(
+                        f"[info]No result found with key '{ns_parser.key}'.[/info]"
+                    )
 
     @staticmethod
     def parse_simple_args(parser: argparse.ArgumentParser, other_args: List[str]):
@@ -792,6 +833,22 @@ class BaseController(metaclass=ABCMeta):
                 help="Number of entries to show in data.",
                 type=check_positive,
             )
+
+        parser.add_argument(
+            "--register_obbject",
+            dest="register_obbject",
+            action="store_false",
+            default=True,
+            help="Flag to store data in the OBBject registry, True by default.",
+        )
+        parser.add_argument(
+            "--register_key",
+            dest="register_key",
+            default="",
+            help="Key to reference data in the OBBject registry.",
+            type=validate_register_key,
+        )
+
         if session.settings.USE_CLEAR_AFTER_CMD:
             system_clear()
 

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/controllers/base_platform_controller.py

@@ -75,20 +75,31 @@ class PlatformController(BaseController):
         for _, trl in self.translators.items():
             for action in trl._parser._actions:  # pylint: disable=protected-access
                 if action.dest == "data":
+                    # Generate choices by combining indexed and key-based choices
                     action.choices = [
                         "OBB" + str(i)
                         for i in range(len(session.obbject_registry.obbjects))
+                    ] + [
+                        obbject.extra["register_key"]
+                        for obbject in session.obbject_registry.obbjects
+                        if "register_key" in obbject.extra
                     ]
+
                     action.type = str
                     action.nargs = None
 
     def _intersect_data_processing_commands(self, ns_parser):
         """Intersect data processing commands and change the obbject id into an actual obbject."""
         if hasattr(ns_parser, "data"):
-            ns_parser.data = int(ns_parser.data.replace("OBB", ""))
-            if ns_parser.data in range(len(session.obbject_registry.obbjects)):
+            if "OBB" in ns_parser.data:
+                ns_parser.data = int(ns_parser.data.replace("OBB", ""))
+
+            if (ns_parser.data in range(len(session.obbject_registry.obbjects))) or (
+                ns_parser.data in session.obbject_registry.obbject_keys
+            ):
                 obbject = session.obbject_registry.get(ns_parser.data)
-                setattr(ns_parser, "data", obbject.results)
+                if obbject and isinstance(obbject, OBBject):
+                    setattr(ns_parser, "data", obbject.results)
 
         return ns_parser
 
@@ -151,6 +162,11 @@ class PlatformController(BaseController):
             ):
                 try:
                     ns_parser = self._intersect_data_processing_commands(ns_parser)
+                    export = hasattr(ns_parser, "export") and ns_parser.export
+                    store_obbject = (
+                        hasattr(ns_parser, "register_obbject")
+                        and ns_parser.register_obbject
+                    )
 
                     obbject = translator.execute_func(parsed_args=ns_parser)
                     df: pd.DataFrame = pd.DataFrame()
@@ -159,7 +175,11 @@ class PlatformController(BaseController):
 
                     if obbject:
                         if isinstance(obbject, OBBject):
-                            if session.max_obbjects_exceeded() and obbject.results:
+                            if (
+                                session.max_obbjects_exceeded()
+                                and obbject.results
+                                and store_obbject
+                            ):
                                 session.obbject_registry.remove()
                                 session.console.print(
                                     "[yellow]Maximum number of OBBjects reached. The oldest entry was removed.[yellow]"
@@ -167,48 +187,69 @@ class PlatformController(BaseController):
 
                             # use the obbject to store the command so we can display it later on results
                             obbject.extra["command"] = f"{title} {' '.join(other_args)}"
-
-                            register_result = session.obbject_registry.register(obbject)
-
-                            # we need to force to re-link so that the new obbject
-                            # is immediately available for data processing commands
-                            self._link_obbject_to_data_processing_commands()
-                            # also update the completer
-                            self.update_completer(self.choices_default)
-
+                            # if there is a registry key in the parser, store to the obbject
                             if (
-                                session.settings.SHOW_MSG_OBBJECT_REGISTRY
-                                and register_result
+                                hasattr(ns_parser, "register_key")
+                                and ns_parser.register_key
                             ):
-                                session.console.print(
-                                    "Added `OBBject` to cached results."
+                                if (
+                                    ns_parser.register_key
+                                    not in session.obbject_registry.obbject_keys
+                                ):
+                                    obbject.extra["register_key"] = str(
+                                        ns_parser.register_key
+                                    )
+                                else:
+                                    session.console.print(
+                                        f"[yellow]Key `{ns_parser.register_key}` already exists in the registry."
+                                        "The `OBBject` was kept without the key.[/yellow]"
+                                    )
+
+                            if store_obbject:
+                                # store the obbject in the registry
+                                register_result = session.obbject_registry.register(
+                                    obbject
                                 )
 
-                            # making the dataframe available
-                            # either for printing or exporting (or both)
+                                # we need to force to re-link so that the new obbject
+                                # is immediately available for data processing commands
+                                self._link_obbject_to_data_processing_commands()
+                                # also update the completer
+                                self.update_completer(self.choices_default)
+
+                                if (
+                                    session.settings.SHOW_MSG_OBBJECT_REGISTRY
+                                    and register_result
+                                ):
+                                    session.console.print(
+                                        "Added `OBBject` to cached results."
+                                    )
+
+                            # making the dataframe available either for printing or exporting
                             df = obbject.to_dataframe()
 
                             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]
@@ -221,7 +262,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:

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/controllers/choices.py

@@ -10,6 +10,7 @@ from unittest.mock import patch
 from openbb_cli.controllers.utils import (
     check_file_type_saved,
     check_positive,
+    validate_register_key,
 )
 from openbb_cli.session import Session
 
@@ -93,6 +94,21 @@ def __mock_parse_known_args_and_warn(
             type=check_positive,
         )
 
+    parser.add_argument(
+        "--register_obbject",
+        dest="register_obbject",
+        action="store_false",
+        default=True,
+        help="Flag to store data in the OBBject registry, True by default.",
+    )
+    parser.add_argument(
+        "--register_key",
+        dest="register_key",
+        default="",
+        help="Key to reference data in the OBBject registry.",
+        type=validate_register_key,
+    )
+
 
 def __mock_parse_simple_args(parser: ArgumentParser, other_args: List[str]) -> None:
     """Add arguments.
@@ -274,6 +290,7 @@ def _get_argument_parser(
                 " - parse_known_args_and_warn\n"
             )
 
+    # pylint: disable=possibly-used-before-assignment
     return argument_parser
 
 

{openbb_cli-1.0.2 → openbb_cli-1.0.4}/openbb_cli/controllers/cli_controller.py

@@ -4,7 +4,6 @@
 import argparse
 import contextlib
 import difflib
-import logging
 import os
 import re
 import sys
@@ -59,8 +58,6 @@ DATA_PROCESSING_ROUTERS = ["technical", "quantitative", "econometrics"]
 # pylint: disable=too-many-public-methods,import-outside-toplevel, too-many-function-args
 # pylint: disable=too-many-branches,no-member,C0302,too-many-return-statements, inconsistent-return-statements
 
-logger = logging.getLogger(__name__)
-
 env_file = str(ENV_FILE_SETTINGS)
 session = Session()
 
@@ -205,7 +202,14 @@ class CLIController(BaseController):
                 "-h": "--help",
             }
             choices["stop"] = {"--help": None, "-h": "--help"}
-            choices["results"] = {"--help": None, "-h": "--help"}
+            choices["results"] = {
+                "--help": None,
+                "-h": "--help",
+                "--export": None,
+                "--index": None,
+                "--key": None,
+                "--chart": None,
+            }
 
             self.update_completer(choices)
 
@@ -291,7 +295,7 @@ class CLIController(BaseController):
                 : session.settings.N_TO_DISPLAY_OBBJECT_REGISTRY
             ]:
                 mt.add_raw(
-                    f"[yellow]OBB{key}[/yellow]: {value['command']}",
+                    f"[yellow]OBB{key}[/yellow]: {value['command']}",  # type: ignore[index]
                     left_spacing=True,
                 )
 
@@ -497,11 +501,6 @@ class CLIController(BaseController):
 
 def handle_job_cmds(jobs_cmds: Optional[List[str]]) -> Optional[List[str]]:
     """Handle job commands."""
-    # If the path selected does not start from the user root,
-    # give relative location from root
-    if jobs_cmds is not None and jobs_cmds:
-        logger.info("INPUT: %s", "/".join(jobs_cmds))
-
     export_path = ""
     if jobs_cmds and "export" in jobs_cmds[0]:
         commands = jobs_cmds[0].split("/")
@@ -619,10 +618,6 @@ def run_cli(jobs_cmds: Optional[List[str]] = None, test_mode=False):
                 break
 
         except SystemExit:
-            logger.exception(
-                "The command '%s' doesn't exist on the / menu.",
-                an_input,
-            )
             session.console.print(
                 f"[red]The command '{an_input}' doesn't exist on the / menu.[/red]\n",
             )
@@ -769,7 +764,6 @@ def replace_dynamic(match: re.Match, special_arguments: Dict[str, str]) -> str:
     str
         The new string
     """
-
     cleaned = match[0].replace("{", "").replace("}", "").replace("$", "")
     key, default = cleaned.split("=")
     dict_value = special_arguments.get(key, default)
@@ -939,7 +933,6 @@ def launch(
     debug: bool = False, dev: bool = False, queue: Optional[List[str]] = None
 ) -> None:
     """Launch CLI."""
-
     if queue:
         main(debug, dev, queue, module="")
     else: