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

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

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

@@ -1,14 +1,14 @@
-kensho_kfinance-3.2.10.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-3.2.10.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=3mgDixfg0ojmEr3D36QnfaFd8YZD5zeHkjA3NHBRm08,3388
+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
 kfinance/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-kfinance/conftest.py,sha256=FIZNQyfFbldyVmzaLfWbnMGh6RiC4MZwOVax6815_Ms,3754
+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=0Do_CqGpGkuLSWuqbzGC46drHfwvUEjSDoKQNrc0rss,706
+kfinance/version.py,sha256=MJhMUFQz6_dDcgDJMKAskHXLUlIHM1XXIUEwKPqT7dA,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=opwJJAU2JtqH-s4vt8wRqhH34MiU4tQP6Ng7K6b3upA,6561
+kfinance/client/batch_request_handling.py,sha256=0r9x3-vXdpyKhfsIa6VZ9hovN60t3HB7nE3v5hnrSyI,6617
 kfinance/client/fetch.py,sha256=CDZA8VMsu-olwmribThQ7MMOy2cgwWqQOYZ7xH3G9jI,29362
 kfinance/client/industry_models.py,sha256=ydB_cTIsNsfCUeaO7K2qqLUuHdG6WfUCoAzBigKVV8M,243
 kfinance/client/kfinance.py,sha256=-tyw9-pcP9gag20OTaOO8HpwQRae3iOuFqQ3PqzWagQ,72290
@@ -22,7 +22,7 @@ kfinance/client/models/decimal_with_unit.py,sha256=lfBvOQDk1cdWnqRh7oZoXe3_TbjNs
 kfinance/client/models/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/client/models/tests/test_decimal_with_unit.py,sha256=7WlmVXFOFNHFqwsvXQvcgyPfa6noRm3-mLTcXz4GvRs,2202
 kfinance/client/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/client/tests/test_batch_requests.py,sha256=KcE5rNJHBP27xaZOmwg8cVyUMZAAPt6jDiCeq94wUUk,11661
+kfinance/client/tests/test_batch_requests.py,sha256=_V7GS7qbj_sRW49USgfp68TlYToUweruQWtQ8QwaEcg,11740
 kfinance/client/tests/test_client.py,sha256=GlK89ZOGL9bwrAUFUk8nua2ooKt0JYm7o_rpAfajFXA,4312
 kfinance/client/tests/test_fetch.py,sha256=QbrvHSpB4DVpx5qAo175Mhr31U0I8riAqT8fS3GGyTA,21715
 kfinance/client/tests/test_group_objects.py,sha256=wb7MEyGm-Qya3CXWM5Xz3kUhKFWdHT8FF3cQcjt1WxQ,1696
@@ -35,11 +35,11 @@ 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=SsNsL4NoK4csyOja0Bw1Nw-JcpqaMw1UDeM4sKxVQ7Y,3382
-kfinance/domains/capitalizations/capitalization_tools.py,sha256=FJBxotSX-1a7GEKSEkSIuXXIgNyjSnac336rQBePU80,4753
+kfinance/domains/capitalizations/capitalization_models.py,sha256=vTmISvJuagwr8n4yF66M9pty_iIdYKb6okoc2vAyac4,3788
+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
-kfinance/domains/capitalizations/tests/test_capitalization_tools.py,sha256=H43mlYDq6GCQOw3tm6pFmvZKuJ-WctaqVTRJyYizvY8,4588
+kfinance/domains/capitalizations/tests/test_capitalization_tools.py,sha256=tetZXL6YqC9g5KKcEf0O88FiBei4Bz3UFflleWsMZnk,5384
 kfinance/domains/companies/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/companies/company_identifiers.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/companies/company_models.py,sha256=Ny0o5lB5e1gN3bSj8bVbfqg6ktgJrwn9-58sKO1bmXs,5060
@@ -62,7 +62,7 @@ kfinance/domains/earnings/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 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=lxvhYbnZKapIf2nIfdtVqXiDswJoeU5XxMOAGUeb8cI,5192
+kfinance/domains/line_items/line_item_tools.py,sha256=UTLY-_QD6LbHGXHwx1azoqzqbJGdct3R0iwNmvxhIS0,6144
 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
@@ -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.10.dist-info/METADATA,sha256=u2l7KD1wRwk071OyjYEXqr3N6ZgcvZNRPZQG0OjAqkg,6198
-kensho_kfinance-3.2.10.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-3.2.10.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-3.2.10.dist-info/RECORD,,
+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,,

kfinance/CHANGELOG.md

@@ -1,4 +1,7 @@
 # Changelog
+# 3.2.11
+- Add Handling of status code 400 for Capitalizations, Modify EV/TEV ratio to target quarterly or LTM
+
 # 3.2.10
 - Add CIQ company_id to GetInfoFromIdentifiersResp
 

kfinance/client/batch_request_handling.py

@@ -158,7 +158,9 @@ def resolve_future_with_error_handling(future: Future) -> Any:
         return future.result()
     except HTTPError as http_err:
         error_code = http_err.response.status_code
-        if error_code == 404:
+        if error_code == 400:
+            return None
+        elif error_code == 404:
             return None
         else:
             raise http_err

kfinance/client/tests/test_batch_requests.py

@@ -212,11 +212,12 @@ class TestTradingItem(TestCase):
         )
         m.get("https://kfinance.kensho.com/api/v1/info/1002", status_code=400)
 
-        with self.assertRaises(requests.exceptions.HTTPError) as e:
-            companies = Companies(self.kfinance_api_client, [1001, 1002])
-            _ = companies.city
+        companies = Companies(self.kfinance_api_client, [1001, 1002])
+        result = companies.city
+        id_based_result = self.company_object_keys_as_company_id(result)
 
-        self.assertEqual(e.exception.response.status_code, 400)
+        expected_id_based_result = {1001: "Mock City A", 1002: None}
+        self.assertDictEqual(id_based_result, expected_id_based_result)
 
     @requests_mock.Mocker()
     def test_batch_request_500(self, m):

kfinance/conftest.py

@@ -64,6 +64,16 @@ def mock_client(requests_mock: Mocker) -> Client:
             }
         },
     )
+    # Fetch a fake company
+    requests_mock.post(
+        url="https://kfinance.kensho.com/api/v1/ids",
+        additional_matcher=lambda req: req.json().get("identifiers") == ["C_1"],
+        json={
+            "data": {
+                "C_1": {"company_id": 1, "security_id": 1, "trading_item_id": 1},
+            },
+        },
+    )
     # Fetch SPGI and a non-existent company (which will include an error)
     requests_mock.post(
         url="https://kfinance.kensho.com/api/v1/ids",

kfinance/domains/capitalizations/capitalization_models.py

@@ -30,6 +30,16 @@ class Capitalizations(BaseModel):
 
     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/capitalizations/capitalization_tools.py

@@ -84,7 +84,11 @@ class GetCapitalizationFromIdentifiers(KfinanceTool):
             api_client=api_client, tasks=tasks
         )
 
-        for capitalization_response in capitalization_responses.values():
+        for identifier, capitalization_response in capitalization_responses.items():
+            # If we get an empty response for a company, assign an empty object
+            if not capitalization_response:
+                capitalization_responses[identifier] = Capitalizations(capitalizations=list())
+                capitalization_response = capitalization_responses[identifier]
             # If we return results for more than one company and the start and end dates are unset,
             # truncate data to only return the most recent datapoint.
             if len(capitalization_responses) > 1 and start_date is None and end_date is None:
@@ -93,13 +97,14 @@ class GetCapitalizationFromIdentifiers(KfinanceTool):
                 ]
             # Set capitalizations that were not requested to None.
             # That way, they can be skipped for serialization via `exclude_none=True`
-            for daily_capitalization in capitalization_response.capitalizations:
-                if capitalization is not Capitalization.market_cap:
-                    daily_capitalization.market_cap = None
-                if capitalization is not Capitalization.tev:
-                    daily_capitalization.tev = None
-                if capitalization is not Capitalization.shares_outstanding:
-                    daily_capitalization.shares_outstanding = None
+            if capitalization_response.capitalizations:
+                for daily_capitalization in capitalization_response.capitalizations:
+                    if capitalization is not Capitalization.market_cap:
+                        daily_capitalization.market_cap = None
+                    if capitalization is not Capitalization.tev:
+                        daily_capitalization.tev = None
+                    if capitalization is not Capitalization.shares_outstanding:
+                        daily_capitalization.shares_outstanding = None
 
         return GetCapitalizationFromIdentifiersResp(
             capitalization=capitalization,

kfinance/domains/capitalizations/tests/test_capitalization_tools.py

@@ -67,7 +67,7 @@ class TestGetCapitalizationFromCompanyIds:
                             shares_outstanding=None,
                         ),
                     ]
-                )
+                ),
             },
             errors=[
                 "No identification triple found for the provided identifier: NON-EXISTENT of type: ticker"
@@ -81,6 +81,26 @@ class TestGetCapitalizationFromCompanyIds:
         response = tool.run(args.model_dump(mode="json"))
         assert response == expected_response
 
+    def test_get_capitalization_from_identifiers_property_400(
+        self, requests_mock: Mocker, mock_client: Client
+    ) -> None:
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/market_cap/1/none/none",
+            status_code=400,
+        )
+
+        expected_response = GetCapitalizationFromIdentifiersResp(
+            capitalization=Capitalization.market_cap,
+            results={"C_1": Capitalizations(market_caps=list())},
+        )
+
+        tool = GetCapitalizationFromIdentifiers(kfinance_client=mock_client)
+        args = GetCapitalizationFromIdentifiersArgs(
+            identifiers=["C_1"], capitalization=Capitalization.market_cap
+        )
+        response = tool.run(args.model_dump(mode="json"))
+        assert response == expected_response
+
     def test_most_recent_request(self, requests_mock: Mocker, mock_client: Client) -> None:
         """
         GIVEN the GetCapitalizationFromIdentifiers tool

kfinance/domains/line_items/line_item_tools.py

@@ -44,6 +44,13 @@ class GetFinancialLineItemFromIdentifiers(KfinanceTool):
         - When possible, pass multiple identifiers in a single call rather than making multiple calls.
         - 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/version.py

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