From ee4decd217ab6654e2c72f81385c34af77ea5a4a Mon Sep 17 00:00:00 2001 From: Theodore Aptekarev Date: Mon, 9 Oct 2023 11:50:25 +0200 Subject: [PATCH] Update some docstrings, fix typos and lint --- .../platform/core/tests/api/test_auth/test_user_auth.py | 1 - .../openbb_provider/standard_models/etf_countries.py | 3 ++- .../openbb_provider/standard_models/etf_historical_nav.py | 5 +++-- .../provider/openbb_provider/standard_models/etf_info.py | 3 ++- .../provider/openbb_provider/standard_models/etf_sectors.py | 3 ++- .../openbb_provider/standard_models/historical_eps.py | 5 +++-- .../openbb_provider/standard_models/index_constituents.py | 3 ++- .../provider/openbb_provider/standard_models/index_info.py | 3 ++- .../openbb_provider/standard_models/index_sectors.py | 3 ++- .../provider/openbb_provider/standard_models/industry_pe.py | 4 ++-- .../openbb_provider/standard_models/recent_performance.py | 3 ++- .../provider/openbb_provider/standard_models/sector_pe.py | 4 ++-- 12 files changed, 24 insertions(+), 16 deletions(-) diff --git a/openbb_platform/platform/core/tests/api/test_auth/test_user_auth.py b/openbb_platform/platform/core/tests/api/test_auth/test_user_auth.py index 3c99e64cefb..820c151f9be 100644 --- a/openbb_platform/platform/core/tests/api/test_auth/test_user_auth.py +++ b/openbb_platform/platform/core/tests/api/test_auth/test_user_auth.py @@ -11,7 +11,6 @@ from openbb_core.api.auth.user import ( get_user_settings, ) - # ruff: noqa: S105 S106 diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_countries.py b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_countries.py index eef4020bd46..28e9a3d10ac 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_countries.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_countries.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class EtfCountriesQueryParams(QueryParams): - """ETF Countries Query Params""" + """ETF Countries Query Params.""" symbol: str = Field(description="The exchange ticker symbol for the ETF.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_historical_nav.py b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_historical_nav.py index 5a6442aafa4..2b490bc888c 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_historical_nav.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_historical_nav.py @@ -10,11 +10,12 @@ from openbb_provider.abstract.query_params import QueryParams class EtfHistoricalNavQueryParams(QueryParams): - """ETF Historicl NAV Query Params""" + """ETF Historical Net Asset Value Query Params.""" symbol: str = Field(description="The exchange ticker symbol for the ETF.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): @@ -23,7 +24,7 @@ class EtfHistoricalNavQueryParams(QueryParams): class EtfHistoricalNavData(Data): - """ETF Historical NAV Data.""" + """ETF Historical Net Asset Value Data.""" date: dateType = Field(description="The date of the NAV.") nav: float = Field(description="The net asset value on the date.") diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_info.py b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_info.py index 3486b6e0a57..8f3e34670af 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_info.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_info.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class EtfInfoQueryParams(QueryParams): - """ETF Info Query Params""" + """ETF Info Query Params.""" symbol: str = Field(description="The exchange ticker symbol for the ETF.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_sectors.py b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_sectors.py index 90423144f6e..6570a29b0e0 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/etf_sectors.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/etf_sectors.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class EtfSectorsQueryParams(QueryParams): - """ETF Sectors Query Params""" + """ETF Sectors Query Params.""" symbol: str = Field(description="The exchange ticker symbol for the ETF.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/historical_eps.py b/openbb_platform/platform/provider/openbb_provider/standard_models/historical_eps.py index 75c50f730db..324a09573c3 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/historical_eps.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/historical_eps.py @@ -15,11 +15,12 @@ from openbb_provider.utils.descriptions import DATA_DESCRIPTIONS, QUERY_DESCRIPT class HistoricalEpsQueryParams(QueryParams): - """Historical EPS Query.""" + """Historical Earnings Per Share Query.""" symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", "")) @validator("symbol", pre=True, check_fields=False, always=True) + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): @@ -28,7 +29,7 @@ class HistoricalEpsQueryParams(QueryParams): class HistoricalEpsData(Data): - """Historical EPS Data.""" + """Historical Earnings Per Share Data.""" date: dateType = Field(default=None, description=DATA_DESCRIPTIONS.get("date", "")) symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", "")) diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/index_constituents.py b/openbb_platform/platform/provider/openbb_provider/standard_models/index_constituents.py index eddef9e34f5..cd545b31723 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/index_constituents.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/index_constituents.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class IndexConstituentsQueryParams(QueryParams): - """Index Constituents Query Params""" + """Index Constituents Query Params.""" symbol: str = Field(description="The index ticker symbol.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/index_info.py b/openbb_platform/platform/provider/openbb_provider/standard_models/index_info.py index bf01aedef89..a1a3e526f75 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/index_info.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/index_info.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class IndexInfoQueryParams(QueryParams): - """Index Info Query Params""" + """Index Info Query Params.""" symbol: str = Field(description="The index ticker symbol.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/index_sectors.py b/openbb_platform/platform/provider/openbb_provider/standard_models/index_sectors.py index cdfca26328c..90b6a8e2297 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/index_sectors.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/index_sectors.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class IndexSectorsQueryParams(QueryParams): - """Index Info Query Params""" + """Index Info Query Params.""" symbol: str = Field(description="The index ticker symbol.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/industry_pe.py b/openbb_platform/platform/provider/openbb_provider/standard_models/industry_pe.py index d9e0f7d4410..076b970c93e 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/industry_pe.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/industry_pe.py @@ -10,11 +10,11 @@ from openbb_provider.abstract.query_params import QueryParams class IndustryPEQueryParams(QueryParams): - """Industry P/E Ratio Query.""" + """Industry Price to Earnings Ratio Query.""" class IndustryPEData(Data): - """Industry P/E Ratio Data.""" + """Industry Price to Earnings Ratio Data.""" date: Optional[dateType] = Field( description="The date of the P/E ratio.", default=None diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/recent_performance.py b/openbb_platform/platform/provider/openbb_provider/standard_models/recent_performance.py index e286369a10d..b8378e26dd3 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/recent_performance.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/recent_performance.py @@ -9,11 +9,12 @@ from openbb_provider.abstract.query_params import QueryParams class RecentPerformanceQueryParams(QueryParams): - """Recent Performance Query Params""" + """Recent Performance Query Params.""" symbol: str = Field(description="The ticker symbol to fetch.") @field_validator("symbol") + @classmethod def upper_symbol(cls, v: Union[str, List[str], Set[str]]): """Convert symbol to uppercase.""" if isinstance(v, str): diff --git a/openbb_platform/platform/provider/openbb_provider/standard_models/sector_pe.py b/openbb_platform/platform/provider/openbb_provider/standard_models/sector_pe.py index 63747f23dd1..1faf69d4451 100644 --- a/openbb_platform/platform/provider/openbb_provider/standard_models/sector_pe.py +++ b/openbb_platform/platform/provider/openbb_provider/standard_models/sector_pe.py @@ -10,11 +10,11 @@ from openbb_provider.abstract.query_params import QueryParams class SectorPEQueryParams(QueryParams): - """Sector P/E Ratio Query.""" + """Sector Price to Earnings Ratio Query.""" class SectorPEData(Data): - """Sector P/E Ratio Data.""" + """Sector Price to Earnings Ratio Data.""" date: Optional[dateType] = Field( description="The date of the P/E ratio.", default=None