diff options
22 files changed, 144 insertions, 145 deletions
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py b/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py index 743ec65a746..93149d1c377 100644 --- a/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py +++ b/openbb_platform/core/openbb_core/provider/standard_models/treasury_rates.py @@ -33,65 +33,65 @@ class TreasuryRatesData(Data): week_4: Optional[float] = Field( default=None, description="4 week Treasury bills rate (secondary market).", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_1: Optional[float] = Field( description="1 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_2: Optional[float] = Field( description="2 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_3: Optional[float] = Field( description="3 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) month_6: Optional[float] = Field( description="6 month Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_1: Optional[float] = Field( description="1 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_2: Optional[float] = Field( description="2 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_3: Optional[float] = Field( description="3 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_5: Optional[float] = Field( description="5 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_7: Optional[float] = Field( description="7 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_10: Optional[float] = Field( description="10 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_20: Optional[float] = Field( description="20 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) year_30: Optional[float] = Field( description="30 year Treasury rate.", default=None, - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) diff --git a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py index f5cf40a2a5a..c4aeba33416 100644 --- a/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py +++ b/openbb_platform/providers/benzinga/openbb_benzinga/models/analyst_search.py @@ -90,19 +90,19 @@ class BenzingaAnalystSearchData(AnalystSearchData): overall_success_rate: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain overall.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) overall_avg_return_percentile: Optional[float] = Field( default=None, description="The percentile (normalized) of this analyst's overall average" + " return per rating in comparison to other analysts' overall average returns per rating.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) total_ratings_percentile: Optional[float] = Field( default=None, description="The percentile (normalized) of this analyst's total number of ratings" + " in comparison to the total number of ratings published by all other analysts", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) total_ratings: Optional[int] = Field( default=None, @@ -119,13 +119,13 @@ class BenzingaAnalystSearchData(AnalystSearchData): overall_average_return: Optional[float] = Field( default=None, description="The average percent (normalized) price difference per rating since the date of recommendation", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) overall_std_dev: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings since the date of recommendation", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="overall_stdev", ) gain_count_1m: Optional[int] = Field( @@ -141,14 +141,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): average_return_1m: Optional[float] = Field( default=None, description="The average percent (normalized) price difference per rating over the last month", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1m_average_return", ) std_dev_1m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last month", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1m_stdev", ) smart_score_1m: Optional[float] = Field( @@ -159,7 +159,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_1m: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last month", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1m_success_rate", ) gain_count_3m: Optional[int] = Field( @@ -176,14 +176,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 3 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3m_average_return", ) std_dev_3m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 3 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3m_stdev", ) smart_score_3m: Optional[float] = Field( @@ -194,7 +194,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_3m: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3m_success_rate", ) gain_count_6m: Optional[int] = Field( @@ -211,14 +211,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 6 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="6m_average_return", ) std_dev_6m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 6 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="6m_stdev", ) gain_count_9m: Optional[int] = Field( @@ -235,14 +235,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 9 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="9m_average_return", ) std_dev_9m: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 9 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="9m_stdev", ) smart_score_9m: Optional[float] = Field( @@ -253,7 +253,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_9m: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 9 months", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="9m_success_rate", ) gain_count_1y: Optional[int] = Field( @@ -270,14 +270,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 1 year", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1y_average_return", ) std_dev_1y: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 1 year", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1y_stdev", ) smart_score_1y: Optional[float] = Field( @@ -288,7 +288,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_1y: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 1 year", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="1y_success_rate", ) gain_count_2y: Optional[int] = Field( @@ -305,14 +305,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 2 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="2y_average_return", ) std_dev_2y: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 2 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="2y_stdev", ) smart_score_2y: Optional[float] = Field( @@ -323,7 +323,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_2y: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 2 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="2y_success_rate", ) gain_count_3y: Optional[int] = Field( @@ -340,14 +340,14 @@ class BenzingaAnalystSearchData(AnalystSearchData): default=None, description="The average percent (normalized) price difference per rating over" + " the last 3 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3y_average_return", ) std_dev_3y: Optional[float] = Field( default=None, description="The standard deviation in percent (normalized) price difference in the" + " analyst's ratings over the last 3 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3y_stdev", ) smart_score_3y: Optional[float] = Field( @@ -358,7 +358,7 @@ class BenzingaAnalystSearchData(AnalystSearchData): success_rate_3y: Optional[float] = Field( default=None, description="The percentage (normalized) of gain/loss ratings that resulted in a gain over the last 3 years", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, alias="3y_success_rate", ) diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py b/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py index 4c53fde9cf2..5a1c76c07a1 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/compare_groups.py @@ -79,42 +79,42 @@ class FinvizCompareGroupsData(CompareGroupsData): performance_1D: Optional[float] = Field( default=None, description="The performance in the last day, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_1W: Optional[float] = Field( default=None, description="The performance in the last week, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_1M: Optional[float] = Field( default=None, description="The performance in the last month, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_3M: Optional[float] = Field( default=None, description="The performance in the last quarter, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_6M: Optional[float] = Field( default=None, description="The performance in the last half year, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_1Y: Optional[float] = Field( default=None, description="The performance in the last year, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) performance_YTD: Optional[float] = Field( default=None, description="The performance in the year to date, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) dividend_yield: Optional[float] = Field( default=None, description="The dividend yield of the group, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) pe: Optional[float] = Field( default=None, @@ -132,23 +132,23 @@ class FinvizCompareGroupsData(CompareGroupsData): eps_growth_past_5_years: Optional[float] = Field( default=None, description="The EPS growth of the group for the past 5 years, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) eps_growth_next_5_years: Optional[float] = Field( default=None, description="The estimated EPS growth of the groupo for the next 5 years," + " as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) sales_growth_past_5_years: Optional[float] = Field( default=None, description="The sales growth of the group for the past 5 years, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) float_short: Optional[float] = Field( default=None, description="The percent of the float shorted for the group, as a normalized value.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) analyst_recommendation: Optional[float] = Field( default=None, diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py b/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py index f6f29c1791a..a81fe6c5085 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/equity_profile.py @@ -1,8 +1,9 @@ """Finviz Equity Profile Model.""" # pylint: disable=unused-argument -import warnings + from typing import Any, Dict, List, Optional +from warnings import warn from finvizfinance.quote import finvizfinance from openbb_core.provider.abstract.fetcher import Fetcher @@ -12,8 +13,6 @@ from openbb_core.provider.standard_models.equity_info import ( ) from pydantic import Field -_warn = warnings.warn - class FinvizEquityProfileQueryParams(EquityInfoQueryParams): """ @@ -59,7 +58,7 @@ class FinvizEquityProfileData(EquityInfoData): institutional_ownership: Optional[float] = Field( default=None, description="The institutional ownership of the stock, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) market_cap: Optional[str] = Field( default=None, @@ -68,7 +67,7 @@ class FinvizEquityProfileData(EquityInfoData): dividend_yield: Optional[float] = Field( default=None, description="The dividend yield of the stock, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) earnings_date: Optional[str] = Field( default=None, @@ -99,17 +98,17 @@ class FinvizEquityProfileFetcher( ) -> List[Dict]: """Extract the raw data from Finviz.""" - results = [] + results: List = [] def get_one(symbol) -> Dict: """Get the data for one symbol.""" - result = {} + result: Dict = {} try: data = finvizfinance(symbol) fundament = data.ticker_fundament() description = data.ticker_description() except Exception as e: # pylint: disable=W0718 - _warn(f"Failed to get data for {symbol} -> {e}") + warn(f"Failed to get data for {symbol} -> {e}") return result div_yield = ( float(str(fundament.get("Dividend %", None)).replace("%", "")) / 100 diff --git a/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py b/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py index ec7096dc6a1..9ff3a002ed3 100644 --- a/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py +++ b/openbb_platform/providers/finviz/openbb_finviz/models/key_metrics.py @@ -61,42 +61,42 @@ class FinvizKeyMetricsData(KeyMetricsData): gross_margin: Optional[float] = Field( default=None, description="Gross margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) profit_margin: Optional[float] = Field( default=None, description="Profit margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) operating_margin: Optional[float] = Field( default=None, description="Operating margin, as a normalized percent.", - json_schema_extra={"unit_measurement": "percent", "frontend_multiply": 100}, + json_schema_extra={"x-unit_measurement": "percent", "x-frontend_multiply": 100}, ) return_on_assets: Optional[float] = Field( |