jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-02 23:41:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

[V5] CLI 2.0 - Pluggable Backends, Non-TTY Default, HTTP Dispatcher, Spec Files + Codegen (#7433)

Browse Source 
* stash some changes

* add more robust testing

* mypy

* point PR at V5

* introduce spec file

* codespell

* test fix

* fix workflow environment setup

* fix workflow environment setup

* fix workflow environment setup

* add pyyaml to dependencies

* split lint jobs

* fix workflow environment setup

* fix workflow environment setup

* workflow env setup

* workflow env setup

* clean up code comments

* add auth hook entrypoints

* codespell

* add codegen feature

* codespell

* move _unpack into dispatchers for consistency with codegen packages

* surface nested models in the response

* fix missing coverage in CI

* socrata updates

* test fix

* detect plotly output

* add --include and --exclude flags from generate-extension command

* cap test matrix at python 3.14

* no useless comments

* platform controller command description split

* merge URL overloads from path params

* exclude none and unset from model dump

---------

Co-authored-by: deeleeramone <>
Co-authored-by: Copilot <copilot@github.com>
This commit is contained in:
Danglewood
2026-06-01 09:14:38 -07:00
committed by GitHub
parent c3f49f096b
commit 9a30186174
127 changed files with 44118 additions and 8056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

173
cli/openbb_cli/controllers/base_platform_controller.py
View File

@@ -1,24 +1,28 @@
"""Platform Equity Controller."""
import os
from functools import partial, update_wrapper
from functools import lru_cache, partial, update_wrapper
from types import MethodType
from typing import Any
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,
)
from openbb_cli.config.menu_text import MenuText
from openbb_cli.controllers.base_controller import BaseController
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
session = Session()
@lru_cache(maxsize=1)
def _OBBject() -> type:
"""Return ``OBBject`` lazily."""
from openbb_core.app.model.obbject import OBBject
return OBBject
class DummyTranslation:
"""Dummy Translation for testing."""
@@ -33,36 +37,62 @@ class PlatformController(BaseController):
CHOICES_GENERATION = True
def __init__( # pylint: disable=too-many-positional-arguments
_factory_backend: Any = None
_factory_translators: dict[str, Any] | None = None
_factory_paths: dict[str, str] | None = None
def __init__(
self,
name: str,
parent_path: list[str],
platform_target: type | None = None,
queue: list[str] | None = None,
translators: dict | None = None,
paths: dict[str, str] | None = None,
):
"""Construct a Platform based Controller."""
self.PATH = f"/{'/'.join(parent_path)}/{name}/" if parent_path else f"/{name}/"
super().__init__(queue)
self._name = name
if not (platform_target or translators):
raise ValueError("Either platform_target or translators must be provided.")
if (
translators is None
and platform_target is None
and self._factory_translators is not None
):
translators = self._factory_translators
if paths is None and self._factory_paths is not None:
paths = self._factory_paths
self._translated_target = DummyTranslation()
elif platform_target is not None:
from openbb import obb
self._translated_target = (
ArgparseClassProcessor(
target_class=platform_target,
reference=obb.reference["paths"], # type: ignore
from openbb_cli.argparse_translator.argparse_class_processor import (
ArgparseClassProcessor,
)
if platform_target
else DummyTranslation()
)
self._translated_target = ArgparseClassProcessor(
target_class=platform_target,
reference=obb.reference["paths"], # ty: ignore[not-subscriptable]
)
elif translators is not None:
self._translated_target = DummyTranslation()
else:
raise ValueError(
"PlatformController needs one of: factory-injected translators, "
"platform_target, or translators=...; got none."
)
self.translators = (
translators
if translators is not None
else getattr(self._translated_target, "translators", {})
)
self.paths = getattr(self._translated_target, "paths", {})
self.paths = (
paths
if paths is not None
else getattr(self._translated_target, "paths", {})
)
if self.translators:
self._link_obbject_to_data_processing_commands()
@@ -73,9 +103,8 @@ class PlatformController(BaseController):
def _link_obbject_to_data_processing_commands(self):
"""Link data processing commands to OBBject registry."""
for _, trl in self.translators.items():
for action in trl._parser._actions: # pylint: disable=protected-access
for action in trl._parser._actions:
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))
@@ -98,7 +127,7 @@ class PlatformController(BaseController):
ns_parser.data in session.obbject_registry.obbject_keys
):
obbject = session.obbject_registry.get(ns_parser.data)
if obbject and isinstance(obbject, OBBject):
if obbject and isinstance(obbject, _OBBject()):
setattr(ns_parser, "data", obbject.results)
return ns_parser
@@ -111,25 +140,25 @@ class PlatformController(BaseController):
sub_menu_translators = {}
choices_commands = []
sub_prefix = f"{self._name}_{path}_"
for translator_name, translator in self.translators.items():
if f"{self._name}_{path}" in translator_name:
new_name = translator_name.replace(f"{self._name}_{path}_", "")
if translator_name.startswith(sub_prefix):
new_name = translator_name[len(sub_prefix) :]
sub_menu_translators[new_name] = translator
choices_commands.append(new_name)
if translator_name in self.CHOICES_COMMANDS:
self.CHOICES_COMMANDS.remove(translator_name)
# Create the sub controller as a new class
class_name = f"{self._name.capitalize()}{path.capitalize()}Controller"
SubController = type(
class_name,
(PlatformController,),
{
"CHOICES_GENERATION": True,
# "CHOICES_MENUS": [],
"CHOICES_COMMANDS": choices_commands,
"_factory_backend": self._factory_backend,
},
)
@@ -143,7 +172,6 @@ class PlatformController(BaseController):
def _generate_commands(self):
"""Generate commands."""
for name, translator in self.translators.items():
# Prepare the translator name to create a command call in the controller
new_name = name.replace(f"{self._name}_", "")
self._generate_command_call(name=new_name, translator=translator)
@@ -170,14 +198,13 @@ class PlatformController(BaseController):
obbject = translator.execute_func(parsed_args=ns_parser)
df: pd.DataFrame = pd.DataFrame()
fig: OpenBBFigure | None = None
title = f"{self.PATH}{translator.func.__name__}"
if obbject:
if isinstance(obbject, list):
obbject = OBBject(results=obbject)
obbject = _OBBject()(results=obbject)
if isinstance(obbject, OBBject):
if isinstance(obbject, _OBBject()):
if (
session.max_obbjects_exceeded()
and obbject.results
@@ -188,9 +215,7 @@ class PlatformController(BaseController):
"[yellow]Maximum number of OBBjects reached. The oldest entry was removed.[yellow]"
)
# use the obbject to store the command so we can display it later on results
obbject.extra["command"] = f"{title} {' '.join(other_args)}"
# if there is a registry key in the parser, store to the obbject
if (
hasattr(ns_parser, "register_key")
and ns_parser.register_key
@@ -209,15 +234,11 @@ class PlatformController(BaseController):
)
if store_obbject:
# store the obbject in the registry
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 (
@@ -228,22 +249,25 @@ class PlatformController(BaseController):
"Added `OBBject` to cached results."
)
# making the dataframe available either for printing or exporting
df = obbject.to_dataframe()
chart = hasattr(ns_parser, "chart") and ns_parser.chart
if hasattr(ns_parser, "chart") and ns_parser.chart:
fig = obbject.chart.fig if obbject.chart else None
if not export:
obbject.show()
elif session.settings.USE_INTERACTIVE_DF and not export:
obbject.charting.table() # type: ignore[attr-defined]
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, export=export
)
if not export:
try:
session.output_adapter.display(
data=obbject,
title=title,
export=export,
chart=chart,
)
except Exception as e:
session.console.print(
f"[red]Display error: {e}[/red]"
)
if hasattr(obbject, "model_dump"):
results = obbject.model_dump(
exclude_unset=True, exclude_none=True
).get("results")
session.console.print(results)
elif isinstance(obbject, dict):
df = pd.DataFrame.from_dict(obbject, orient="columns")
@@ -251,7 +275,7 @@ class PlatformController(BaseController):
df=df, show_index=True, title=title, export=export
)
elif not isinstance(obbject, OBBject):
elif not isinstance(obbject, _OBBject()):
session.console.print(obbject)
if export and not df.empty:
@@ -259,6 +283,13 @@ class PlatformController(BaseController):
if sheet_name and isinstance(sheet_name, list):
sheet_name = sheet_name[0]
fig = None
if hasattr(ns_parser, "chart") and ns_parser.chart:
from contextlib import suppress
with suppress(Exception):
fig = obbject.chart.fig if obbject.chart else None
export_data(
export_type=",".join(ns_parser.export),
dir_path=os.path.dirname(os.path.abspath(__file__)),
@@ -274,11 +305,11 @@ class PlatformController(BaseController):
session.console.print(f"[red]{e}[/]\n")
return
# Bind the method to the class
bound_method = MethodType(method, self)
# Update the wrapper and set the attribute
bound_method = update_wrapper(partial(bound_method, translator=translator), method) # type: ignore
bound_method = update_wrapper(
partial(bound_method, translator=translator), method
)
setattr(self, f"call_{name}", bound_method)
def _generate_controller_call(self, controller, name, parent_path, translators):
@@ -294,11 +325,9 @@ class PlatformController(BaseController):
queue=self.queue,
)
# Bind the method to the class
bound_method = MethodType(method, self)
# Update the wrapper and set the attribute
bound_method = update_wrapper( # type: ignore
bound_method = update_wrapper(
partial(
bound_method,
name=name,
@@ -310,10 +339,28 @@ class PlatformController(BaseController):
)
setattr(self, f"call_{name}", bound_method)
def _get_reference_paths(self) -> dict[str, dict[str, Any]]:
"""Return the reference path-description dict."""
if self._factory_backend is not None:
return self._factory_backend.reference_paths
from openbb_cli.backend import LocalBackend
return LocalBackend().reference_paths
def _get_reference_routers(self) -> dict[str, dict[str, Any]]:
"""Return the reference router-description dict."""
if self._factory_backend is not None:
return self._factory_backend.reference_routers
from openbb_cli.backend import LocalBackend
return LocalBackend().reference_routers
def _get_command_description(self, command: str) -> str:
"""Get command description."""
command_description = (
obb.reference["paths"].get(f"{self.PATH}{command}", {}).get("description", "") # type: ignore
self._get_reference_paths()
.get(f"{self.PATH}{command}", {})
.get("description", "")
)
if not command_description:
@@ -323,7 +370,7 @@ class PlatformController(BaseController):
if trl and hasattr(trl, "parser"):
command_description = trl.parser.description
return command_description.split(".")[0].lower()
return (command_description or "").split(".")[0].lower()
def _get_menu_description(self, menu: str) -> str:
"""Get menu description."""
@@ -338,12 +385,13 @@ class PlatformController(BaseController):
return commands
menu_description = (
obb.reference["routers"].get(f"{self.PATH}{menu}", {}).get("description", "") # type: ignore
self._get_reference_routers()
.get(f"{self.PATH}{menu}", {})
.get("description", "")
) or ""
if menu_description:
return menu_description.split(".")[0].lower()
# If no description is found, return the sub menu commands
return ", ".join(_get_sub_menu_commands())
def print_help(self):
@@ -371,8 +419,9 @@ class PlatformController(BaseController):
for key, value in list(session.obbject_registry.all.items())[
: session.settings.N_TO_DISPLAY_OBBJECT_REGISTRY
]:
command = (value.get("extra") or {}).get("command", "")
mt.add_raw(
f"[yellow]OBB{key}[/yellow]: {value['command']}",
f"[yellow]OBB{key}[/yellow]: {command}",
left_spacing=True,
)