diff options
author | Henrique Joaquim <h.joaquim@campus.fct.unl.pt> | 2024-01-08 19:36:43 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2024-01-08 19:36:43 +0000 |
commit | bae33881d2dc17bc0acfa1b33132e0ab73413baa (patch) | |
tree | 23fde8920d5b708ce320bdc626bb2a373a302c85 | |
parent | f79f50abbc3ce2c2af94143628a8c4162452ebc0 (diff) |
Introduces a limit argument for the `equity.fundamental.trailing_dividend_yield` endpoint (#5925)
* introduces a limit argument for the equity.fundamental.trailing_dividend_yield endpoint
* add default args to test
4 files changed, 10 insertions, 3 deletions
diff --git a/openbb_platform/core/openbb_core/provider/standard_models/trailing_dividend_yield.py b/openbb_platform/core/openbb_core/provider/standard_models/trailing_dividend_yield.py index 78529e476ca..e208f6ede31 100644 --- a/openbb_platform/core/openbb_core/provider/standard_models/trailing_dividend_yield.py +++ b/openbb_platform/core/openbb_core/provider/standard_models/trailing_dividend_yield.py @@ -2,6 +2,7 @@ from datetime import date as dateType +from typing import Optional from pydantic import Field @@ -17,6 +18,11 @@ class TrailingDivYieldQueryParams(QueryParams): """Trailing Dividend Yield Query.""" symbol: str = Field(default=None, description=QUERY_DESCRIPTIONS.get("symbol", "")) + limit: Optional[int] = Field( + default=252, + description=f"{QUERY_DESCRIPTIONS.get('limit', '')}" + " Default is 252, the number of trading days in a year.", + ) class TrailingDivYieldData(Data): diff --git a/openbb_platform/extensions/equity/integration/test_equity_api.py b/openbb_platform/extensions/equity/integration/test_equity_api.py index bbd8e4eb1d6..b25085736b6 100644 --- a/openbb_platform/extensions/equity/integration/test_equity_api.py +++ b/openbb_platform/extensions/equity/integration/test_equity_api.py @@ -1442,7 +1442,7 @@ def test_equity_fundamental_historical_eps(params, headers): @parametrize( "params", - [({"provider": "tiingo", "symbol": "AAPL"})], + [({"provider": "tiingo", "symbol": "AAPL", "limit": 10})], ) @pytest.mark.integration def test_equity_fundamental_trailing_dividend_yield(params, headers): diff --git a/openbb_platform/extensions/equity/integration/test_equity_python.py b/openbb_platform/extensions/equity/integration/test_equity_python.py index fb83e7813b1..9c6cf964b73 100644 --- a/openbb_platform/extensions/equity/integration/test_equity_python.py +++ b/openbb_platform/extensions/equity/integration/test_equity_python.py @@ -1361,7 +1361,7 @@ def test_equity_fundamental_historical_eps(params, obb): @parametrize( "params", - [({"provider": "tiingo", "symbol": "AAPL"})], + [({"provider": "tiingo", "symbol": "AAPL", "limit": 10})], ) @pytest.mark.integration def test_equity_fundamental_trailing_dividend_yield(params, obb): diff --git a/openbb_platform/providers/tiingo/openbb_tiingo/models/trailing_dividend_yield.py b/openbb_platform/providers/tiingo/openbb_tiingo/models/trailing_dividend_yield.py index 57acaa6aa5e..a0332caee5b 100644 --- a/openbb_platform/providers/tiingo/openbb_tiingo/models/trailing_dividend_yield.py +++ b/openbb_platform/providers/tiingo/openbb_tiingo/models/trailing_dividend_yield.py @@ -37,7 +37,7 @@ class TiingoTrailingDivYieldFetcher( transformed_params = params return TiingoTrailingDivYieldQueryParams(**transformed_params) - # pylint: disable=protected-access + # pylint: disable=unused-argument @staticmethod def extract_data( query: TiingoTrailingDivYieldQueryParams, @@ -60,4 +60,5 @@ class TiingoTrailingDivYieldFetcher( **kwargs: Any, ) -> List[TiingoTrailingDivYieldData]: """Return the transformed data.""" + data = data[-query.limit :] if query.limit else data return [TiingoTrailingDivYieldData.model_validate(d) for d in data] |