kensho-kfinance 3.2.9__tar.gz → 3.2.11__tar.gz

{kensho_kfinance-3.2.9/kensho_kfinance.egg-info → kensho_kfinance-3.2.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 3.2.9
+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.9 → kensho_kfinance-3.2.11/kensho_kfinance.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: kensho-kfinance
-Version: 3.2.9
+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.9 → kensho_kfinance-3.2.11}/kfinance/CHANGELOG.md

@@ -1,10 +1,15 @@
 # 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
 
 # v3.2.9
-- Updated tool descriptions for line items, segments, and statements to mention that all period-based inputs and outputs refer only to the calendar year.
+- Update tool descriptions for line items, segments, and statements to mention that all period-based inputs and outputs refer only to the calendar year.
 
 # v3.2.8
-- Added support for None to LineItemResponse & empty behavior for line items, segments, and statements
+- Add support for None to LineItemResponse & empty behavior for line items, segments, and statements
 
 # v3.2.7
 - Fix validator for UnifiedIdTripleResponse

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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):

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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",

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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:

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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,

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/kfinance/domains/companies/company_tools.py

@@ -5,7 +5,11 @@ from pydantic import BaseModel
 
 from kfinance.client.batch_request_handling import Task, process_tasks_in_thread_pool_executor
 from kfinance.client.permission_models import Permission
-from kfinance.domains.companies.company_models import CompanyDescriptions, CompanyOtherNames
+from kfinance.domains.companies.company_models import (
+    COMPANY_ID_PREFIX,
+    CompanyDescriptions,
+    CompanyOtherNames,
+)
 from kfinance.integrations.tool_calling.tool_calling_models import (
     KfinanceTool,
     ToolArgsWithIdentifiers,
@@ -20,7 +24,7 @@ class GetInfoFromIdentifiersResp(ToolRespWithErrors):
 class GetInfoFromIdentifiers(KfinanceTool):
     name: str = "get_info_from_identifiers"
     description: str = dedent("""
-        Get the information associated with a list of identifiers. Info includes company name, status, type, simple industry, number of employees (if available), founding date, webpage, HQ address, HQ city, HQ zip code, HQ state, HQ country, and HQ country iso code.
+        Get the information associated with a list of identifiers. Info includes company name, status, type, simple industry, number of employees (if available), founding date, webpage, HQ address, HQ city, HQ zip code, HQ state, HQ country, HQ country iso code, and CIQ company_id.
 
         - When possible, pass multiple identifiers in a single call rather than making multiple calls.
     """).strip()
@@ -44,7 +48,8 @@ class GetInfoFromIdentifiers(KfinanceTool):
                     "zip_code": "10041-0001",
                     "state": "New York",
                     "country": "United States",
-                    "iso_country": "USA"
+                    "iso_country": "USA",
+                    "company_id": "C_21719"
                 }
             },
             "errors": [['No identification triple found for the provided identifier: NON-EXISTENT of type: ticker']
@@ -65,6 +70,10 @@ class GetInfoFromIdentifiers(KfinanceTool):
         info_responses: dict[str, dict] = process_tasks_in_thread_pool_executor(
             api_client=api_client, tasks=tasks
         )
+
+        for identifier, id_triple in id_triple_resp.identifiers_to_id_triples.items():
+            info_responses[identifier]["company_id"] = f"{COMPANY_ID_PREFIX}{id_triple.company_id}"
+
         return GetInfoFromIdentifiersResp(
             results=info_responses, errors=list(id_triple_resp.errors.values())
         )

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/kfinance/domains/companies/tests/test_company_tools.py

@@ -2,6 +2,7 @@ from requests_mock import Mocker
 
 from kfinance.client.kfinance import Client
 from kfinance.conftest import SPGI_COMPANY_ID
+from kfinance.domains.companies.company_models import COMPANY_ID_PREFIX
 from kfinance.domains.companies.company_tools import (
     GetCompanyDescriptionFromIdentifiers,
     GetCompanyDescriptionFromIdentifiersResp,
@@ -23,7 +24,11 @@ class TestGetInfoFromIdentifiers:
         THEN we get back info for SPGI and an error for the non-existent company
         """
 
-        info_resp = {"name": "S&P Global Inc.", "status": "Operating"}
+        info_resp = {
+            "name": "S&P Global Inc.",
+            "status": "Operating",
+            "company_id": f"{COMPANY_ID_PREFIX}{SPGI_COMPANY_ID}",
+        }
         expected_response = GetInfoFromIdentifiersResp.model_validate(
             {
                 "results": {"SPGI": info_resp},
@@ -32,6 +37,7 @@ class TestGetInfoFromIdentifiers:
                 ],
             }
         )
+        del info_resp["company_id"]
         requests_mock.get(
             url=f"https://kfinance.kensho.com/api/v1/info/{SPGI_COMPANY_ID}",
             json=info_resp,

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/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?"

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/kfinance/integrations/tool_calling/tests/test_tool_calling_models.py

@@ -7,6 +7,7 @@ from requests_mock import Mocker
 
 from kfinance.client.kfinance import Client
 from kfinance.conftest import SPGI_COMPANY_ID
+from kfinance.domains.companies.company_models import COMPANY_ID_PREFIX
 from kfinance.domains.companies.company_tools import (
     GetInfoFromIdentifiers,
     GetInfoFromIdentifiersResp,
@@ -25,7 +26,11 @@ class TestGetEndpointsFromToolCallsWithGrounding:
         """
 
         # truncated from the original
-        resp_data = {"name": "S&P Global Inc.", "status": "Operating"}
+        resp_data = {
+            "name": "S&P Global Inc.",
+            "status": "Operating",
+            "company_id": f"{COMPANY_ID_PREFIX}{SPGI_COMPANY_ID}",
+        }
         resp_endpoint = [
             "https://kfinance.kensho.com/api/v1/ids",
             "https://kfinance.kensho.com/api/v1/info/21719",
@@ -34,7 +39,7 @@ class TestGetEndpointsFromToolCallsWithGrounding:
             "data": GetInfoFromIdentifiersResp.model_validate({"results": {"SPGI": resp_data}}),
             "endpoint_urls": resp_endpoint,
         }
-
+        del resp_data["company_id"]
         requests_mock.get(
             url=f"https://kfinance.kensho.com/api/v1/info/{SPGI_COMPANY_ID}",
             json=resp_data,

{kensho_kfinance-3.2.9 → kensho_kfinance-3.2.11}/kfinance/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.2.9'
-__version_tuple__ = version_tuple = (3, 2, 9)
+__version__ = version = '3.2.11'
+__version_tuple__ = version_tuple = (3, 2, 11)
 
-__commit_id__ = commit_id = 'g1b5b8b25a'
+__commit_id__ = commit_id = 'gadcf2fd95'