wbfdm 1.54.5__py2.py3-none-any.whl → 1.54.7__py2.py3-none-any.whl

wbfdm/contrib/internal/dataloaders/market_data.py

@@ -2,11 +2,14 @@ from datetime import date
 from decimal import Decimal
 from typing import Iterator
 
+from django.db.models import Value
+from django.db.models.functions import Coalesce
+from wbcore.contrib.currency.models import Currency, CurrencyFXRates
 from wbcore.contrib.dataloader.dataloaders import Dataloader
 
 from wbfdm.dataloaders.protocols import MarketDataProtocol
 from wbfdm.dataloaders.types import MarketDataDict
-from wbfdm.enums import MarketData
+from wbfdm.enums import Frequency, MarketData
 from wbfdm.models.instruments.instrument_prices import InstrumentPrice
 
 MarketDataMap = {
@@ -33,11 +36,13 @@ def _cast_decimal_to_float(value: float | Decimal) -> float:
 class MarketDataDataloader(MarketDataProtocol, Dataloader):
     def market_data(
         self,
-        values: list[MarketData] | None = [MarketData.CLOSE],
+        values: list[MarketData] = [MarketData.CLOSE],
         from_date: date | None = None,
         to_date: date | None = None,
         exact_date: date | None = None,
-        calculated: bool | None = None,
+        frequency: Frequency = Frequency.DAILY,
+        target_currency: str | None = None,
+        apply_fx_rate: bool = True,
         **kwargs,
     ) -> Iterator[MarketDataDict]:
         """Get prices for instruments.
@@ -51,7 +56,27 @@ class MarketDataDataloader(MarketDataProtocol, Dataloader):
         Returns:
             Iterator[MarketDataDict]: An iterator of dictionaries conforming to the DailyValuationDict.
         """
-        prices = InstrumentPrice.objects.filter(instrument__in=self.entities).annotate_market_data()  # type: ignore
+        try:
+            target_currency = Currency.objects.get(key=target_currency)
+        except Currency.DoesNotExist:
+            target_currency = None
+        fx_rate = (
+            Coalesce(
+                CurrencyFXRates.get_fx_rates_subquery_for_two_currencies(
+                    "date", "instrument__currency", target_currency
+                ),
+                Value(Decimal("1")),
+            )
+            if target_currency
+            else Value(Decimal("1"))
+        )
+
+        prices = (
+            InstrumentPrice.objects.filter(instrument__in=self.entities)
+            .annotate_market_data()
+            .annotate(fx_rate=fx_rate)
+        )  # type: ignore
+        calculated = kwargs.get("calculated", None)
         if calculated is not None:
             prices = prices.filter(calculated=calculated)
         else:
@@ -72,11 +97,18 @@ class MarketDataDataloader(MarketDataProtocol, Dataloader):
             "date",
             "instrument",
             "calculated",
+            "fx_rate",
             *set(values_map.values()),
         ):
             external_id = row.pop("instrument")
             val_date = row.pop("date")
             if row:
+                fx_rate = row["fx_rate"]
+                if apply_fx_rate and row.get("net_value"):
+                    row["net_value"] = row["net_value"] * fx_rate
+                if apply_fx_rate and row.get("market_capitalization"):
+                    row["market_capitalization"] = row["market_capitalization"] * float(fx_rate)
+
                 yield MarketDataDict(
                     id=f"{external_id}_{val_date}",
                     valuation_date=val_date,
@@ -84,5 +116,6 @@ class MarketDataDataloader(MarketDataProtocol, Dataloader):
                     external_id=external_id,
                     source="wbfdm",
                     calculated=row["calculated"],
+                    fx_rate=_cast_decimal_to_float(fx_rate),
                     **{MarketData[k].value: _cast_decimal_to_float(row[v]) for k, v in values_map.items()},
                 )

wbfdm/contrib/qa/dataloaders/market_data.py

@@ -45,6 +45,7 @@ class DatastreamMarketDataDataloader(MarketDataProtocol, Dataloader):
         exact_date: date | None = None,
         frequency: Frequency = Frequency.DAILY,
         target_currency: str | None = None,
+        apply_fx_rate: bool = True,
         **kwargs,
     ) -> Iterator[MarketDataDict]:
         """Get market data for instruments.
@@ -97,7 +98,7 @@ class DatastreamMarketDataDataloader(MarketDataProtocol, Dataloader):
             fx_code = pk.Table("DS2FxCode")
             fx_rate = pk.Table("DS2FxRate")
             query = (
-                query
+                query.select((1 / fx_rate.midrate).as_("fx_rate"))
                 # Join FX code table matching currencies and ensuring SPOT rate type
                 .left_join(fx_code)
                 .on(
@@ -127,7 +128,7 @@ class DatastreamMarketDataDataloader(MarketDataProtocol, Dataloader):
             )
 
             value = pricing_2.Close_
-            if fx_rate:
+            if fx_rate and apply_fx_rate:
                 value /= Case().when(pricing_2.Currency == target_currency, 1).else_(fx_rate.midrate)
 
             query = query.select(value.as_("undadjusted_close"))
@@ -145,7 +146,7 @@ class DatastreamMarketDataDataloader(MarketDataProtocol, Dataloader):
         ):
             ds2_value = DS2MarketData[market_data.name].value
             value = getattr(pricing, ds2_value)
-            if fx_rate and market_data is not MarketData.SHARES_OUTSTANDING:
+            if fx_rate and apply_fx_rate and market_data is not MarketData.SHARES_OUTSTANDING:
                 value /= Case().when(pricing.Currency == target_currency, 1).else_(fx_rate.midrate)
 
             query = query.select(value.as_(market_data.value))

wbfdm/dataloaders/protocols.py

@@ -45,6 +45,7 @@ class MarketDataProtocol(Protocol):
         exact_date: date | None = None,
         frequency: Frequency = Frequency.DAILY,
         target_currency: str | None = None,
+        apply_fx_rate: bool = True,
     ) -> Iterator[MarketDataDict]: ...
 
 

wbfdm/dataloaders/proxies.py

@@ -80,6 +80,7 @@ class InstrumentDataloaderProxy(
         exact_date: date | None = None,
         frequency: Frequency = Frequency.DAILY,
         target_currency: str | None = None,
+        apply_fx_rate: bool = True,
     ) -> Iterator[MarketDataDict]:
         if not values:
             values = list(MarketData)
@@ -93,6 +94,7 @@ class InstrumentDataloaderProxy(
                     exact_date=exact_date,
                     frequency=frequency,
                     target_currency=target_currency,
+                    apply_fx_rate=apply_fx_rate,
                 ),
             )
 

wbfdm/dataloaders/types.py

@@ -65,7 +65,7 @@ class MarketDataDict(BaseDict):
     volume: NotRequired[float]
     market_cap: NotRequired[float]
     calculated: NotRequired[bool]
-
+    fx_rate: NotRequired[float]
     unadjusted_close: NotRequired[float]
     unadjusted_outstanding_shares: NotRequired[float | int]
 

wbfdm/models/instruments/mixin/instruments.py

@@ -42,7 +42,7 @@ class InstrumentPMSMixin:
     def get_price(self, val_date: date, price_date_timedelta: int = 3) -> Decimal:
         if self.is_cash:
             return Decimal(1)
-        return self._build_dto(val_date, price_date_timedelta=price_date_timedelta).close
+        return Decimal(self._build_dto(val_date, price_date_timedelta=price_date_timedelta).close)
 
     def _build_dto(self, val_date: date, price_date_timedelta: int = 3) -> PriceDTO:  # for backward compatibility
         try:

{wbfdm-1.54.5.dist-info → wbfdm-1.54.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: wbfdm
-Version: 1.54.5
+Version: 1.54.7
 Summary: The workbench module ensures rapid access to diverse financial data (market, fundamental, forecasts, ESG), with features for storing instruments, classifying them, and conducting financial analysis.
 Author-email: Christopher Wittlinger <c.wittlinger@stainly.com>
 Requires-Dist: roman==4.*

{wbfdm-1.54.5.dist-info → wbfdm-1.54.7.dist-info}/RECORD

@@ -41,7 +41,7 @@ wbfdm/contrib/dsws/client.py,sha256=C598w5P85kvX7_gR0Yf-WHRLj77HqztUhofBMl3JWAE,
 wbfdm/contrib/dsws/dataloaders/market_data.py,sha256=7Vj64nLqJAA3BiNeJPr3uLnnZ5kFOY2XGyAAJRL7vOk,6097
 wbfdm/contrib/internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbfdm/contrib/internal/dataloaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-wbfdm/contrib/internal/dataloaders/market_data.py,sha256=aoWSMamtnMbejYZrHzr37dQCG40nuA3fNBQNOyqhceQ,3260
+wbfdm/contrib/internal/dataloaders/market_data.py,sha256=FA7_f_20Gx1EjWOK9HDcWfX_gbBpOYXaxMR_O5T-K-Q,4542
 wbfdm/contrib/metric/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbfdm/contrib/metric/apps.py,sha256=T-Na_lyFeLR8ebGvaW-mcjKFLqiZcsPXnUlOuVPOiWw,297
 wbfdm/contrib/metric/decorators.py,sha256=VPmyjEJaq5HqXOt_ZizqcXfRqSEXw4lanDmubUjb2GY,476
@@ -100,7 +100,7 @@ wbfdm/contrib/qa/dataloaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NM
 wbfdm/contrib/qa/dataloaders/adjustments.py,sha256=DQEexOLA7WyBB1dZJHQd-6zbzyEIURgSSgS7bJRvXzQ,2980
 wbfdm/contrib/qa/dataloaders/corporate_actions.py,sha256=lWT6klrTXKqxiko2HGrxHH8E2C00FJS-AOX3IhglRrI,2912
 wbfdm/contrib/qa/dataloaders/financials.py,sha256=xUHpvhUkvmdPL_RyWCrs7XgChgTklX5qemmaXMedgkY,3475
-wbfdm/contrib/qa/dataloaders/market_data.py,sha256=Wp-LcQkytDCXQWywWkilhjgpIiT29U6_AUQRy3-pY6A,8104
+wbfdm/contrib/qa/dataloaders/market_data.py,sha256=0LjTN04WM2i9rrJ_M3M04cY0UbxMElsWiaqOC75xpHQ,8221
 wbfdm/contrib/qa/dataloaders/officers.py,sha256=vytlQJJxmn4Y5HfNh5mHJAvuIrrsQSkNO-sONyhxftY,2940
 wbfdm/contrib/qa/dataloaders/reporting_dates.py,sha256=q25ccB0pbGfLJLV1A1_AY1XYWJ_Fa10egY09L1J-C5A,2628
 wbfdm/contrib/qa/dataloaders/statements.py,sha256=hC6YErJcvBTmaAmzscgeC4sBK3lYE2U5eIKRIE9b_cs,10094
@@ -118,9 +118,9 @@ wbfdm/contrib/qa/sync/instruments.py,sha256=8aTQVJ_cw1phe4FWikn79pjCfUijaTcwkdhQ
 wbfdm/contrib/qa/sync/utils.py,sha256=LUnjNR28moT92cjP04SVCRQ_Ssp6SaO9kehgWV4zvOs,11782
 wbfdm/dataloaders/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbfdm/dataloaders/cache.py,sha256=K9BeVxT7p-BMvjurINt18bfrUDccp840uIjfDBLJRNk,4841
-wbfdm/dataloaders/protocols.py,sha256=xFbexmhh38MWmkWsOSsfcNxdtrrWfO02qNihsqwA_BQ,2987
-wbfdm/dataloaders/proxies.py,sha256=3Wt-_bj98Ykf9uiJSznNqCUbRQYdR8EvqQ73tPuBfD8,7072
-wbfdm/dataloaders/types.py,sha256=wrV0PrKLkLog-rCjtcGFkQuzdeY1w-JGfAetq-mKqFs,5565
+wbfdm/dataloaders/protocols.py,sha256=1vornH4tCIsd7HLL3lCiE0ni6YQEI6fF6Em_I-AUSFc,3023
+wbfdm/dataloaders/proxies.py,sha256=gA5QFXgbC78tQpmypow1dJ5k7UyqFGXDEyeS-xpUGEw,7157
+wbfdm/dataloaders/types.py,sha256=8PNHfBQj4C0xVn6cJxKQV3oBFxkTW3MGn4dMMRKVGJ4,5596
 wbfdm/factories/__init__.py,sha256=yYxAKBde_ksIr-3g4RjL6d5Wu-nmsuEDdYNyJpgfpQU,660
 wbfdm/factories/classifications.py,sha256=GJ0eARFTsj5dnKUsUYbLSIZLzTCy7RWhy7_f8Dn6IMQ,1827
 wbfdm/factories/controversies.py,sha256=GhuoEms1O7DIMVNAIbFEzD9DRv8j1MXIv0u1JK6Pi-o,929
@@ -248,7 +248,7 @@ wbfdm/models/instruments/llm/create_instrument_news_relationships.py,sha256=f9MT
 wbfdm/models/instruments/mixin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 wbfdm/models/instruments/mixin/financials_computed.py,sha256=L5wjXDsR0maiwfOKP6KyWNJNH4nGOoAjSc_hDM7fsj0,35105
 wbfdm/models/instruments/mixin/financials_serializer_fields.py,sha256=-OkpcUt1rZmB3nUcO2vckpJdVm8IxRqkPDEgcPqqoRU,68886
-wbfdm/models/instruments/mixin/instruments.py,sha256=BNcI1pnGQFjHHTx2qqzYnbfcJ_dq84OzO5g_uxxDOVI,10013
+wbfdm/models/instruments/mixin/instruments.py,sha256=fpt03q_Sq35R_ZmJpdcw81aA7wTocnp7ANE1jb-_cfI,10022
 wbfdm/serializers/__init__.py,sha256=AXb03RKHo6B0ts_IQOvx89n9wKG8pxiumYv9cr4EhvA,197
 wbfdm/serializers/esg.py,sha256=epoX8cjkPuVv45aW-Jf85-rSO_ZrSnXcTxMcadKdC-I,1086
 wbfdm/serializers/exchanges.py,sha256=wYvy0XBS9tRFHqin23gABQ_pj3Rmsx1B075SZ5GqwDo,1211
@@ -359,6 +359,6 @@ wbfdm/viewsets/statements/__init__.py,sha256=odxtFYUDICPmz8WCE3nx93EvKZLSPBEI4d7
 wbfdm/viewsets/statements/statements.py,sha256=gA6RCI8-B__JwjEb6OZxpn8Y-9aF-YQ3HIQ7e1vfJMw,4304
 wbfdm/viewsets/technical_analysis/__init__.py,sha256=qtCIBg0uSiZeJq_1tEQFilnorMBkMe6uCMfqar6-cLE,77
 wbfdm/viewsets/technical_analysis/monthly_performances.py,sha256=O1j8CGfOranL74LqVvcf7jERaDIboEJZiBf_AbbVDQ8,3974
-wbfdm-1.54.5.dist-info/METADATA,sha256=f2DXjGzPPVLrC04yFs9BiudySSdeC8UCr9BAJPRscQ4,768
-wbfdm-1.54.5.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
-wbfdm-1.54.5.dist-info/RECORD,,
+wbfdm-1.54.7.dist-info/METADATA,sha256=aa803KkLY9b9cQMX2W5Hn4jWv1apafyFnkqOeDBcCzQ,768
+wbfdm-1.54.7.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+wbfdm-1.54.7.dist-info/RECORD,,