openbb-core 1.2.0__tar.gz → 1.2.2__tar.gz

{openbb_core-1.2.0 → openbb_core-1.2.2}/PKG-INFO

@@ -1,26 +1,29 @@
 Metadata-Version: 2.1
 Name: openbb-core
-Version: 1.2.0
+Version: 1.2.2
 Summary: OpenBB package with core functionality
+License: AGPL-3.0-only
 Author: OpenBB Team
 Author-email: hello@openbb.co
 Requires-Python: >=3.8,<4.0
+Classifier: License :: OSI Approved :: GNU Affero General Public License v3
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-Requires-Dist: aiohttp (>=3.9.0,<4.0.0)
-Requires-Dist: fastapi (>=0.104.1,<0.105.0)
+Requires-Dist: aiohttp (>=3.9.5,<4.0.0)
+Requires-Dist: anyio (>=3.7.0,<4.0.0)
+Requires-Dist: fastapi (>=0.111.0,<0.112.0)
 Requires-Dist: html5lib (>=1.1,<2.0)
 Requires-Dist: importlib-metadata (>=6.8.0,<7.0.0)
 Requires-Dist: pandas (>=1.5.3)
-Requires-Dist: posthog (>=3.0.1,<4.0.0)
+Requires-Dist: posthog (>=3.3.1,<4.0.0)
 Requires-Dist: pydantic (>=2.5.1,<3.0.0)
+Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
 Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
-Requires-Dist: python-jose (>=3.3.0,<4.0.0)
-Requires-Dist: python-multipart (>=0.0.6,<0.0.7)
+Requires-Dist: python-multipart (>=0.0.7,<0.0.8)
 Requires-Dist: requests (>=2.31.0,<3.0.0)
 Requires-Dist: ruff (>=0.1.6,<0.2.0)
 Requires-Dist: uuid7 (>=0.1.0,<0.2.0)

openbb_core-1.2.2/openbb_core/__init__.py

@@ -0,0 +1 @@
+"""OpenBB Core."""

openbb_core-1.2.2/openbb_core/api/app_loader.py

@@ -0,0 +1,36 @@
+"""App loader module."""
+
+from typing import List, Optional
+
+from fastapi import APIRouter, FastAPI
+from openbb_core.app.router import RouterLoader
+
+
+class AppLoader:
+    """App loader."""
+
+    @staticmethod
+    def get_openapi_tags() -> List[dict]:
+        """Get openapi tags."""
+        main_router = RouterLoader.from_extensions()
+        openapi_tags = []
+        # Add tag data for each router in the main router
+        for r in main_router.routers:
+            openapi_tags.append(
+                {
+                    "name": r,
+                    "description": main_router.get_attr(r, "description"),
+                }
+            )
+        return openapi_tags
+
+    @staticmethod
+    def from_routers(
+        app: FastAPI, routers: List[Optional[APIRouter]], prefix: str
+    ) -> FastAPI:
+        """Load routers to app."""
+        for router in routers:
+            if router:
+                app.include_router(router=router, prefix=prefix)
+
+        return app

{openbb_core-1.2.0 → openbb_core-1.2.2}/openbb_core/api/auth/user.py

@@ -1,3 +1,5 @@
+"""User authentication."""
+
 import secrets
 from typing import Optional
 
@@ -15,7 +17,6 @@ async def authenticate_user(
     credentials: Annotated[Optional[HTTPBasicCredentials], Depends(security)]
 ):
     """Authenticate the user."""
-
     if credentials:
         username = Env().API_USERNAME
         password = Env().API_PASSWORD

openbb_core-1.2.2/openbb_core/api/dependency/__init__.py

@@ -0,0 +1 @@
+"""OpenBB Core API Dependency."""

{openbb_core-1.2.0 → openbb_core-1.2.2}/openbb_core/api/rest_api.py

@@ -1,4 +1,5 @@
 """REST API for the OpenBB Platform."""
+
 import logging
 from contextlib import asynccontextmanager
 
@@ -66,18 +67,20 @@ app = FastAPI(
     ],
     lifespan=lifespan,
 )
-
 app.add_middleware(
     CORSMiddleware,
     allow_origins=system.api_settings.cors.allow_origins,
     allow_methods=system.api_settings.cors.allow_methods,
     allow_headers=system.api_settings.cors.allow_headers,
 )
+app.openapi_tags = AppLoader.get_openapi_tags()
 AppLoader.from_routers(
     app=app,
-    routers=[AuthService().router, router_system, router_coverage, router_commands]
-    if Env().DEV_MODE
-    else [router_commands],
+    routers=(
+        [AuthService().router, router_system, router_coverage, router_commands]
+        if Env().DEV_MODE
+        else [router_commands]
+    ),
     prefix=system.api_settings.prefix,
 )
 
@@ -85,6 +88,9 @@ AppLoader.from_routers(
 @app.exception_handler(Exception)
 async def api_exception_handler(_: Request, exc: Exception):
     """Exception handler for all other exceptions."""
+    if Env().DEBUG_MODE:
+        raise exc
+    logger.error(exc)
     return JSONResponse(
         status_code=404,
         content={
@@ -97,6 +103,9 @@ async def api_exception_handler(_: Request, exc: Exception):
 @app.exception_handler(OpenBBError)
 async def openbb_exception_handler(_: Request, exc: OpenBBError):
     """Exception handler for OpenBB errors."""
+    if Env().DEBUG_MODE:
+        raise exc
+    logger.error(exc.original)
     openbb_error = exc.original
     status_code = 400 if "No results" in str(openbb_error) else 500
     return JSONResponse(

openbb_core-1.2.2/openbb_core/api/router/__init__.py

@@ -0,0 +1 @@
+"""OpenBB Core API Router."""

{openbb_core-1.2.0 → openbb_core-1.2.2}/openbb_core/api/router/commands.py

@@ -1,11 +1,12 @@
+"""Commands: generates the command map."""
+
 import inspect
 from functools import partial, wraps
 from inspect import Parameter, Signature, signature
-from typing import Any, Callable, Dict, Tuple, TypeVar
+from typing import Any, Callable, Dict, Optional, Tuple, TypeVar
 
-from fastapi import APIRouter, Depends
+from fastapi import APIRouter, Depends, Header
 from fastapi.routing import APIRoute
-from openbb_core.app.charting_service import ChartingService
 from openbb_core.app.command_runner import CommandRunner
 from openbb_core.app.model.command_context import CommandContext
 from openbb_core.app.model.obbject import OBBject
@@ -18,6 +19,13 @@ from openbb_core.env import Env
 from pydantic import BaseModel
 from typing_extensions import Annotated, ParamSpec
 
+try:
+    from openbb_charting import Charting
+
+    CHARTING_INSTALLED = True
+except ImportError:
+    CHARTING_INSTALLED = False
+
 T = TypeVar("T")
 P = ParamSpec("P")
 
@@ -43,11 +51,16 @@ def build_new_signature(path: str, func: Callable) -> Signature:
     parameter_list = sig.parameters.values()
     return_annotation = sig.return_annotation
     new_parameter_list = []
-
-    for parameter in parameter_list:
+    var_kw_pos = len(parameter_list)
+    for pos, parameter in enumerate(parameter_list):
         if parameter.name == "cc" and parameter.annotation == CommandContext:
             continue
 
+        if parameter.kind == Parameter.VAR_KEYWORD:
+            # We track VAR_KEYWORD parameter to insert the any additional
+            # parameters we need to add before it and avoid a SyntaxError
+            var_kw_pos = pos
+
         new_parameter_list.append(
             Parameter(
                 parameter.name,
@@ -57,21 +70,36 @@ def build_new_signature(path: str, func: Callable) -> Signature:
             )
         )
 
-    if (
-        path.replace("/", "_")[1:]
-        in ChartingService.get_implemented_charting_functions()
-    ):
-        new_parameter_list.append(
+    if CHARTING_INSTALLED and path.replace("/", "_")[1:] in Charting.functions():
+        new_parameter_list.insert(
+            var_kw_pos,
             Parameter(
                 "chart",
                 kind=Parameter.POSITIONAL_OR_KEYWORD,
                 default=False,
                 annotation=bool,
-            )
+            ),
         )
+        var_kw_pos += 1
+
+    if custom_headers := SystemService().system_settings.api_settings.custom_headers:
+        for name, default in custom_headers.items():
+            new_parameter_list.insert(
+                var_kw_pos,
+                Parameter(
+                    name.replace("-", "_"),
+                    kind=Parameter.POSITIONAL_OR_KEYWORD,
+                    default=default,
+                    annotation=Annotated[
+                        Optional[str], Header(include_in_schema=False)
+                    ],
+                ),
+            )
+            var_kw_pos += 1
 
     if Env().API_AUTH:
-        new_parameter_list.append(
+        new_parameter_list.insert(
+            var_kw_pos,
             Parameter(
                 "__authenticated_user_settings",
                 kind=Parameter.POSITIONAL_OR_KEYWORD,
@@ -79,8 +107,9 @@ def build_new_signature(path: str, func: Callable) -> Signature:
                 annotation=Annotated[
                     UserSettings, Depends(AuthService().user_settings_hook)
                 ],
-            )
+            ),
         )
+        var_kw_pos += 1
 
     return Signature(
         parameters=new_parameter_list,
@@ -91,6 +120,7 @@ def build_new_signature(path: str, func: Callable) -> Signature:
 def validate_output(c_out: OBBject) -> OBBject:
     """
     Validate OBBject object.
+
     Checks against the OBBject schema and removes fields that contain the
     `exclude_from_api` extra `pydantic.Field` kwarg.
     Note that the modification to the `OBBject` object is done in-place.
@@ -102,8 +132,8 @@ def validate_output(c_out: OBBject) -> OBBject:
 
     Returns
     -------
-    OBBject
-        Validated OBBject object.
+    Dict
+        Serialized OBBject.
     """
 
     def is_model(type_):
@@ -115,25 +145,32 @@ def validate_output(c_out: OBBject) -> OBBject:
         json_schema_extra = field.json_schema_extra if field else None
 
         # case where 1st layer field needs to be excluded
-        if json_schema_extra and json_schema_extra.get("exclude_from_api", None):
+        if (
+            json_schema_extra
+            and isinstance(json_schema_extra, dict)
+            and json_schema_extra.get("exclude_from_api", None)
+        ):
             delattr(c_out, key)
 
         # if it's a model with nested fields
         elif is_model(type_):
             for field_name, field in type_.__fields__.items():
-                if field.json_schema_extra and field.json_schema_extra.get(
-                    "exclude_from_api", None
+                extra = getattr(field, "json_schema_extra", None)
+                if (
+                    extra
+                    and isinstance(extra, dict)
+                    and extra.get("exclude_from_api", None)
                 ):
                     delattr(value, field_name)
 
                 # if it's a yet a nested model we need to go deeper in the recursion
-                elif is_model(field.annotation):
+                elif is_model(getattr(field, "annotation", None)):
                     exclude_fields_from_api(field_name, getattr(value, field_name))
 
     for k, v in c_out.model_copy():
         exclude_fields_from_api(k, v)
 
-    return c_out.model_dump()
+    return c_out
 
 
 def build_api_wrapper(
@@ -151,7 +188,7 @@ def build_api_wrapper(
     func.__annotations__ = new_annotations_map
 
     @wraps(wrapped=func)
-    async def wrapper(*args: Tuple[Any], **kwargs: Dict[str, Any]):
+    async def wrapper(*args: Tuple[Any], **kwargs: Dict[str, Any]) -> OBBject:
         user_settings: UserSettings = UserSettings.model_validate(
             kwargs.pop(
                 "__authenticated_user_settings",
@@ -161,8 +198,7 @@ def build_api_wrapper(
         execute = partial(command_runner.run, path, user_settings)
         output: OBBject = await execute(*args, **kwargs)
 
-        output = validate_output(output)
-        return output
+        return validate_output(output)
 
     return wrapper
 

{openbb_core-1.2.0 → openbb_core-1.2.2}/openbb_core/api/router/coverage.py

@@ -1,4 +1,5 @@
 """Coverage API router."""
+
 from fastapi import APIRouter, Depends
 from openbb_core.api.dependency.coverage import get_command_map, get_provider_interface
 from openbb_core.app.provider_interface import ProviderInterface

{openbb_core-1.2.0 → openbb_core-1.2.2}/openbb_core/api/router/helpers/coverage_helpers.py

@@ -1,4 +1,5 @@
 """Coverage API router helper functions."""
+
 from inspect import _empty, signature
 from typing import TYPE_CHECKING, Any, Callable, Dict, Optional, Tuple, Type
 

{openbb_core-1.2.0 → openbb_core-1.2.2}/openbb_core/api/router/system.py

@@ -1,4 +1,5 @@
 """System router."""
+
 from fastapi import APIRouter, Depends
 from openbb_core.api.dependency.system import get_system_settings
 from openbb_core.app.model.system_settings import SystemSettings

openbb_core-1.2.2/openbb_core/app/__init__.py

@@ -0,0 +1 @@
+"""OpenBB Core App Module."""