jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-10-27 04:31:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

[Feature] Align Python Interface With API - Stop Requiring OBBject As Output Type In PackageBuilder As Default (#7031)

Browse Source 
* stop enforcing OBBject as output type in PackageBuilder

* mypy
This commit is contained in:
Danglewood
2025-02-20 08:49:22 -08:00
committed by GitHub
parent 65d7275bf8
commit 0178f6a5bd
2 changed files with 30 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
openbb_platform/core/openbb_core/app/command_runner.py
View File

@@ -329,19 +329,12 @@ class StaticCommandRunner:
for name, default in model_headers.items() or {}
} or None
validate = not execution_context.api_route.openapi_extra.get("no_validate")
try:
obbject = await cls._command(func, kwargs)
# The output might be from a router command with 'no_validate=True'
# It might be of a different type than OBBject.
# In this case, we avoid accessing those attributes.
if isinstance(obbject, OBBject) or validate:
if validate and not isinstance(obbject, OBBject):
raise OpenBBError(
TypeError(
f"Expected OBBject instance at function output, got {type(obbject)} instead."
)
)
if isinstance(obbject, OBBject):
# This section prepares the obbject to pass to the charting service.
obbject._route = route # pylint: disable=protected-access
std_params = cls._extract_params(kwargs, "standard_params") or (

36
openbb_platform/core/openbb_core/app/static/package_builder.py
View File

@@ -334,11 +334,11 @@ class ImportDefinition:
hint_type_list.append(parameter.annotation)
if return_type:
if not no_validate and not issubclass(return_type, OBBject):
raise ValueError("Return type must be an OBBject.")
hint_type = (
get_args(get_type_hints(return_type)["results"])[0]
if "OBBject" in return_type.__class__.__name__
if hasattr(return_type, "__class__")
and hasattr(return_type.__class__, "__name__")
and "OBBject" in return_type.__class__.__name__
else return_type
)
hint_type_list.append(hint_type)
@@ -1690,7 +1690,7 @@ class ReferenceGenerator:
# Adjust regex to correctly capture content inside brackets, including nested brackets
content_inside_brackets = re.search(
r"OBBject\[\s*((?:[^\[\]]|\[[^\[\]]*\])*)\s*\]", return_type
)
) or re.search(r"list\[\s*((?:[^\[\]]|\[[^\[\]]*\])*)\s*\]", return_type)
return_type = ( # type: ignore
content_inside_brackets.group(1)
if content_inside_brackets is not None
@@ -1833,6 +1833,10 @@ class ReferenceGenerator:
# may not contain the "Parameters" and "Returns" sections. Hence, the
# endpoint function docstring is used instead.
docstring = getattr(route_func, "__doc__", "")
if not docstring:
continue
description = docstring.split("Parameters")[0].strip()
# Remove extra spaces in between the string
reference[path]["description"] = re.sub(" +", " ", description)
@@ -1847,9 +1851,27 @@ class ReferenceGenerator:
"description": "Unvalidated results object.",
}
else:
reference[path]["returns"]["OBBject"] = (
cls._get_post_method_returns_info(docstring)
)
returns_info = cls._get_post_method_returns_info(docstring)
if returns_info and "OBBject" in returns_info[0]["type"]:
reference[path]["returns"]["OBBject"] = returns_info
else:
r_info = returns_info[0] if returns_info else {}
r_type = r_info.pop("type", "Any")
r_info["name"] = None # type: ignore
if len(returns_info) == 2:
r_info = returns_info[1]
elif len(returns_info) == 1:
r_info["type"] = "Any"
if r_type:
if "[" in r_type:
c_types = r_type.split("[")[1].split("]")[0]
r_type = r_type.split("[")[0]
r_info["type"] = (
"[" + c_types + "]" if c_types else "Any"
)
reference[path]["returns"][r_type] = r_info
else:
reference[path]["returns"] = returns_info
return reference