kensho-kfinance 3.2.7__tar.gz → 3.2.8__tar.gz

{kensho_kfinance-3.2.7/kensho_kfinance.egg-info → kensho_kfinance-3.2.8}/PKG-INFO

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

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

@@ -1,5 +1,8 @@
 # Changelog
 
+# v3.2.8
+- Added support for None to LineItemResponse & empty behavior for line items, segments, and statements
+
 # v3.2.7
 - Fix validator for UnifiedIdTripleResponse
 

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/line_items/line_item_models.py

@@ -6,7 +6,7 @@ from pydantic import BaseModel
 
 
 class LineItemResponse(BaseModel):
-    line_item: dict[str, Decimal]
+    line_item: dict[str, Decimal | None]
 
 
 class LineItemType(TypedDict):

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/line_items/line_item_tools.py

@@ -109,9 +109,10 @@ class GetFinancialLineItemFromIdentifiers(KfinanceTool):
             and len(line_item_responses) > 1
         ):
             for line_item_response in line_item_responses.values():
-                most_recent_year = max(line_item_response.line_item.keys())
-                most_recent_year_data = line_item_response.line_item[most_recent_year]
-                line_item_response.line_item = {most_recent_year: most_recent_year_data}
+                if line_item_response.line_item:
+                    most_recent_year = max(line_item_response.line_item.keys())
+                    most_recent_year_data = line_item_response.line_item[most_recent_year]
+                    line_item_response.line_item = {most_recent_year: most_recent_year_data}
 
         return GetFinancialLineItemFromIdentifiersResp(
             results=line_item_responses, errors=list(id_triple_resp.errors.values())

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/line_items/tests/test_line_item_tools.py

@@ -86,6 +86,38 @@ class TestGetFinancialLineItemFromCompanyIds:
         response = tool.run(args.model_dump(mode="json"))
         assert response == expected_response
 
+    def test_empty_most_recent_request(self, requests_mock: Mocker, mock_client: Client) -> None:
+        """
+        GIVEN the GetFinancialLineItemFromIdentifiers tool
+        WHEN we request most recent line items for multiple companies
+        THEN we only get back the most recent line item for each company
+        UNLESS no line items exist
+        """
+
+        company_ids = [1, 2]
+
+        c_1_line_item_resp = LineItemResponse(line_item={})
+        c_2_line_item_resp = LineItemResponse(line_item={"2024": Decimal(14208000000)})
+        expected_response = GetFinancialLineItemFromIdentifiersResp(
+            results={"C_1": c_1_line_item_resp, "C_2": c_2_line_item_resp},
+        )
+
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/line_item/1/revenue/none/none/none/none/none",
+            json={"line_item": {}},
+        )
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/line_item/2/revenue/none/none/none/none/none",
+            json=self.line_item_resp,
+        )
+        tool = GetFinancialLineItemFromIdentifiers(kfinance_client=mock_client)
+        args = GetFinancialLineItemFromIdentifiersArgs(
+            identifiers=[f"{COMPANY_ID_PREFIX}{company_id}" for company_id in company_ids],
+            line_item="revenue",
+        )
+        response = tool.run(args.model_dump(mode="json"))
+        assert response == expected_response
+
     def test_line_items_and_aliases_included_in_schema(self, mock_client: Client):
         """
         GIVEN a GetFinancialLineItemFromCompanyIds tool

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/segments/segment_tools.py

@@ -98,9 +98,10 @@ class GetSegmentsFromIdentifiers(KfinanceTool):
             and len(segments_responses) > 1
         ):
             for segments_response in segments_responses.values():
-                most_recent_year = max(segments_response.segments.keys())
-                most_recent_year_data = segments_response.segments[most_recent_year]
-                segments_response.segments = {most_recent_year: most_recent_year_data}
+                if segments_response.segments:
+                    most_recent_year = max(segments_response.segments.keys())
+                    most_recent_year_data = segments_response.segments[most_recent_year]
+                    segments_response.segments = {most_recent_year: most_recent_year_data}
 
         return GetSegmentsFromIdentifiersResp(
             results=segments_responses, errors=list(id_triple_resp.errors.values())

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/segments/tests/test_segment_tools.py

@@ -63,8 +63,8 @@ class TestGetSegmentsFromIdentifier:
     def test_most_recent_request(self, requests_mock: Mocker, mock_client: Client) -> None:
         """
         GIVEN the GetFinancialLineItemFromIdentifiers tool
-        WHEN we request most recent statement for multiple companies
-        THEN we only get back the most recent statement for each company
+        WHEN we request most recent segment for multiple companies
+        THEN we only get back the most recent segment for each company
         """
 
         company_ids = [1, 2]
@@ -90,3 +90,38 @@ class TestGetSegmentsFromIdentifier:
         )
         response = tool.run(args.model_dump(mode="json"))
         assert response == expected_response
+
+    def test_empty_most_recent_request(self, requests_mock: Mocker, mock_client: Client) -> None:
+        """
+        GIVEN the GetFinancialLineItemFromIdentifiers tool
+        WHEN we request most recent segment for multiple companies
+        THEN we only get back the most recent segment for each company
+        UNLESS no segments exist
+        """
+
+        company_ids = [1, 2]
+        expected_response = GetSegmentsFromIdentifiersResp.model_validate(
+            {
+                "results": {
+                    "C_1": {"segments": {}},
+                    "C_2": {"segments": {"2021": self.segments_response["segments"]["2021"]}},
+                }
+            }
+        )
+
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/segments/1/business/none/none/none/none/none",
+            json={"segments": {}},
+        )
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/segments/2/business/none/none/none/none/none",
+            json=self.segments_response,
+        )
+
+        tool = GetSegmentsFromIdentifiers(kfinance_client=mock_client)
+        args = GetSegmentsFromIdentifiersArgs(
+            identifiers=[f"{COMPANY_ID_PREFIX}{company_id}" for company_id in company_ids],
+            segment_type=SegmentType.business,
+        )
+        response = tool.run(args.model_dump(mode="json"))
+        assert response == expected_response

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/statements/statement_tools.py

@@ -105,9 +105,10 @@ class GetFinancialStatementFromIdentifiers(KfinanceTool):
             and len(statement_responses) > 1
         ):
             for statement_response in statement_responses.values():
-                most_recent_year = max(statement_response.statements.keys())
-                most_recent_year_data = statement_response.statements[most_recent_year]
-                statement_response.statements = {most_recent_year: most_recent_year_data}
+                if statement_response.statements:
+                    most_recent_year = max(statement_response.statements.keys())
+                    most_recent_year_data = statement_response.statements[most_recent_year]
+                    statement_response.statements = {most_recent_year: most_recent_year_data}
 
         return GetFinancialStatementFromIdentifiersResp(
             results=statement_responses, errors=list(id_triple_resp.errors.values())

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/domains/statements/tests/test_statement_tools.py

@@ -105,3 +105,45 @@ class TestGetFinancialStatementFromIdentifiers:
         )
         response = tool.run(args.model_dump(mode="json"))
         assert response == expected_response
+
+    def test_empty_most_recent_request(self, requests_mock: Mocker, mock_client: Client) -> None:
+        """
+        GIVEN the GetFinancialStatementFromIdentifiers tool
+        WHEN we request most recent statement for multiple companies
+        THEN we only get back the most recent statement for each company
+        UNLESS no statements exist
+        """
+
+        company_ids = [1, 2]
+        expected_response = GetFinancialStatementFromIdentifiersResp.model_validate(
+            {
+                "results": {
+                    "C_1": {"statements": {}},
+                    "C_2": {
+                        "statements": {
+                            "2021": {
+                                "Revenues": "8243000000.000000",
+                                "Total Revenues": "8243000000.000000",
+                            }
+                        }
+                    },
+                }
+            }
+        )
+
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/statements/1/income_statement/none/none/none/none/none",
+            json={"statements": {}},
+        )
+        requests_mock.get(
+            url=f"https://kfinance.kensho.com/api/v1/statements/2/income_statement/none/none/none/none/none",
+            json=self.statement_resp,
+        )
+
+        tool = GetFinancialStatementFromIdentifiers(kfinance_client=mock_client)
+        args = GetFinancialStatementFromIdentifiersArgs(
+            identifiers=[f"{COMPANY_ID_PREFIX}{company_id}" for company_id in company_ids],
+            statement=StatementType.income_statement,
+        )
+        response = tool.run(args.model_dump(mode="json"))
+        assert response == expected_response

{kensho_kfinance-3.2.7 → kensho_kfinance-3.2.8}/kfinance/version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '3.2.7'
-__version_tuple__ = version_tuple = (3, 2, 7)
+__version__ = version = '3.2.8'
+__version_tuple__ = version_tuple = (3, 2, 8)
 
-__commit_id__ = commit_id = 'ga53013bfe'
+__commit_id__ = commit_id = 'ge9fdf681b'