mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-01 06:51:38 +00:00
4400cd9a8f
* small changes - moving provider inside the core * uptade readme * lint * remove old provider readme * leftovers * refactor website examples * ruff * fix nox * relock * fix fails_to_deliver headers * fix for tests that have renamed endpoints * fix discovery * removed test for renamed endpoint * fix broken syntax - test_search_financial_attributes * fix cash/income/balance * fix derivatives tests * fix etf tests * fix news tests * fix regulators * black * wrong test param * sort equity gainers/losers by percent * platform markdown generation import * Hotfix/fix int tests core merge (#5779) * removing tests on old endpoint * removing visualization on old endpoint * fixing equity tests * fixing examples * fix news tests * fix index test * example * add comments * example --------- Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> --------- Co-authored-by: montezdesousa <79287829+montezdesousa@users.noreply.github.com> Co-authored-by: Diogo Sousa <montezdesousa@gmail.com> Co-authored-by: Danglewood <85772166+deeleeramone@users.noreply.github.com> Co-authored-by: Pratyush Shukla <ps4534@nyu.edu>
109 lines
2.8 KiB
Python
109 lines
2.8 KiB
Python
"""Tiingo Helpers Module."""
|
|
|
|
import json
|
|
from io import StringIO
|
|
from typing import Any, List, Optional, TypeVar, Union
|
|
|
|
import requests
|
|
from openbb_core.provider import helpers
|
|
from openbb_core.provider.utils.errors import EmptyDataError
|
|
from pydantic import BaseModel
|
|
from requests.exceptions import SSLError
|
|
|
|
T = TypeVar("T", bound=BaseModel)
|
|
|
|
|
|
class BasicResponse:
|
|
"""Basic Response class."""
|
|
|
|
def __init__(self, response: StringIO):
|
|
"""Initialize the BasicResponse class."""
|
|
# Find a way to get the status code
|
|
self.status_code = 200
|
|
response.seek(0)
|
|
self.text = response.read()
|
|
|
|
def json(self) -> dict:
|
|
"""Return the response as a dictionary."""
|
|
return json.loads(self.text)
|
|
|
|
|
|
def request(url: str) -> BasicResponse:
|
|
"""
|
|
Request function for PyScript. Pass in Method and make sure to await.
|
|
|
|
Parameters:
|
|
-----------
|
|
url: str
|
|
URL to make request to
|
|
|
|
Return:
|
|
-------
|
|
response: BasicRequest
|
|
BasicRequest object with status_code and text attributes
|
|
"""
|
|
# pylint: disable=import-outside-toplevel
|
|
from pyodide.http import open_url # type: ignore
|
|
|
|
response = open_url(url)
|
|
return BasicResponse(response)
|
|
|
|
|
|
def get_data(url: str, **kwargs: Any) -> Union[list, dict]:
|
|
"""Get data from Tiingo endpoint."""
|
|
try:
|
|
r: Union[requests.Response, BasicResponse] = helpers.make_request(url, **kwargs)
|
|
except SSLError:
|
|
r = request(url)
|
|
if r.status_code == 404:
|
|
raise RuntimeError("Tiingo endpoint doesn't exist")
|
|
|
|
data = r.json()
|
|
if r.status_code != 200:
|
|
error = data.get("detail")
|
|
raise RuntimeError(f"Error in Tiingo request -> {error}")
|
|
|
|
if len(data) == 0:
|
|
raise EmptyDataError()
|
|
|
|
return data
|
|
|
|
|
|
def get_data_many(
|
|
url: str, sub_dict: Optional[str] = None, **kwargs: Any
|
|
) -> List[dict]:
|
|
"""Get data from Tiingo endpoint and convert to list of schemas.
|
|
|
|
Parameters:
|
|
-----------
|
|
url: str
|
|
The URL to get the data from.
|
|
sub_dict: Optional[str]
|
|
The sub-dictionary to use.
|
|
|
|
Returns:
|
|
--------
|
|
List[dict]
|
|
Dictionary of data.
|
|
"""
|
|
data = get_data(url, **kwargs)
|
|
if sub_dict and isinstance(data, dict):
|
|
data = data.get(sub_dict, [])
|
|
if isinstance(data, dict):
|
|
raise ValueError("Expected list of dicts, got dict")
|
|
return data
|
|
|
|
|
|
def get_data_one(url: str, **kwargs: Any) -> dict:
|
|
"""Get data from Tiingo endpoint and convert to schema."""
|
|
data = get_data(url, **kwargs)
|
|
if isinstance(data, list):
|
|
if len(data) == 0:
|
|
raise ValueError("Expected dict, got empty list")
|
|
try:
|
|
data = {i: data[i] for i in range(len(data))} if len(data) > 1 else data[0]
|
|
except TypeError as e:
|
|
raise ValueError("Expected dict, got list of dicts") from e
|
|
|
|
return data
|