refactored ShareStatistics for stocks.fa.shrs

openbb_sdk/providers/fmp/openbb_fmp/models/share_statistics.py

@@ -1,47 +1,39 @@
 """FMP Share Statistics Fetcher."""
 
 
-from datetime import (
-    date as dateType,
-    datetime,
-)
+from datetime import datetime
 from typing import Any, Dict, List, Optional
 
-from openbb_provider.abstract.data import Data
 from openbb_provider.abstract.fetcher import Fetcher
-from openbb_provider.abstract.query_params import QueryParams
-from openbb_provider.models.base import BaseSymbol
 from openbb_provider.models.share_statistics import (
     ShareStatisticsData,
     ShareStatisticsQueryParams,
 )
-from pydantic import validator
 
 from openbb_fmp.utils.helpers import create_url, get_data_many
 
+from pydantic import validator
 
-class FMPShareStatisticsQueryParams(QueryParams, BaseSymbol):
+
+class FMPShareStatisticsQueryParams(ShareStatisticsQueryParams):
     """FMP Income Statement QueryParams.
 
     Source: https://site.financialmodelingprep.com/developer/docs/shares-float-api/
-
-    Parameter
-    ---------
-    symbol : str
-        The symbol of the company.
     """
 
 
-class FMPShareStatisticsData(Data):
-    symbol: str
-    date: dateType
-    freeFloat: float
-    floatShares: float
-    outstandingShares: float
-    source: str
+class FMPShareStatisticsData(ShareStatisticsData):
+    """FMP Share Statistics Data."""
+
+    class Config:
+        fields = {
+            "free_float": "freeFloat",
+            "float_shares": "floatShares",
+            "outstanding_shares": "outstandingShares",
+        }
 
     @validator("date", pre=True)
-    def time_validate(cls, v):  # pylint: disable=E0213
+    def date_validate(cls, v):  # pylint: disable=E0213
         return datetime.strptime(v, "%Y-%m-%d %H:%M:%S")
 
 
@@ -64,6 +56,7 @@ class FMPShareStatisticsFetcher(
         api_key = credentials.get("fmp_api_key") if credentials else ""
 
         url = create_url(4, "shares_float", api_key, query)
+
         return get_data_many(url, FMPShareStatisticsData)
 
     @staticmethod

openbb_sdk/sdk/provider/openbb_provider/models/share_statistics.py

@@ -6,40 +6,26 @@ from datetime import date as dateType
 from openbb_provider.abstract.data import Data
 from openbb_provider.abstract.query_params import QueryParams
 from openbb_provider.models.base import BaseSymbol
+from openbb_provider.descriptions import QUERY_DESCRIPTIONS
+
+from pydantic import Field
 
 
 class ShareStatisticsQueryParams(QueryParams, BaseSymbol):
-    """Share Statistics query.
-
-    Parameter
-    ---------
-    symbol : str
-        The symbol of the company.
-    """
+    """Share Statistics Query."""
 
 
-class ShareStatisticsData(Data):
-    """Return Share Statistics Data.
+class ShareStatisticsData(Data, BaseSymbol):
+    """Return Share Statistics Data."""
 
-    Returns
-    -------
-    symbol : str
-        The symbol of the company.
-    date : dateType
-        The date of the share statistics.
-    free_float : float
-        The free float of the company.
-    float_shares : float
-        The float shares of the company.
-    outstanding_shares : float
-        The outstanding shares of the company.
-    source : str
-        The source of the data.
-    """
-
-    symbol: str
-    date: dateType
-    free_float: float
-    float_shares: float
-    outstanding_shares: float
-    source: str
+    date: dateType = Field(description=QUERY_DESCRIPTIONS.get("date", ""))
+    free_float: float = Field(
+        description="The percentage of unrestricted shares of a publicly-traded company."
+    )
+    float_shares: float = Field(
+        description="The number of shares available for trading by the general public."
+    )
+    outstanding_shares: float = Field(
+        description="The total number of shares of a publicly-traded company."
+    )
+    source: str = Field(description="Source of the received data.")