jerry/OpenBB
1
0
Fork 0
mirror of https://github.com/OpenBB-finance/OpenBB.git synced 2026-11-04 08:22:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'feature/openbb-sdk-v4' into feature/test-dup-provider-fields

Browse Source
This commit is contained in:
hjoaquim
2023-09-14 09:39:09 +01:00
parent dcd8e455f7 0091fb29ec
commit c77908dafe
10 changed files with 214 additions and 73 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
.gitignore vendored
View File

@@ -80,3 +80,6 @@ lightning_logs/
!openbb_sdk/install_all.sh
openbb_sdk/sdk/core/tests/app/model/charts/test_chart_settings.py
*/mocked_path
# CA certificates
*.pem

44
openbb_sdk/sdk/core/README.md vendored
View File

@@ -23,7 +23,8 @@
- [4.1.5. Environment variables](#415-environment-variables)
- [4.2 Dynamic version](#42-dynamic-version)
- [5. REST API](#5-rest-api)
- [5.1 Test users](#51-test-users)
- [5.1 HTTPS](#51-https)
- [5.2 Test users](#52-test-users)
- [6. Front-end typing](#6-front-end-typing)
## 1. Introduction
@@ -398,7 +399,46 @@ OpenBB SDK comes with a ready to use Rest API built with FastAPI. Start the appl
uvicorn openbb_core.api.rest_api:app --reload
```
## 5.1 Test users
### 5.1 HTTPS
If you want to run your FastAPI app over HTTPS locally you can use [mkcert](https://github.com/FiloSottile/mkcert) and pass the certificate and key to `uvicorn`.
0. Install `mkcert` (see instructions [here](https://github.com/FiloSottile/mkcert))
1. cd into "openbb_sdk/sdk/core/openbb_core/api"
2. Run the following commands:
```shell
mkcert -install
mkcert localhost 127.0.0.1 ::1
```
You will see two files created in the current directory.
- Certificate: "localhost+2.pem"
- Key: "localhost+2-key.pem"
3. Change the code to start the server inside "rest_api.py" to:
```python
if __name__ == "__main__":
import uvicorn
uvicorn.run(
"openbb_core.api.rest_api:app",
reload=True,
ssl_keyfile="./localhost+2-key.pem",
ssl_certfile="./localhost+2.pem",
)
```
4. Run the server from the terminal with:
```shell
python rest_api.py
```
Your app will be available at https://127.0.0.1:8000/
### 5.2 Test users
There are 2 default users for testing purpose:

5
openbb_sdk/sdk/core/openbb_core/app/logs/handlers/posthog_handler.py
View File

@@ -29,7 +29,6 @@ class PosthogHandler(logging.Handler):
log_startup = "log_startup"
log_cmd = "log_cmd"
log_sdk = "log_sdk"
log_error = "log_error"
log_warning = "log_warning"
@@ -60,10 +59,6 @@ class PosthogHandler(logging.Handler):
for log in re.findall(log_regex, log_info):
log_dict[log[0]] = json.loads(log[1])
sdk_regex = r"({\"INPUT\":.*})"
if sdk_dict := re.findall(sdk_regex, log_info):
log_dict["SDK"] = json.loads(sdk_dict[0])
return log_dict
def send(self, record: logging.LogRecord):

7
openbb_sdk/sdk/core/openbb_core/app/logs/logging_service.py
View File

@@ -134,7 +134,7 @@ class LoggingService(metaclass=SingletonMeta):
return handlers_manager
def _log_startup(self) -> None:
def _log_startup(self, route: Optional[str] = None) -> None:
"""
Log startup information.
"""
@@ -156,6 +156,7 @@ class LoggingService(metaclass=SingletonMeta):
"STARTUP: %s ",
json.dumps(
{
"route": route,
"PREFERENCES": self._user_settings.preferences,
"KEYS": check_credentials_defined(
self._user_settings.credentials.dict()
@@ -194,6 +195,8 @@ class LoggingService(metaclass=SingletonMeta):
Callable representing the executed function.
kwargs : Dict[str, Any]
Keyword arguments passed to the function.
exec_info : Optional[Tuple[Type[BaseException], BaseException, Optional[TracebackType]]], optional
Exception information, by default None
"""
self._user_settings = user_settings
self._system_settings = system_settings
@@ -204,7 +207,7 @@ class LoggingService(metaclass=SingletonMeta):
self._handlers_manager.update_handlers(self._logging_settings)
if "login" in route:
self._log_startup()
self._log_startup(route)
else:
logger = logging.getLogger(__name__)

26
openbb_sdk/sdk/core/openbb_core/app/model/obbject.py
View File

@@ -97,6 +97,8 @@ class OBBject(GenericModel, Generic[T], Tagged):
res = self.results
df = None
sort_columns = True
if isinstance(res, list) and len(res) == 1 and isinstance(res[0], dict):
for r in res:
dict_of_df = {}
@@ -105,21 +107,25 @@ class OBBject(GenericModel, Generic[T], Tagged):
isinstance(nv, BaseModel) for nv in v
):
dict_of_df[k] = basemodel_to_df(v, "date")
sort_columns = False
else:
dict_of_df[k] = pd.DataFrame(v)
df = pd.concat(dict_of_df, axis=1)
elif isinstance(res, list) and all(
isinstance(item, BaseModel) for item in res
):
df = basemodel_to_df(res, "date")
sort_columns = False
else:
df = pd.DataFrame(res)
if df is None:
raise OpenBBError("Unsupported data format.")
# Improve output so that all columns that are None are not returned
df.sort_index(axis=1, inplace=True)
# Drop columns that are all NaN, but don't rearrange columns
if sort_columns:
df.sort_index(axis=1, inplace=True)
df = df.dropna(axis=1, how="all")
except Exception as e:
@@ -150,11 +156,27 @@ class OBBject(GenericModel, Generic[T], Tagged):
Dict[str, List]
Dictionary of lists.
"""
if isinstance(self.results, dict) and all(
isinstance(v, dict) for v in self.results.values()
):
results: Dict[str, List] = {}
for _, v in self.results.items():
for kk, vv in v.items():
if kk not in results:
results[kk] = []
results[kk].append(vv)
return results
df = self.to_dataframe().reset_index() # type: ignore
results = {}
for field in df.columns:
results[field] = df[field].tolist()
# remove index from results
if "index" in results:
del results["index"]
return results
def to_chart(self, **kwargs):

33
openbb_sdk/sdk/core/openbb_core/app/static/account.py
View File

@@ -1,8 +1,11 @@
# pylint: disable=W0212:protected-access
import json
from functools import wraps
from pathlib import Path
from sys import exc_info
from typing import TYPE_CHECKING, Optional
from openbb_core.app.logs.logging_service import LoggingService
from openbb_core.app.model.abstract.error import OpenBBError
from openbb_core.app.model.hub.hub_session import HubSession
from openbb_core.app.model.user_settings import UserSettings
@@ -29,6 +32,32 @@ class Account:
def __repr__(self) -> str:
return self.__doc__ or ""
def _log_account_command(func): # pylint: disable=E0213
@wraps(func)
def wrapped(self, *args, **kwargs):
try:
result = func(self, *args, **kwargs) # pylint: disable=E1102
except Exception as e:
raise OpenBBError(e) from e
finally:
user_settings = self._base_app._command_runner.user_settings
system_settings = self._base_app._command_runner.system_settings
ls = LoggingService(
user_settings=user_settings, system_settings=system_settings
)
ls.log(
user_settings=user_settings,
system_settings=system_settings,
route=f"/account/{func.__name__}", # pylint: disable=E1101
func=func,
kwargs={}, # don't want any credentials being logged by accident
exec_info=exc_info(),
)
return result
return wrapped
def _create_hub_service(
self,
email: Optional[str] = None,
@@ -51,6 +80,7 @@ class Account:
hs.connect(email, password, pat)
return hs
@_log_account_command
def login(
self,
email: Optional[str] = None,
@@ -91,6 +121,7 @@ class Account:
return self._base_app._command_runner.user_settings
@_log_account_command
def save(self) -> UserSettings:
"""Save user settings.
@@ -109,6 +140,7 @@ class Account:
hs.push(self._base_app._command_runner.user_settings)
return self._base_app._command_runner.user_settings
@_log_account_command
def refresh(self) -> UserSettings:
"""Refresh user settings.
@@ -130,6 +162,7 @@ class Account:
self._base_app._command_runner.user_settings = updated
return self._base_app._command_runner.user_settings
@_log_account_command
def logout(self) -> UserSettings:
"""Logout from hub.

2
openbb_sdk/sdk/core/openbb_core/app/utils.py
View File

@@ -10,7 +10,6 @@ def basemodel_to_df(
index: Optional[Union[str, Iterable]] = None,
) -> pd.DataFrame:
"""Convert list of BaseModel to a Pandas DataFrame."""
if isinstance(data, list):
df = pd.DataFrame([d.dict() for d in data])
else:
@@ -30,6 +29,7 @@ def basemodel_to_df(
if df.index.name == "date":
df.index = pd.to_datetime(df.index)
df.sort_index(axis=0, inplace=True)
return df

6
openbb_sdk/sdk/core/tests/app/logs/handlers/test_posthog_handler.py
View File

@@ -162,12 +162,6 @@ def test_emit_calls_handleError_when_send_raises_exception_of_another_type(handl
'STARTUP: {"status": "success"}',
{"STARTUP": {"status": "success"}},
),
(
'{"INPUT": {"something_something":"something_something"}}',
{
"SDK": {"INPUT": {"something_something": "something_something"}},
},
),
(
'CMD: {"path": "/stocks/", "known_cmd": "load", "other_args": "aapl", "input": "load aapl"}',
{

3
openbb_sdk/sdk/core/tests/app/logs/test_logging_service.py
View File

@@ -86,9 +86,10 @@ def test_log_startup(logging_service):
)
logging_service._system_settings = "your_system_settings"
logging_service._log_startup()
logging_service._log_startup(route="test_route")
expected_log_data = {
"route": "test_route",
"PREFERENCES": "your_preferences",
"KEYS": {"username": "defined", "password": "defined"},
"SYSTEM": "your_system_settings",

158
openbb_sdk/sdk/core/tests/app/model/test_obbject.py
View File

@@ -5,6 +5,7 @@ import pandas as pd
import pytest
from openbb_core.app.model.obbject import Chart, OBBject, OpenBBError
from openbb_provider.abstract.data import Data
from pandas.testing import assert_frame_equal
def test_OBBject():
@@ -30,6 +31,21 @@ def test_to_dataframe_no_results():
co.to_dataframe()
class MockData(Data):
"""Test helper."""
x: int
y: int
class MockMultiData(Data):
"""Test helper."""
date: str
another_date: str
value: float
@pytest.mark.parametrize(
"results, expected_df",
[
@@ -51,24 +67,28 @@ def test_to_dataframe_no_results():
# Test case 3: List of Data
(
[
Data(x=0, y=2),
Data(x=1, y=3),
Data(x=2, y=0),
Data(x=3, y=1),
Data(x=4, y=6),
MockData(x=0, y=2),
MockData(x=1, y=3),
MockData(x=2, y=0),
MockData(x=3, y=1),
MockData(x=4, y=6),
],
pd.DataFrame({"x": [0, 1, 2, 3, 4], "y": [2, 3, 0, 1, 6]}),
pd.DataFrame(
{"x": [0, 1, 2, 3, 4], "y": [2, 3, 0, 1, 6]}, columns=["x", "y"]
),
),
# Test case 4: List of dict
(
[
{"x": 1, "y": 2},
{"x": 1, "y": 3},
{"x": 2, "y": 0},
{"x": 3, "y": 1},
{"x": 4, "y": 6},
{"a": 1, "y": 2},
{"a": 1, "y": 3},
{"a": 2, "y": 0},
{"a": 3, "y": 1},
{"a": 4, "y": 6},
],
pd.DataFrame({"x": [1, 1, 2, 3, 4], "y": [2, 3, 0, 1, 6]}),
pd.DataFrame(
{"a": [1, 1, 2, 3, 4], "y": [2, 3, 0, 1, 6]}, columns=["a", "y"]
),
),
# Test case 5: List of Lists
(
@@ -121,14 +141,26 @@ def test_to_dataframe_no_results():
[
{
"df1": [
Data(date="1956-01-01", another_date="2023-09-01", value=0.0),
Data(date="1956-02-01", another_date="2023-09-01", value=0.0),
Data(date="1956-03-01", another_date="2023-09-01", value=0.0),
MockMultiData(
date="1956-01-01", another_date="2023-09-01", value=0.0
),
MockMultiData(
date="1956-02-01", another_date="2023-09-01", value=0.0
),
MockMultiData(
date="1956-03-01", another_date="2023-09-01", value=0.0
),
],
"df2": [
Data(date="1955-03-01", another_date="2023-09-01", value=0.0),
Data(date="1955-04-01", another_date="2023-09-01", value=0.0),
Data(date="1955-05-01", another_date="2023-09-01", value=0.0),
MockMultiData(
date="1955-03-01", another_date="2023-09-01", value=0.0
),
MockMultiData(
date="1955-04-01", another_date="2023-09-01", value=0.0
),
MockMultiData(
date="1955-05-01", another_date="2023-09-01", value=0.0
),
],
}
],
@@ -141,13 +173,10 @@ def test_to_dataframe_no_results():
pd.to_datetime("1956-02-01"),
pd.to_datetime("1956-03-01"),
],
"another_date": [
"2023-09-01",
"2023-09-01",
"2023-09-01",
],
"another_date": ["2023-09-01", "2023-09-01", "2023-09-01"],
"value": [0.0, 0.0, 0.0],
}
},
columns=["date", "another_date", "value"],
).set_index("date"),
"df2": pd.DataFrame(
{
@@ -156,16 +185,14 @@ def test_to_dataframe_no_results():
pd.to_datetime("1955-04-01"),
pd.to_datetime("1955-05-01"),
],
"another_date": [
"2023-09-01",
"2023-09-01",
"2023-09-01",
],
"another_date": ["2023-09-01", "2023-09-01", "2023-09-01"],
"value": [0.0, 0.0, 0.0],
}
},
columns=["date", "another_date", "value"],
).set_index("date"),
},
axis=1,
sort=True,
),
),
# Test case 10: Empty results
@@ -182,7 +209,7 @@ def test_to_dataframe(results, expected_df):
# Act and Assert
if isinstance(expected_df, pd.DataFrame):
result = co.to_dataframe()
assert result.equals(expected_df)
assert_frame_equal(result, expected_df)
else:
with pytest.raises(expected_df.__class__) as exc_info:
co.to_dataframe()
@@ -191,45 +218,68 @@ def test_to_dataframe(results, expected_df):
@pytest.mark.parametrize(
"results, expected",
[
# Test case 1: Normal results with "date" column
"results, expected_dict",
[ # Case 1: Normal results with "date" column
(
[{"date": "2023-07-30", "value": 10}, {"date": "2023-07-31", "value": 20}],
{
"date": [pd.to_datetime("2023-07-30"), pd.to_datetime("2023-07-31")],
"value": [10, 20],
},
{"date": ["2023-07-30", "2023-07-31"], "value": [10, 20]},
),
# Test case 2: Normal results without "date" column
# Case 2: Normal results without "date" column
(
[{"value": 10}, {"value": 20}],
{
"value": [10, 20],
},
{"value": [10, 20]},
),
# Test case 3: Empty results
# Test case 3: Dict of lists
(
{"0": [0, 2], "1": [1, 3], "2": [2, 0], "3": [3, 1], "4": [4, 6]},
{"0": [0, 2], "1": [1, 3], "2": [2, 0], "3": [3, 1], "4": [4, 6]},
),
# Test case 4: No results
([], OpenBBError("Results not found.")),
# Test case 5: Results as None, should raise OpenBBError
(None, OpenBBError("Results not found.")),
# Test case 6: List of tuples
(
[(3, 2), (1, 3), (2, 0), (3, 1), (4, 6)],
{0: [3, 1, 2, 3, 4], 1: [2, 3, 0, 1, 6]},
),
# Test case 7: List of Strings
(
["YOLO2", "YOLO3", "YOLO0", "YOLO1", "YOLO6"],
{0: ["YOLO2", "YOLO3", "YOLO0", "YOLO1", "YOLO6"]},
),
# Test case 8: List of Numbers
(
[1, 0.42, 12321, 1293, 0.00123],
{0: [1, 0.42, 12321, 1293, 0.00123]},
),
# Test case 9: Dict of Dicts
(
{
"0": {"x": 0, "y": 2},
"1": {"x": 1, "y": 3},
"2": {"x": 2, "y": 0},
"3": {"x": 3, "y": 1},
"4": {"x": 4, "y": 6},
},
{"x": [0, 1, 2, 3, 4], "y": [2, 3, 0, 1, 6]},
),
],
)
def test_to_dict(results, expected):
def test_to_dict(results, expected_dict):
"""Test helper."""
# Arrange
if results:
results = [Data(**d) for d in results]
co = OBBject(results=results)
# Act and Assert
if isinstance(expected, Exception):
with pytest.raises(expected.__class__) as exc_info:
if isinstance(expected_dict, (list, dict)):
result = co.to_dict()
assert result == expected_dict
else:
with pytest.raises(expected_dict.__class__) as exc_info:
co.to_dict()
assert str(exc_info.value) == str(expected)
else:
result = co.to_dict()
result.pop("index", None)
assert result == expected
assert str(exc_info.value) == str(expected_dict)
@patch("openbb_core.app.model.obbject.OBBject.to_dataframe")