summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authormontezdesousa <79287829+montezdesousa@users.noreply.github.com>2024-02-12 13:53:15 +0000
committerGitHub <noreply@github.com>2024-02-12 13:53:15 +0000
commit6648f51ab5c5cc4158bf4a18cb5a2f4a3dc24db5 (patch)
tree0c78341f18413daae087c2d30bd4abfa88976e4b
parentd31eec23541ac82d3e45a4ba337833e5aeca1645 (diff)
[Feature] - remove unused validators from standard models (#6067)
* update standard models * lint
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/analyst_estimates.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/balance_sheet.py10
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/balance_sheet_growth.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/cash_flow.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/cash_flow_growth.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/company_overview.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/earnings_call_transcript.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/equity_historical.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/equity_info.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/equity_ownership.py10
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/equity_peers.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/equity_quote.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/equity_valuation_multiples.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/esg_risk_rating.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/esg_score.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/etf_countries.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/etf_historical.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/etf_historical_nav.py7
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/etf_info.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/etf_sectors.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/executive_compensation.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/financial_ratios.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/fred_series.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/futures_curve.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/futures_historical.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/historical_attributes.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/historical_dividends.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/historical_employees.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/historical_eps.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/historical_splits.py7
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/income_statement.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/income_statement_growth.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/index_historical.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/index_info.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/index_sectors.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/insider_trading.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/institutional_ownership.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/key_executives.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/key_metrics.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/latest_attributes.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/market_indices.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/options_chains.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/otc_aggregate.py3
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/price_target.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/price_target_consensus.py6
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/recent_performance.py8
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/reported_financials.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/revenue_business_line.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/revenue_geographic.py9
-rw-r--r--openbb_platform/core/openbb_core/provider/standard_models/share_statistics.py6
50 files changed, 116 insertions, 253 deletions
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/analyst_estimates.py b/openbb_platform/core/openbb_core/provider/standard_models/analyst_estimates.py
index 87814db18e9..7ffe2462b0a 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/analyst_estimates.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/analyst_estimates.py
@@ -24,11 +24,9 @@ class AnalystEstimatesQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class AnalystEstimatesData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet.py b/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet.py
index 80ef5c30d3a..799b8ab197c 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet.py
@@ -1,6 +1,5 @@
"""Balance Sheet Standard Model."""
-import warnings
from datetime import date as dateType
from typing import Optional
@@ -12,8 +11,6 @@ from openbb_core.provider.utils.descriptions import (
QUERY_DESCRIPTIONS,
)
-_warn = warnings.warn
-
class BalanceSheetQueryParams(QueryParams):
"""Balance Sheet Query."""
@@ -30,12 +27,7 @@ class BalanceSheetQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
def upper_symbol(cls, v: str):
- """Convert symbol to uppercase."""
- if "," in v:
- _warn(
- f"{QUERY_DESCRIPTIONS.get('symbol_list_warning', '')} {v.split(',')[0].upper()}"
- )
- return v.split(",")[0].upper() if "," in v else v.upper()
+ return v.upper()
class BalanceSheetData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet_growth.py b/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet_growth.py
index 0c5394be4dc..746eaacf0e3 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet_growth.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/balance_sheet_growth.py
@@ -21,11 +21,9 @@ class BalanceSheetGrowthQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str):
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class BalanceSheetGrowthData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/cash_flow.py b/openbb_platform/core/openbb_core/provider/standard_models/cash_flow.py
index 8e7cc2b40a4..a2495a26da1 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/cash_flow.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/cash_flow.py
@@ -1,6 +1,5 @@
"""Cash Flow Statement Standard Model."""
-import warnings
from datetime import date as dateType
from typing import Optional
@@ -10,8 +9,6 @@ from openbb_core.provider.abstract.data import Data
from openbb_core.provider.abstract.query_params import QueryParams
from openbb_core.provider.utils.descriptions import QUERY_DESCRIPTIONS
-_warn = warnings.warn
-
class CashFlowStatementQueryParams(QueryParams):
"""Cash Flow Statement Query."""
@@ -29,11 +26,7 @@ class CashFlowStatementQueryParams(QueryParams):
@classmethod
def upper_symbol(cls, v: str):
"""Convert symbol to uppercase."""
- if "," in v:
- _warn(
- f"{QUERY_DESCRIPTIONS.get('symbol_list_warning', '')} {v.split(',')[0].upper()}"
- )
- return v.split(",")[0].upper() if "," in v else v.upper()
+ return v.upper()
class CashFlowStatementData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/cash_flow_growth.py b/openbb_platform/core/openbb_core/provider/standard_models/cash_flow_growth.py
index b163d2c6507..509ecfbb272 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/cash_flow_growth.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/cash_flow_growth.py
@@ -21,11 +21,9 @@ class CashFlowStatementGrowthQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class CashFlowStatementGrowthData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/company_overview.py b/openbb_platform/core/openbb_core/provider/standard_models/company_overview.py
index 8079a5c6c4c..0fbdb116615 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/company_overview.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/company_overview.py
@@ -20,11 +20,9 @@ class CompanyOverviewQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class CompanyOverviewData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/earnings_call_transcript.py b/openbb_platform/core/openbb_core/provider/standard_models/earnings_call_transcript.py
index d6f229e464c..4e9aae90479 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/earnings_call_transcript.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/earnings_call_transcript.py
@@ -21,11 +21,9 @@ class EarningsCallTranscriptQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class EarningsCallTranscriptData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/equity_historical.py b/openbb_platform/core/openbb_core/provider/standard_models/equity_historical.py
index 9b9d79381c5..2789e57ba35 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/equity_historical.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/equity_historical.py
@@ -4,7 +4,7 @@ from datetime import (
date as dateType,
datetime,
)
-from typing import List, Optional, Set, Union
+from typing import Optional, Union
from dateutil import parser
from pydantic import Field, field_validator
@@ -36,11 +36,9 @@ class EquityHistoricalQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class EquityHistoricalData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/equity_info.py b/openbb_platform/core/openbb_core/provider/standard_models/equity_info.py
index bc62fc538e8..1062fe4ff51 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/equity_info.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/equity_info.py
@@ -20,11 +20,9 @@ class EquityInfoQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class EquityInfoData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/equity_ownership.py b/openbb_platform/core/openbb_core/provider/standard_models/equity_ownership.py
index 7a34132f827..b354f3f2fc3 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/equity_ownership.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/equity_ownership.py
@@ -1,7 +1,7 @@
"""Equity Ownership Standard Model."""
from datetime import date as dateType
-from typing import List, Optional, Set, Union
+from typing import Optional
from pydantic import Field, field_validator
@@ -16,6 +16,8 @@ from openbb_core.provider.utils.descriptions import (
class EquityOwnershipQueryParams(QueryParams):
"""Equity Ownership Query."""
+ __validator_dict__ = {"check_single": ("symbol",)}
+
symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", ""))
date: Optional[dateType] = Field(
default=None, description=QUERY_DESCRIPTIONS.get("date", "")
@@ -33,11 +35,9 @@ class EquityOwnershipQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class EquityOwnershipData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/equity_peers.py b/openbb_platform/core/openbb_core/provider/standard_models/equity_peers.py
index 11cc67ac192..142a06055a7 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/equity_peers.py
+++ b/openbb_platform/core/openbb_core/provider/standard_models/equity_peers.py
@@ -1,6 +1,6 @@
"""Equity Peers Standard Model."""
-from typing import List, Set, Union
+from typing import List
from pydantic import Field, field_validator
@@ -16,11 +16,9 @@ class EquityPeersQueryParams(QueryParams):
@field_validator("symbol", mode="before", check_fields=False)
@classmethod
- def upper_symbol(cls, v: Union[str, List[str], Set[str]]):
+ def upper_symbol(cls, v: str) -> str:
"""Convert symbol to uppercase."""
- if isinstance(v, str):
- return v.upper()
- return ",".join([symbol.upper() for symbol in list(v)])
+ return v.upper()
class EquityPeersData(Data):
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/equity_quote.py b/openbb_platform/core/openbb_core/provider/standard_models/equity_quote.py
index 7c7168a3a5e..6f621497249 100644
--- a/openbb_platform/core/openbb_core/provider/standard_models/equity_quote.py
+++ b/openbb_platform/core/openbb_core/provider/standard_mo