kensho-kfinance 3.2.11__py3-none-any.whl → 3.2.13__py3-none-any.whl

{kensho_kfinance-3.2.11.dist-info → kensho_kfinance-3.2.13.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 3.2.11
+Version: 3.2.13
 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.11.dist-info → kensho_kfinance-3.2.13.dist-info}/RECORD

@@ -1,11 +1,11 @@
-kensho_kfinance-3.2.11.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-3.2.11.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=XjHlM5qhd9E4fuTYuhy6Ef2Ol44NM8v7zqtFz1Vujf0,3500
+kensho_kfinance-3.2.13.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-3.2.13.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=z81MP-CD4T8Alp1QRMxNfIrdKki4ljwQpLQlQc4a_mM,3611
 kfinance/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 kfinance/conftest.py,sha256=PFflyOx08XgmEA0rdugud7QEA7KqARmd22SH2dLTqrE,4091
 kfinance/mcp.py,sha256=LTzCIlqsDKRD-0Xcpa_P99-JmJ8duAneO_-GzM43kjw,424
 kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/version.py,sha256=MJhMUFQz6_dDcgDJMKAskHXLUlIHM1XXIUEwKPqT7dA,706
+kfinance/version.py,sha256=J3pqLgy74OE8Fl2xQdOtnkegZoLi97vlblTAesq5P9s,706
 kfinance/client/README.md,sha256=DA5vg4uz1JmJNiqvYywrj46YNhOr584WO8L83Ysx_Mk,372
 kfinance/client/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/client/batch_request_handling.py,sha256=0r9x3-vXdpyKhfsIa6VZ9hovN60t3HB7nE3v5hnrSyI,6617
@@ -35,7 +35,7 @@ kfinance/domains/business_relationships/business_relationship_tools.py,sha256=xK
 kfinance/domains/business_relationships/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/business_relationships/tests/test_business_relationship_tools.py,sha256=e_EGtM4i5Qw5J1Wi2kXahkyjDA4mhHcT0DFAKA5JQdI,2459
 kfinance/domains/capitalizations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/domains/capitalizations/capitalization_models.py,sha256=vTmISvJuagwr8n4yF66M9pty_iIdYKb6okoc2vAyac4,3788
+kfinance/domains/capitalizations/capitalization_models.py,sha256=wKs9th3yoG84n3lC_9hF9QVeMQXKmmpFA-GaFTsCITY,3447
 kfinance/domains/capitalizations/capitalization_tools.py,sha256=3pG174VA-uLrbtk6xlER-xXZfz5PCePT_dE7dTCeNu0,5146
 kfinance/domains/capitalizations/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/capitalizations/tests/test_capitalization_models.py,sha256=SSFxEVnSLvuNjOK-gx4I3OCHso80OA37zOLmiHJhsro,3143
@@ -61,8 +61,8 @@ kfinance/domains/earnings/earning_tools.py,sha256=AmHZQKTGExPPxyDdjhrn5CVLvWr6xM
 kfinance/domains/earnings/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/earnings/tests/test_earnings_tools.py,sha256=qGhdWI1s4uEjF6XtFC0f1nlAths1H6xfym-iJyBpwBo,6998
 kfinance/domains/line_items/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/domains/line_items/line_item_models.py,sha256=6J_9cko9nZ3OAGSC7OMGEMQW8dkXjRLWn4_2BjtHemU,50969
-kfinance/domains/line_items/line_item_tools.py,sha256=UTLY-_QD6LbHGXHwx1azoqzqbJGdct3R0iwNmvxhIS0,6144
+kfinance/domains/line_items/line_item_models.py,sha256=bjSfXy0dxpUXr5MGU4FchSR2kz8J5TwyPHcW-TCDxb4,45537
+kfinance/domains/line_items/line_item_tools.py,sha256=bP1lbWVGg32XG6i8uhg8xtc9ttlRpoSDDI5NPxm6g90,5347
 kfinance/domains/line_items/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/line_items/tests/test_line_item_tools.py,sha256=vgxJsPbQG1msXZKTfpyHSzUfhw0GvfxZ041T7J-56hU,5499
 kfinance/domains/mergers_and_acquisitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -71,7 +71,7 @@ kfinance/domains/mergers_and_acquisitions/merger_and_acquisition_tools.py,sha256
 kfinance/domains/mergers_and_acquisitions/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/mergers_and_acquisitions/tests/test_merger_and_acquisition_tools.py,sha256=uN9LewN_k4yy5IPR0lbeyYxi8UF2mmebOF3gvXCSt6M,6383
 kfinance/domains/prices/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/domains/prices/price_models.py,sha256=6K2Yi8PQKJ92rf6ulcOSh9rBVOiPcUQD_WIRjpIRuSo,2156
+kfinance/domains/prices/price_models.py,sha256=OMGrrT-jQ_4HXuouWih9g5bFnIj_ecw6waK3t0YQ9o0,2292
 kfinance/domains/prices/price_tools.py,sha256=gR83pFB0MymiyKczV8WBz6YHSbKJE5yd1_2Y2winJd8,7128
 kfinance/domains/prices/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/prices/tests/test_price_models.py,sha256=PWGqbR9aCys2ldHZMF5anMXsSYEVOjgygfpxLcLVKL8,2400
@@ -108,7 +108,7 @@ kfinance/integrations/tool_calling/static_tools/tests/test_get_n_quarters_ago.py
 kfinance/integrations/tool_calling/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/integrations/tool_calling/tests/test_tool_calling_models.py,sha256=5L8TpSVJmrjNzGcnERorpfeyrgLND_DL46ld5hVlcNw,2933
 kfinance/models/permission_models.py,sha256=G0so8ZOsD1YDsCM4he0z5R9M_shUbSRwD3hUDJdqZl0,635
-kensho_kfinance-3.2.11.dist-info/METADATA,sha256=qj83T76FViI-obgUPGcYwDmLy6mrpB4ZbWpmPcz1Z3M,6198
-kensho_kfinance-3.2.11.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-3.2.11.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-3.2.11.dist-info/RECORD,,
+kensho_kfinance-3.2.13.dist-info/METADATA,sha256=R6Z87HGlxlKkOoC16rP8MOVxp_G8GJ5ncFK5DWBfdQA,6198
+kensho_kfinance-3.2.13.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-3.2.13.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-3.2.13.dist-info/RECORD,,

kfinance/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+# 3.2.13
+- Fix Prices validator to handle null OHLC price data
+
+# 3.2.12
+- Remove multiples line item support
+
 # 3.2.11
 - Add Handling of status code 400 for Capitalizations, Modify EV/TEV ratio to target quarterly or LTM
 

kfinance/domains/capitalizations/capitalization_models.py

@@ -2,7 +2,7 @@ from copy import deepcopy
 from datetime import date
 from typing import Any
 
-from pydantic import BaseModel, Field, model_validator
+from pydantic import BaseModel, ConfigDict, Field, model_validator
 from strenum import StrEnum
 
 from kfinance.client.models.decimal_with_unit import Money, Shares
@@ -28,18 +28,9 @@ class DailyCapitalization(BaseModel):
 class Capitalizations(BaseModel):
     """Capitalizations represents market cap, TEV, and shares outstanding for a date range"""
 
+    model_config = ConfigDict(validate_by_name=True)
     capitalizations: list[DailyCapitalization] = Field(validation_alias="market_caps")
 
-    @model_validator(mode="before")
-    @classmethod
-    def handle_field_alias(cls, data: Any) -> Any:
-        """Handle both 'capitalizations' and 'market_caps' field names"""
-        if isinstance(data, dict):
-            if "capitalizations" in data and "market_caps" not in data:
-                data = deepcopy(data)
-                data["market_caps"] = data["capitalizations"]
-        return data
-
     @model_validator(mode="before")
     @classmethod
     def inject_currency_into_data(cls, data: Any) -> Any:

kfinance/domains/line_items/line_item_models.py

@@ -1599,127 +1599,6 @@ LINE_ITEMS: list[LineItemType] = [
         "dataitemid": 4034,
         "spgi_name": "Total Debt/Equity",
     },
-    {
-        "name": "last_close_tev_to_ebit",
-        "aliases": {
-            "ev_to_ebit",
-            "enterprise_value_to_ebit",
-            "enterprise_value_to_earnings_before_interest_and_taxes",
-            "tev_to_ebit",
-            "total_ev_to_ebit",
-            "total_enterprise_value_to_ebit",
-            "total_enterprise_value_to_earnings_before_interest_and_taxes",
-            "last_tev_to_ebit",
-            "last_total_ev_to_ebit",
-            "last_enterprise_value_to_ebit",
-            "last_enterprise_value_to_earnings_before_interest_and_taxes",
-            "last_total_enterprise_value_to_ebit",
-            "last_total_enterprise_value_to_earnings_before_interest_and_taxes",
-            "last_close_ev_to_ebit",
-            "last_close_enterprise_value_to_ebit",
-            "last_close_total_ev_to_ebit",
-            "last_close_enterprise_value_to_ebit",
-            "last_close_enterprise_value_to_earnings_before_interest_and_taxes",
-            "last_close_total_enterprise_value_to_ebit",
-            "last_close_total_enterprise_value_to_earnings_before_interest_and_taxes",
-        },
-        "dataitemid": 100062,
-        "spgi_name": "Last Close TEV / EBIT",
-    },
-    {
-        "name": "last_close_tev_to_ebitda",
-        "aliases": {
-            "ev_to_ebitda",
-            "enterprise_value_to_ebitda",
-            "enterprise_value_to_earnings_before_interest_taxes_depreciation_and_amortization",
-            "tev_to_ebitda",
-            "total_ev_to_ebitda",
-            "total_enterprise_value_to_ebitda",
-            "total_enterprise_value_to_earnings_before_interest_taxes_depreciation_and_amortization",
-            "last_tev_to_ebitda",
-            "last_total_ev_to_ebitda",
-            "last_enterprise_value_to_ebitda",
-            "last_enterprise_value_to_earnings_before_interest_taxes_depreciation_and_amortization",
-            "last_total_enterprise_value_to_ebitda",
-            "last_total_enterprise_value_to_earnings_before_interest_taxes_depreciation_and_amortization",
-            "last_close_total_ev_to_ebitda",
-            "last_close_enterprise_value_to_ebitda",
-            "last_close_enterprise_value_to_earnings_before_interest_taxes_depreciation_and_amortization",
-            "last_close_total_enterprise_value_to_ebitda",
-            "last_close_total_enterprise_value_to_earnings_before_interest_taxes_depreciation_and_amortization",
-        },
-        "dataitemid": 100063,
-        "spgi_name": "Last Close TEV / EBITDA",
-    },
-    {
-        "name": "ev_to_employees",
-        "aliases": {
-            "ev_to_employee_count",
-            "ev_to_headcount",
-            "enterprise_value_to_employees",
-            "enterprise_value_to_employee_count",
-            "enterprise_value_to_headcount",
-            "tev_to_employees",
-            "tev_to_employee_count",
-            "tev_to_headcount",
-            "total_ev_to_employees",
-            "total_ev_to_employee_count",
-            "total_ev_to_headcount",
-            "total_enterprise_value_to_employees",
-            "total_enterprise_value_to_employee_count",
-            "total_enterprise_value_to_headcount",
-            "last_ev_to_employees",
-            "last_ev_to_employee_count",
-            "last_ev_to_headcount",
-            "last_tev_to_employees",
-            "last_tev_to_employee_count",
-            "last_tev_to_headcount",
-            "last_total_ev_to_employees",
-            "last_total_ev_to_employee_count",
-            "last_total_ev_to_headcount",
-            "last_enterprise_value_to_employees",
-            "last_enterprise_value_to_employee_count",
-            "last_enterprise_value_to_headcount",
-            "last_total_enterprise_value_to_employees",
-            "last_total_enterprise_value_to_employee_count",
-            "last_total_enterprise_value_to_headcount",
-            "last_close_ev_to_employees",
-            "last_close_ev_to_employee_count",
-            "last_close_ev_to_headcount",
-            "last_close_tev_to_employees",
-            "last_close_tev_to_employee_count",
-            "last_close_tev_to_headcount",
-            "last_close_total_ev_to_employees",
-            "last_close_total_ev_to_employee_count",
-            "last_close_total_ev_to_headcount",
-            "last_close_enterprise_value_to_employees",
-            "last_close_enterprise_value_to_employee_count",
-            "last_close_enterprise_value_to_headcount",
-            "last_close_total_enterprise_value_to_employees",
-            "last_close_total_enterprise_value_to_employee_count",
-            "last_close_total_enterprise_value_to_headcount",
-        },
-        "dataitemid": 100070,
-        "spgi_name": "Last Close TEV / Employees",
-    },
-    {
-        "name": "ev_to_total_revenue",
-        "aliases": {
-            "tev_to_total_revenue",
-            "enterprise_value_to_total_revenue",
-            "total_enterprise_value_to_total_revenue",
-            "last_ev_to_total_revenue",
-            "last_tev_to_total_revenue",
-            "last_enterprise_value_to_total_revenue",
-            "last_enterprise_value_to_total_revenue",
-            "last_close_ev_to_total_revenue",
-            "last_close_tev_to_total_revenue",
-            "last_close_enterprise_value_to_total_revenue",
-            "last_close_enterprise_value_to_total_revenue",
-        },
-        "dataitemid": 100061,
-        "spgi_name": "Last Close TEV / Total Revenue",
-    },
 ]
 LINE_ITEM_NAMES_AND_ALIASES: list[str] = list(
     chain(*[[line_item["name"]] + list(line_item["aliases"]) for line_item in LINE_ITEMS])

kfinance/domains/line_items/line_item_tools.py

@@ -45,12 +45,6 @@ class GetFinancialLineItemFromIdentifiers(KfinanceTool):
         - To fetch the most recent value for the line item, leave start_year, start_quarter, end_year, and end_quarter as None.
         - The tool accepts arguments in calendar years, and all outputs will be presented in terms of calendar years. Please note that these calendar years may not align with the company's fiscal year.
         - All aliases for a line item return identical data (e.g., "revenue", "normal_revenue", and "regular_revenue" all return the same financial data).
-        - For the following Enterprise Value (EV) ratio line items, always specify period_type as either "quarterly" or "ltm" (Last Twelve Months) - do not rely on the default annual period:
-            - last_close_tev_to_ebit (and its aliases: ev_to_ebit, enterprise_value_to_ebit, tev_to_ebit, etc.)
-            - last_close_tev_to_ebitda (and its aliases: ev_to_ebitda, enterprise_value_to_ebitda, tev_to_ebitda, etc.)
-            - ev_to_employees (and its aliases: ev_to_employee_count, tev_to_employees, enterprise_value_to_employees, etc.)
-            - ev_to_total_revenue (and its aliases: tev_to_total_revenue, enterprise_value_to_total_revenue, etc.)
-        - When requesting these EV ratios, explicitly set period_type="quarterly" or period_type="ltm" for optimal data availability.
 
         Example:
         Query: "What are the revenues of Lowe's and Home Depot?"

kfinance/domains/prices/price_models.py

@@ -15,11 +15,11 @@ class Prices(BaseModel):
     """
 
     date: str
-    open: Money
-    high: Money
-    low: Money
-    close: Money
-    volume: Shares
+    open: Money | None
+    high: Money | None
+    low: Money | None
+    close: Money | None  # For Consistency with other OHLC dtype
+    volume: Shares | None
 
 
 class PriceHistory(BaseModel):
@@ -58,7 +58,8 @@ class PriceHistory(BaseModel):
             currency = data["currency"]
             for capitalization in data["prices"]:
                 for key in ["open", "high", "low", "close"]:
-                    capitalization[key] = dict(unit=currency, value=capitalization[key])
+                    if capitalization[key] is not None:
+                        capitalization[key] = dict(unit=currency, value=capitalization[key])
         return data
 
 

kfinance/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.2.11'
-__version_tuple__ = version_tuple = (3, 2, 11)
+__version__ = version = '3.2.13'
+__version_tuple__ = version_tuple = (3, 2, 13)
 
 __commit_id__ = commit_id = None