openbb-cli 1.3.0__tar.gz → 1.4.1__tar.gz

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/PKG-INFO

@@ -1,18 +1,19 @@
 Metadata-Version: 2.4
 Name: openbb-cli
-Version: 1.3.0
+Version: 1.4.1
 Summary: Investment Research for Everyone, Anywhere.
 License: AGPL-3.0-only
 Author: OpenBB
 Author-email: hello@openbb.co
-Requires-Python: >=3.10,<3.14
+Requires-Python: >=3.10,<4
 Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Requires-Dist: openbb[all] (>=4.6.0,<5.0.0)
+Classifier: Programming Language :: Python :: 3.14
+Requires-Dist: openbb[all] (>=4.7.1,<5.0.0)
 Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
 Requires-Dist: prompt-toolkit (>=3.0.50,<4.0.0)
 Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/openbb_cli/argparse_translator/argparse_translator.py

@@ -88,6 +88,8 @@ class ArgparseTranslator:
         # check if the argument is already in use, if not, add it
         if f"--{argument.name}" not in self._parser._option_string_actions:
             kwargs = argument.model_dump(exclude={"name"}, exclude_none=True)
+            if "help" in kwargs:
+                kwargs["help"] = ArgparseTranslator._escape_help(kwargs["help"])
             group.add_argument(f"--{argument.name}", **kwargs)
             if group.title in self.provider_parameters:
                 self.provider_parameters[group.title].append(argument.name)
@@ -119,8 +121,8 @@ class ArgparseTranslator:
                             set_optional_choices(action, optional_choices)
                         if argument.name not in self.signature.parameters:
                             # update help
-                            action.help = _update_providers(
-                                action.help or "", [group.title]
+                            action.help = ArgparseTranslator._escape_help(
+                                _update_providers(action.help or "", [group.title])
                             )
                 return
 
@@ -140,7 +142,9 @@ class ArgparseTranslator:
             if choices:
                 kwargs["choices"] = choices  # update choices
             # add provider info to the help
-            kwargs["help"] = _update_providers(argument.help or "", groups_w_arg)
+            kwargs["help"] = ArgparseTranslator._escape_help(
+                _update_providers(argument.help or "", groups_w_arg)
+            )
             action = self._parser.add_argument(f"--{argument.name}", **kwargs)
             set_optional_choices(action, optional_choices)
 
@@ -149,96 +153,65 @@ class ArgparseTranslator:
         """Get the argparse parser."""
         return deepcopy(self._parser)
 
+    @staticmethod
+    def _escape_help(text: str | None) -> str | None:
+        """Escape percent signs in help strings for argparse.
+
+        Python 3.14+ validates help strings at add_argument time using
+        %-formatting. Bare '%' characters that aren't valid format
+        specifiers (like '%(default)s') cause a ValueError.
+        """
+        if text is None:
+            return None
+        return text.replace("%", "%%")
+
     @staticmethod
     def _build_description(func_doc: str) -> str:
         """Build the description of the argparse program from the function docstring."""
-        # Remove only the Examples section and the openbb header if present
-        patterns_to_remove = [
-            (r"openbb\n\s+={3,}\n", ""),  # Remove openbb header
-            (r"\n\s*Examples\n\s*-{3,}\n.*", ""),  # Remove Examples section to end
-        ]
+        if not func_doc:
+            return ""
+
+        # Remove the openbb header if present
+        func_doc = re.sub(r"openbb\n\s+={3,}\n", "", func_doc, flags=re.DOTALL)
 
-        for pattern, replacement in patterns_to_remove:
-            func_doc = re.sub(pattern, replacement, func_doc, flags=re.DOTALL)
+        # Senior Approach: The main description should only be the summary.
+        # Sections like Parameters, Returns, and Examples are handled by argparse or are redundant.
+        for section in ["Parameters", "Returns", "Examples", "Raises"]:
+            pattern = rf"\n\s*{section}\n\s*-{{3,}}\n.*"
+            func_doc = re.sub(pattern, "", func_doc, flags=re.DOTALL | re.IGNORECASE)
 
-        # Clean up type annotations in docstrings
+        # Clean up any remaining type-style annotations in the summary
         def clean_type_annotation(type_str: str) -> str:
-            """Clean up a single type annotation."""
-            # First, handle the pipe union syntax: type1 | type2 -> type1 or type2
-            # Do this FIRST before other transformations
+            """Clean up type annotations for human readability."""
+            # Handle pipe unions: int | str -> int or str
             type_str = re.sub(r"\s*\|\s*", " or ", type_str)
-
             # Handle Annotated[type, ...] -> type
-            type_str = re.sub(r"Annotated\[([^,\]]+)(?:,\s*[^\]]+)?\]", r"\1", type_str)
-
-            # Handle Union[type1, type2, ...] -> type1 or type2 or ...
+            type_str = re.sub(r"Annotated\[\s*([^,\]]+).*?\]", r"\1", type_str)
+            # Handle Union[A, B] -> A or B
             type_str = re.sub(
-                r"Union\[([^\]]+)\]",
-                lambda m: " or ".join(m.group(1).split(", ")),
+                r"Union\[\s*(.*?)\s*\]",
+                lambda m: m.group(1).replace(", ", " or "),
                 type_str,
             )
+            # Handle Optional[A] -> A or None
+            type_str = re.sub(r"Optional\[\s*(.*?)\s*\]", r"\1 or None", type_str)
 
-            # Handle Optional[type] -> type or None
-            type_str = re.sub(r"Optional\[([^\]]+)\]", r"\1 or None", type_str)
-
-            # Deduplicate "or" separated types
-            parts = [p.strip() for p in type_str.split(" or ")]
+            return type_str.strip()
 
-            # Remove duplicates while preserving order (case-insensitive)
-            seen = set()
-            unique_parts = []
-            for part in parts:
-                part_lower = part.lower()
-                if part_lower not in seen:
-                    seen.add(part_lower)
-                    unique_parts.append(part)
-
-            # If None is present, move it to the end
-            if "None" in unique_parts:
-                unique_parts.remove("None")
-                unique_parts.append("None")
-
-            type_str = " or ".join(unique_parts)
-
-            return type_str
-
-        # Process each line that contains a type annotation (format: "name : type")
         lines = func_doc.split("\n")
         cleaned_lines = []
-
         for line in lines:
-            # Match lines with type annotations (parameter_name : type_annotation)
+            # If a line still looks like a parameter definition (e.g. "param : type"), clean it
             if ":" in line and not line.strip().startswith("#"):
-                # Split only on the first colon to preserve any colons in the description
                 parts = line.split(":", 1)
-                if len(parts) == 2:
-                    param_name = parts[0]
-                    rest = parts[1].strip()
-
-                    # Extract the type part (everything before the first real description line)
-                    # Type annotations typically don't contain spaces at the start of continuation lines
-                    type_match = re.match(r"^([^\n]+?)(?:\n\s{4,}|\s{2,}|$)", rest)
-                    if type_match:
-                        type_part = type_match.group(1).strip()
-                        description_part = rest[len(type_match.group(1)) :]
-
-                        # Clean the type annotation
-                        cleaned_type = clean_type_annotation(type_part)
-
-                        # Reconstruct the line
-                        if description_part:
-                            cleaned_lines.append(
-                                f"{param_name}: {cleaned_type}{description_part}"
-                            )
-                        else:
-                            cleaned_lines.append(f"{param_name}: {cleaned_type}")
-                        continue
-
-            cleaned_lines.append(line)
-
-        func_doc = "\n".join(cleaned_lines)
+                param_name = parts[0]
+                type_info = parts[1].strip()
+                cleaned_type = clean_type_annotation(type_info)
+                cleaned_lines.append(f"{param_name}: {cleaned_type}")
+            else:
+                cleaned_lines.append(line)
 
-        return func_doc.strip()
+        return "\n".join(cleaned_lines).strip()
 
     @staticmethod
     def _param_is_default(param: inspect.Parameter) -> bool:
@@ -448,7 +421,7 @@ class ArgparseTranslator:
                 default=param.default,
                 required=required,
                 action=action,
-                help=self._get_argument_custom_help(param),
+                help=self._escape_help(self._get_argument_custom_help(param)),
                 nargs=self._get_nargs(param),
                 choices=choices,
             )

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/openbb_cli/controllers/base_platform_controller.py

@@ -236,7 +236,7 @@ class PlatformController(BaseController):
                                 if not export:
                                     obbject.show()
                             elif session.settings.USE_INTERACTIVE_DF and not export:
-                                obbject.charting.table()
+                                obbject.charting.table()  # type: ignore[attr-defined]
                             else:
                                 if isinstance(df.columns, pd.RangeIndex):
                                     df.columns = [str(i) for i in df.columns]

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/openbb_cli/controllers/settings_controller.py

@@ -3,7 +3,7 @@
 import argparse
 from functools import partial, update_wrapper
 from types import MethodType
-from typing import Literal, get_origin
+from typing import Any, Literal, cast, get_origin
 
 from openbb_cli.config.menu_text import MenuText
 from openbb_cli.controllers.base_controller import BaseController
@@ -13,20 +13,26 @@ from openbb_cli.session import Session
 session = Session()
 
 
+def _get_extra(field: Any) -> dict[str, Any]:
+    """Safely extract json_schema_extra as a dict."""
+    extra = field.json_schema_extra
+    return cast(dict[str, Any], extra) if isinstance(extra, dict) else {}
+
+
 class SettingsController(BaseController):
     """Settings Controller class."""
 
-    _COMMANDS = {
-        v.json_schema_extra.get("command"): {
-            "command": (v.json_schema_extra or {}).get("command"),
-            "group": (v.json_schema_extra or {}).get("group"),
+    _COMMANDS: dict[str, dict[str, Any]] = {
+        _get_extra(v).get("command", ""): {
+            "command": _get_extra(v).get("command"),
+            "group": _get_extra(v).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", ""),
+            key=lambda item: _get_extra(item[1]).get("command", ""),
         )
         if v.json_schema_extra
     }
@@ -39,9 +45,9 @@ class SettingsController(BaseController):
         super().__init__(queue)
         for cmd, field in self._COMMANDS.items():
             group = field.get("group")
-            if group == SettingGroups.feature_flags:
+            if group == SettingGroups.feature_flags.value:
                 self._generate_command(cmd, field, "toggle")
-            elif group == SettingGroups.preferences:
+            elif group == SettingGroups.preferences.value:
                 self._generate_command(cmd, field, "set")
         self.update_completer(self.choices_default)
 
@@ -50,7 +56,7 @@ class SettingsController(BaseController):
         mt = MenuText("settings/")
         mt.add_info("Feature Flags")
         for k, f in self._COMMANDS.items():
-            if f.get("group") == SettingGroups.feature_flags:
+            if f.get("group") == SettingGroups.feature_flags.value:
                 mt.add_setting(
                     name=k,
                     status=getattr(session.settings, f["field_name"]),
@@ -59,7 +65,7 @@ class SettingsController(BaseController):
         mt.add_raw("\n")
         mt.add_info("Preferences")
         for k, f in self._COMMANDS.items():
-            if f.get("group") == SettingGroups.preferences:
+            if f.get("group") == SettingGroups.preferences.value:
                 mt.add_cmd(
                     name=k,
                     description=f["description"],

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/openbb_cli/controllers/utils.py

@@ -1,6 +1,7 @@
 """Utils."""
 
 import argparse
+import ast
 import os
 import random
 import re
@@ -379,7 +380,7 @@ def print_rich_table(  # noqa: PLR0912
                     )
 
         if columns_to_auto_color is None and rows_to_auto_color is None:
-            df = df.applymap(lambda x: return_colored_value(str(x)))  # type: ignore
+            df = df.map(lambda x: return_colored_value(str(x)))  # type: ignore
 
     exceeds_allowed_columns = len(df.columns) > MAX_COLS
     exceeds_allowed_rows = len(df) > MAX_ROWS
@@ -920,13 +921,11 @@ def parse_unknown_args_to_dict(unknown_args: list[str] | None) -> dict[str, str]
             if arg.startswith("--"):
                 if idx + 1 < len(unknown_args):
                     try:
-                        unknown_args_dict[arg.replace("--", "")] = (
-                            eval(  # noqa: S307, E501 pylint: disable=eval-used
-                                unknown_args[idx + 1]
-                            )
+                        unknown_args_dict[arg.replace("--", "")] = ast.literal_eval(
+                            unknown_args[idx + 1]
                         )
-                    except Exception:
-                        unknown_args_dict[arg] = unknown_args[idx + 1]
+                    except (ValueError, SyntaxError):
+                        unknown_args_dict[arg.replace("--", "")] = unknown_args[idx + 1]
                 else:
                     session.console.print(
                         f"Missing value for argument {arg}. Skipping this argument."

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/openbb_cli/models/settings.py

@@ -41,106 +41,140 @@ class Settings(BaseModel):
     FILE_OVERWRITE: bool = Field(
         default=False,
         description="whether to overwrite Excel files if they already exists",
-        command="overwrite",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "overwrite",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     SHOW_VERSION: bool = Field(
         default=True,
         description="whether to show the version in the bottom right corner",
-        command="version",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "version",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     USE_INTERACTIVE_DF: bool = Field(
         default=True,
         description="display tables in interactive window",
-        command="interactive",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "interactive",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     USE_CLEAR_AFTER_CMD: bool = Field(
         default=False,
         description="clear console after each command",
-        command="cls",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "cls",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     USE_DATETIME: bool = Field(
         default=True,
         description="whether to show the date and time before the flair",
-        command="datetime",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "datetime",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     USE_PROMPT_TOOLKIT: bool = Field(
         default=True,
         description="enable prompt toolkit (autocomplete and history)",
-        command="promptkit",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "promptkit",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     ENABLE_EXIT_AUTO_HELP: bool = Field(
         default=True,
         description="automatically print help when quitting menu",
-        command="exithelp",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "exithelp",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     ENABLE_RICH_PANEL: bool = Field(
         default=True,
         description="enable colorful rich CLI panel",
-        command="richpanel",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "richpanel",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     TOOLBAR_HINT: bool = Field(
         default=True,
         description="displays usage hints in the bottom toolbar",
-        command="tbhint",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "tbhint",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
     SHOW_MSG_OBBJECT_REGISTRY: bool = Field(
         default=False,
         description="show obbject registry message after a new result is added",
-        command="obbject_msg",
-        group=SettingGroups.feature_flags,
+        json_schema_extra={
+            "command": "obbject_msg",
+            "group": SettingGroups.feature_flags.value,
+        },
     )
 
     # PREFERENCES
     TIMEZONE: Literal[tuple(all_timezones)] = Field(  # type: ignore[valid-type]
         default="America/New_York",
         description="pick timezone",
-        command="timezone",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "timezone",
+            "group": SettingGroups.preferences.value,
+        },
     )
     FLAIR: Literal[tuple(AVAILABLE_FLAIRS)] = Field(  # type: ignore[valid-type]
         default=":openbb",
         description="choose flair icon",
-        command="flair",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "flair",
+            "group": SettingGroups.preferences.value,
+        },
     )
     N_TO_KEEP_OBBJECT_REGISTRY: int = Field(
         default=10,
         description="define the maximum number of obbjects allowed in the registry",
-        command="obbject_res",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "obbject_res",
+            "group": SettingGroups.preferences.value,
+        },
     )
     N_TO_DISPLAY_OBBJECT_REGISTRY: int = Field(
         default=5,
         description="define the maximum number of cached results to display on the help menu",
-        command="obbject_display",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "obbject_display",
+            "group": SettingGroups.preferences.value,
+        },
     )
     RICH_STYLE: str = Field(
         default="dark",
         description="apply a custom rich style to the CLI",
-        command="console_style",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "console_style",
+            "group": SettingGroups.preferences.value,
+        },
     )
     ALLOWED_NUMBER_OF_ROWS: int = Field(
         default=20,
         description="number of rows to show (when not using interactive tables).",
-        command="n_rows",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "n_rows",
+            "group": SettingGroups.preferences.value,
+        },
     )
     ALLOWED_NUMBER_OF_COLUMNS: int = Field(
         default=5,
         description="number of columns to show (when not using interactive tables).",
-        command="n_cols",
-        group=SettingGroups.preferences,
+        json_schema_extra={
+            "command": "n_cols",
+            "group": SettingGroups.preferences.value,
+        },
     )
 
     model_config = ConfigDict(validate_assignment=True)

{openbb_cli-1.3.0 → openbb_cli-1.4.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "openbb-cli"
-version = "1.3.0"
+version = "1.4.1"
 description = "Investment Research for Everyone, Anywhere."
 authors = ["OpenBB <hello@openbb.co>"]
 packages = [{ include = "openbb_cli" }]
@@ -14,10 +14,10 @@ documentation = "https://docs.openbb.co/cli"
 openbb = 'openbb_cli.cli:main'
 
 [tool.poetry.dependencies]
-python = "^3.10,<3.14"
+python = ">=3.10,<4"
 
 # OpenBB dependencies
-openbb = { version = "^4.6.0", extras = ["all"] }
+openbb = { version = "^4.7.1", extras = ["all"] }
 
 # CLI dependencies
 prompt-toolkit = "^3.0.50"