kensho-kfinance 3.0.2__tar.gz → 3.0.3__tar.gz

{kensho_kfinance-3.0.2/kensho_kfinance.egg-info → kensho_kfinance-3.0.3}/PKG-INFO

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

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

@@ -1,5 +1,8 @@
 # Changelog
 
+## v3.0.3
+- Add LineItemResponse model
+
 ## v3.0.2
 - Add kfinance.mcp back to simplify transition to 3.0
 
@@ -25,7 +28,7 @@
 - Add transcript permission and update accepted_permissions type to set[Permission]
 
 ## v2.6.3
-- Bump urllib3 to 2.5 to  address CVEs
+- Bump urllib3 to 2.5 to address CVEs
 
 ## v2.6.2
  - Safely check for incomplete merger information

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/client/fetch.py

@@ -20,6 +20,7 @@ from kfinance.domains.capitalizations.capitalization_models import Capitalizatio
 from kfinance.domains.companies.company_models import IdentificationTriple
 from kfinance.domains.competitors.competitor_models import CompetitorResponse, CompetitorSource
 from kfinance.domains.earnings.earning_models import EarningsCallResp
+from kfinance.domains.line_items.line_item_models import LineItemResponse
 from kfinance.domains.prices.price_models import PriceHistory
 from kfinance.domains.segments.segment_models import SegmentType
 
@@ -410,7 +411,7 @@ class KFinanceApiClient:
         end_year: Optional[int] = None,
         start_quarter: Optional[int] = None,
         end_quarter: Optional[int] = None,
-    ) -> dict:
+    ) -> LineItemResponse:
         """Get a specified financial line item for a specified duration."""
         url = (
             f"{self.url_base}line_item/{company_id}/{line_item}/"
@@ -420,7 +421,7 @@ class KFinanceApiClient:
             f"{start_quarter if start_quarter is not None else 'none'}/"
             f"{end_quarter if end_quarter is not None else 'none'}"
         )
-        return self.fetch(url)
+        return LineItemResponse.model_validate(self.fetch(url))
 
     def fetch_info(self, company_id: int) -> dict:
         """Get the company info."""

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/client/meta_classes.py

@@ -202,18 +202,17 @@ class CompanyFunctionsMetaClass:
         except ValueError:
             return pd.DataFrame()
 
+        line_item_response = self.kfinance_api_client.fetch_line_item(
+            company_id=self.company_id,
+            line_item=line_item,
+            period_type=period_type,
+            start_year=start_year,
+            end_year=end_year,
+            start_quarter=start_quarter,
+            end_quarter=end_quarter,
+        )
         return (
-            pd.DataFrame(
-                self.kfinance_api_client.fetch_line_item(
-                    company_id=self.company_id,
-                    line_item=line_item,
-                    period_type=period_type,
-                    start_year=start_year,
-                    end_year=end_year,
-                    start_quarter=start_quarter,
-                    end_quarter=end_quarter,
-                )
-            )
+            pd.DataFrame({"line_item": line_item_response.line_item})
             .transpose()
             .apply(pd.to_numeric)
             .replace(np.nan, None)

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/client/tests/test_fetch.py

@@ -115,7 +115,9 @@ class TestFetchItem(TestCase):
         company_id = 21719
         line_item = "cash"
         expected_fetch_url = f"{self.kfinance_api_client.url_base}line_item/{company_id}/{line_item}/none/none/none/none/none"
-        self.kfinance_api_client.fetch_line_item(company_id=company_id, line_item=line_item)
+        # Validation error is ok, we only care that the function was called with the correct url
+        with pytest.raises(ValidationError):
+            self.kfinance_api_client.fetch_line_item(company_id=company_id, line_item=line_item)
         self.kfinance_api_client.fetch.assert_called_with(expected_fetch_url)
         period_type = PeriodType.quarterly
         start_year = 2024
@@ -123,15 +125,18 @@ class TestFetchItem(TestCase):
         start_quarter = 1
         end_quarter = 4
         expected_fetch_url = f"{self.kfinance_api_client.url_base}line_item/{company_id}/{line_item}/{period_type.value}/{start_year}/{end_year}/{start_quarter}/{end_quarter}"
-        self.kfinance_api_client.fetch_line_item(
-            company_id=company_id,
-            line_item=line_item,
-            period_type=period_type,
-            start_year=start_year,
-            end_year=end_year,
-            start_quarter=start_quarter,
-            end_quarter=end_quarter,
-        )
+
+        # Validation error is ok, we only care that the function was called with the correct url
+        with pytest.raises(ValidationError):
+            self.kfinance_api_client.fetch_line_item(
+                company_id=company_id,
+                line_item=line_item,
+                period_type=period_type,
+                start_year=start_year,
+                end_year=end_year,
+                start_quarter=start_quarter,
+                end_quarter=end_quarter,
+            )
         self.kfinance_api_client.fetch.assert_called_with(expected_fetch_url)
 
     def test_fetch_info(self) -> None:

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/client/tests/test_objects.py

@@ -28,6 +28,7 @@ from kfinance.domains.business_relationships.business_relationship_models import
 from kfinance.domains.capitalizations.capitalization_models import Capitalizations
 from kfinance.domains.companies.company_models import CompanyIdAndName
 from kfinance.domains.earnings.earning_models import EarningsCallResp
+from kfinance.domains.line_items.line_item_models import LineItemResponse
 
 
 msft_company_id = "21835"
@@ -106,15 +107,17 @@ MOCK_COMPANY_DB = {
             }
         },
         "line_items": {
-            "revenue": {
-                "line_item": {
-                    "2019": "125843000000.000000",
-                    "2020": "143015000000.000000",
-                    "2021": "168088000000.000000",
-                    "2022": "198270000000.000000",
-                    "2023": "211915000000.000000",
+            "revenue": LineItemResponse.model_validate(
+                {
+                    "line_item": {
+                        "2019": "125843000000.000000",
+                        "2020": "143015000000.000000",
+                        "2021": "168088000000.000000",
+                        "2022": "198270000000.000000",
+                        "2023": "211915000000.000000",
+                    }
                 }
-            }
+            )
         },
         "segments": {
             "2024": {
@@ -533,8 +536,11 @@ class TestCompany(TestCase):
 
     def test_revenue(self) -> None:
         """test revenue"""
+        line_item_response: LineItemResponse = MOCK_COMPANY_DB[msft_company_id]["line_items"][
+            "revenue"
+        ]
         expected_revenue = (
-            pd.DataFrame(MOCK_COMPANY_DB[msft_company_id]["line_items"]["revenue"])
+            pd.DataFrame({"line_item": line_item_response.line_item})
             .transpose()
             .apply(pd.to_numeric)
             .replace(np.nan, None)
@@ -862,8 +868,11 @@ class TestTicker(TestCase):
 
     def test_revenue(self) -> None:
         """test revenue"""
+        line_item_response: LineItemResponse = MOCK_COMPANY_DB[msft_company_id]["line_items"][
+            "revenue"
+        ]
         expected_revenue = (
-            pd.DataFrame(MOCK_COMPANY_DB[msft_company_id]["line_items"]["revenue"])
+            pd.DataFrame({"line_item": line_item_response.line_item})
             .transpose()
             .apply(pd.to_numeric)
             .replace(np.nan, None)

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/domains/line_items/line_item_models.py

@@ -1,6 +1,13 @@
+from decimal import Decimal
 from itertools import chain
 from typing import TypedDict
 
+from pydantic import BaseModel
+
+
+class LineItemResponse(BaseModel):
+    line_item: dict[str, Decimal]
+
 
 class LineItemType(TypedDict):
     name: str

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/domains/line_items/line_item_tools.py

@@ -9,10 +9,14 @@ from kfinance.client.batch_request_handling import Task, process_tasks_in_thread
 from kfinance.client.models.date_and_period_models import PeriodType
 from kfinance.client.permission_models import Permission
 from kfinance.domains.companies.company_identifiers import (
+    Identifier,
     fetch_company_ids_from_identifiers,
     parse_identifiers,
 )
-from kfinance.domains.line_items.line_item_models import LINE_ITEM_NAMES_AND_ALIASES
+from kfinance.domains.line_items.line_item_models import (
+    LINE_ITEM_NAMES_AND_ALIASES,
+    LineItemResponse,
+)
 from kfinance.integrations.tool_calling.tool_calling_models import (
     KfinanceTool,
     ToolArgsWithIdentifiers,
@@ -94,13 +98,17 @@ class GetFinancialLineItemFromIdentifiers(KfinanceTool):
             for identifier, company_id in identifiers_to_company_ids.items()
         ]
 
-        line_item_responses = process_tasks_in_thread_pool_executor(
-            api_client=api_client, tasks=tasks
+        line_item_responses: dict[Identifier, LineItemResponse] = (
+            process_tasks_in_thread_pool_executor(api_client=api_client, tasks=tasks)
         )
 
         output = dict()
         for identifier, result in line_item_responses.items():
-            df = pd.DataFrame(result).apply(pd.to_numeric).replace(np.nan, None)
+            df = (
+                pd.DataFrame({"line_item": result.line_item})
+                .apply(pd.to_numeric)
+                .replace(np.nan, None)
+            )
             # If no date and multiple companies, only return the most recent value.
             # By default, we return 5 years of data, which can be too much when
             # returning data for many companies.

{kensho_kfinance-3.0.2 → kensho_kfinance-3.0.3}/kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '3.0.2'
-__version_tuple__ = version_tuple = (3, 0, 2)
+__version__ = version = '3.0.3'
+__version_tuple__ = version_tuple = (3, 0, 3)