diff options
author | montezdesousa <79287829+montezdesousa@users.noreply.github.com> | 2024-02-26 20:07:20 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-02-26 20:07:20 +0000 |
commit | ea26bf0c4ceddec88d0ba3e5606480d9c0c9af5b (patch) | |
tree | 4c6e9964e44292376df8f416059eb34b2fd1db57 | |
parent | 6a1ed9bd02f3169c74df25cb056b103ca2a119ba (diff) |
[Bug fix] - Fix regulator cik map standard model (#6129)
* Fix regulator cik map standard model
* fix description
* Update cik_map.py
3 files changed, 43 insertions, 25 deletions
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/cik_map.py b/openbb_platform/core/openbb_core/provider/standard_models/cik_map.py new file mode 100644 index 00000000000..23a1e9fa65d --- /dev/null +++ b/openbb_platform/core/openbb_core/provider/standard_models/cik_map.py @@ -0,0 +1,32 @@ +"""Cik Map Standard Model.""" + +from typing import Optional, Union + +from pydantic import Field, field_validator + +from openbb_core.provider.abstract.data import Data +from openbb_core.provider.abstract.query_params import QueryParams +from openbb_core.provider.utils.descriptions import ( + DATA_DESCRIPTIONS, + QUERY_DESCRIPTIONS, +) + + +class CikMapQueryParams(QueryParams): + """CikMap Query.""" + + symbol: str = Field(description=QUERY_DESCRIPTIONS.get("symbol", "")) + + @field_validator("symbol", mode="before", check_fields=False) + @classmethod + def upper_symbol(cls, v: str) -> str: + """Convert symbol to uppercase.""" + return v.upper() + + +class CikMapData(Data): + """CikMap Data.""" + + cik: Optional[Union[str, int]] = Field( + default=None, description=DATA_DESCRIPTIONS.get("cik", "") + ) diff --git a/openbb_platform/openbb/package/regulators_sec.py b/openbb_platform/openbb/package/regulators_sec.py index 2e14250b930..339862a6c1c 100644 --- a/openbb_platform/openbb/package/regulators_sec.py +++ b/openbb_platform/openbb/package/regulators_sec.py @@ -1,6 +1,6 @@ ### THIS FILE IS AUTO-GENERATED. DO NOT EDIT. ### -from typing import List, Literal, Optional, Union +from typing import Literal, Optional from openbb_core.app.model.custom_parameter import OpenBBCustomParameter from openbb_core.app.model.obbject import OBBject @@ -28,10 +28,7 @@ class ROUTER_regulators_sec(Container): def cik_map( self, symbol: Annotated[ - Union[str, List[str]], - OpenBBCustomParameter( - description="Symbol to get data for. Multiple items allowed: fmp, intrinio, yfinance." - ), + str, OpenBBCustomParameter(description="Symbol to get data for.") ], provider: Optional[Literal["sec"]] = None, **kwargs @@ -40,8 +37,8 @@ class ROUTER_regulators_sec(Container): Parameters ---------- - symbol : Union[str, List[str]] - Symbol to get data for. Multiple items allowed: fmp, intrinio, yfinance. + symbol : str + Symbol to get data for. provider : Optional[Literal['sec']] The provider to use for the query, by default None. If None, the provider specified in defaults is selected or 'sec' if there is @@ -63,8 +60,8 @@ class ROUTER_regulators_sec(Container): CikMap ------ - cik : Optional[Union[str, int]] - Central Index Key (provider: sec) + cik : Optional[Union[int, str]] + Central Index Key Example ------- @@ -87,11 +84,6 @@ class ROUTER_regulators_sec(Container): "symbol": symbol, }, extra_params=kwargs, - extra_info={ - "symbol": { - "multiple_items_allowed": ["fmp", "intrinio", "yfinance"] - } - }, ) ) @@ -140,7 +132,7 @@ class ROUTER_regulators_sec(Container): ------------------ name : Optional[str] The name of the institution. (provider: sec) - cik : Optional[Union[str, int]] + cik : Optional[Union[int, str]] Central Index Key (CIK) (provider: sec) Example diff --git a/openbb_platform/providers/sec/openbb_sec/models/cik_map.py b/openbb_platform/providers/sec/openbb_sec/models/cik_map.py index da06b3766b4..9b95f2a0e1a 100644 --- a/openbb_platform/providers/sec/openbb_sec/models/cik_map.py +++ b/openbb_platform/providers/sec/openbb_sec/models/cik_map.py @@ -1,28 +1,22 @@ """SEC CIK Mapping Model.""" -from typing import Any, Dict, Optional, Union +from typing import Any, Dict, Optional -from openbb_core.provider.abstract.data import Data from openbb_core.provider.abstract.fetcher import Fetcher -from openbb_core.provider.standard_models.equity_info import EquityInfoQueryParams +from openbb_core.provider.standard_models.cik_map import CikMapData, CikMapQueryParams from openbb_sec.utils.helpers import symbol_map -from pydantic import Field -class SecCikMapQueryParams(EquityInfoQueryParams): +class SecCikMapQueryParams(CikMapQueryParams): """SEC CIK Mapping Query. Source: https://sec.gov/ """ -class SecCikMapData(Data): +class SecCikMapData(CikMapData): """SEC CIK Mapping Data.""" - cik: Optional[Union[str, int]] = Field( - default=None, description="Central Index Key" - ) - class SecCikMapFetcher( Fetcher[ |