kensho-kfinance 3.2.15__tar.gz → 3.2.16__tar.gz

{kensho_kfinance-3.2.15/kensho_kfinance.egg-info → kensho_kfinance-3.2.16}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 3.2.15
+Version: 3.2.16
 Summary: Python CLI for kFinance
 Author-email: Luke Brown <luke.brown@kensho.com>, Michelle Keoy <michelle.keoy@kensho.com>, Keith Page <keith.page@kensho.com>, Matthew Rosen <matthew.rosen@kensho.com>, Nick Roshdieh <nick.roshdieh@kensho.com>
 Project-URL: source, https://github.com/kensho-technologies/kfinance

{kensho_kfinance-3.2.15 → kensho_kfinance-3.2.16/kensho_kfinance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 3.2.15
+Version: 3.2.16
 Summary: Python CLI for kFinance
 Author-email: Luke Brown <luke.brown@kensho.com>, Michelle Keoy <michelle.keoy@kensho.com>, Keith Page <keith.page@kensho.com>, Matthew Rosen <matthew.rosen@kensho.com>, Nick Roshdieh <nick.roshdieh@kensho.com>
 Project-URL: source, https://github.com/kensho-technologies/kfinance

{kensho_kfinance-3.2.15 → kensho_kfinance-3.2.16}/kfinance/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v3.2.16
+- Allow None and "NaN" for DecimalWithValue
+
 ## v3.2.15
 - Add smart line item validation with intelligent suggestions and descriptions to reduce token consumption by 75%
 

{kensho_kfinance-3.2.15 → kensho_kfinance-3.2.16}/kfinance/client/models/decimal_with_unit.py

@@ -2,7 +2,7 @@ from copy import deepcopy
 from decimal import Decimal
 from typing import Any
 
-from pydantic import BaseModel, Field, model_validator
+from pydantic import BaseModel, Field, field_validator, model_validator
 from typing_extensions import Self
 
 from kfinance.client.models.currency_models import ISO_CODE_TO_CURRENCY
@@ -20,11 +20,23 @@ class DecimalWithUnit(BaseModel):
     existing subclass like `Money` or `Shares` or create a new one.
     """
 
-    value: Decimal
+    value: Decimal = Field(allow_inf_nan=True)
     unit: str
     # exclude conventional_decimals from serialization
     conventional_decimals: int = Field(exclude=True)
 
+    @field_validator("value", mode="before")
+    @classmethod
+    def convert_none_to_nan(cls, v: Any) -> Any:
+        """Convert None values to NaN.
+
+        Price data can include None for open prices.
+        https://kfinance.kensho.com/api/v1/pricing/37284793/2003-01-01/2024-12-31/month/adjusted
+        """
+        if v is None:
+            return Decimal("NaN")
+        return v
+
     @model_validator(mode="after")
     def quantize_value(self) -> Self:
         """Quantize the value at the end of the deserialization.

{kensho_kfinance-3.2.15 → kensho_kfinance-3.2.16}/kfinance/client/models/tests/test_decimal_with_unit.py

@@ -32,6 +32,15 @@ class TestDecimalWithUnit:
         )
         assert dwu.value == expected_value
 
+    @pytest.mark.parametrize("value", [None, "NaN"])
+    def test_null_nan_allowed(self, value: str | None):
+        """
+        WHEN a DecimalWithUnit gets deserialized with None or "NaN"
+        THEN the deserialized value is Decimal("NaN")
+        """
+        dwu = DecimalWithUnit.model_validate(dict(value=value, conventional_decimals=1, unit="foo"))
+        assert dwu.value.is_nan()
+
 
 class TestMoney:
     @pytest.mark.parametrize("currency, expected_conventional_decimals", [("USD", 2), ("BIF", 0)])

{kensho_kfinance-3.2.15 → kensho_kfinance-3.2.16}/kfinance/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.2.15'
-__version_tuple__ = version_tuple = (3, 2, 15)
+__version__ = version = '3.2.16'
+__version_tuple__ = version_tuple = (3, 2, 16)
 
-__commit_id__ = commit_id = 'ga3e6ee4d3'
+__commit_id__ = commit_id = 'g3610e6423'