kensho-kfinance 3.0.2__py3-none-any.whl → 3.0.3__py3-none-any.whl

{kensho_kfinance-3.0.2.dist-info → kensho_kfinance-3.0.3.dist-info}/METADATA

@@ -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.dist-info → kensho_kfinance-3.0.3.dist-info}/RECORD

@@ -1,18 +1,18 @@
-kensho_kfinance-3.0.2.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-3.0.2.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=ZaMgi1WNYAQGURNXJ5jEHzSC8_cYQQTR-_KlsB1A9nA,2480
+kensho_kfinance-3.0.3.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-3.0.3.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=NF3WF3p_EkEyIRyUij-KIJY23KeEK2MMu_1Lt6_iy-s,2519
 kfinance/__init__.py,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
 kfinance/conftest.py,sha256=JyBWZuJopwN9MuisFVS_U8jd9L-UU74d-ALUTa43J1Q,1599
 kfinance/mcp.py,sha256=LTzCIlqsDKRD-0Xcpa_P99-JmJ8duAneO_-GzM43kjw,424
 kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/version.py,sha256=NpXuePaG57YwfLkFhnPEM1yLuLWOsEkvJLB1sQvObCw,511
+kfinance/version.py,sha256=O6w_VzBqFS0kxgb4zZyd_f0eDILnwM3pkHDxNPPNEoE,511
 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/fetch.py,sha256=g06-j_pOl2PeX7_E-kdeEG-xcudsDIpbRupZ6J0wbo0,27856
+kfinance/client/fetch.py,sha256=zdVqMdfD3Gvsn_MSl-emN36hY5dbwbDkVjZTzqaHRSw,27975
 kfinance/client/industry_models.py,sha256=ydB_cTIsNsfCUeaO7K2qqLUuHdG6WfUCoAzBigKVV8M,243
 kfinance/client/kfinance.py,sha256=BwywHwYvw1PEO3wvecKaRQGYdHdIkM0yxAVdTEgRjLM,72693
-kfinance/client/meta_classes.py,sha256=eJP09HQPQIp7H5DEFbuCKd1BZajFkzf6WpDbEnoXTuI,21415
+kfinance/client/meta_classes.py,sha256=fqrU6U2XL6SJubJiZX5DIpi6wxSsSQEsc2vASLQTEq4,21394
 kfinance/client/permission_models.py,sha256=G0so8ZOsD1YDsCM4he0z5R9M_shUbSRwD3hUDJdqZl0,635
 kfinance/client/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
 kfinance/client/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -24,9 +24,9 @@ kfinance/client/models/tests/test_decimal_with_unit.py,sha256=7WlmVXFOFNHFqwsvXQ
 kfinance/client/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/client/tests/test_batch_requests.py,sha256=KcE5rNJHBP27xaZOmwg8cVyUMZAAPt6jDiCeq94wUUk,11661
 kfinance/client/tests/test_client.py,sha256=GlK89ZOGL9bwrAUFUk8nua2ooKt0JYm7o_rpAfajFXA,4312
-kfinance/client/tests/test_fetch.py,sha256=S0-HlF2o1dQRHVUCw26hmefDWKnqRww3hOoo8Z34ELU,17726
+kfinance/client/tests/test_fetch.py,sha256=_32Rc79nYIwv48kWc-YLpXKF0xoAetmGcxMzR2t6Hao,18051
 kfinance/client/tests/test_group_objects.py,sha256=wb7MEyGm-Qya3CXWM5Xz3kUhKFWdHT8FF3cQcjt1WxQ,1696
-kfinance/client/tests/test_objects.py,sha256=m7wS9vr7WrY4AI0Ub9z6Ml9iOuo303ficSYlImhR_EU,42747
+kfinance/client/tests/test_objects.py,sha256=3ShSI-lgsZJxRjNOZPGMxoZ8kHnaV_M2Jnaw6gVrzDc,43142
 kfinance/domains/README.md,sha256=ehD15VwLupdXbz5M7hHUI7Y-2SCGxaP5W7Q4NuMcN64,664
 kfinance/domains/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/business_relationships/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -61,8 +61,8 @@ kfinance/domains/earnings/earning_tools.py,sha256=2W-OzGljXpVmoiLUOwLDPBCAVybvIZ
 kfinance/domains/earnings/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/earnings/tests/test_earnings_tools.py,sha256=nKoYTG2bh7-ySoYGx0EXN68GHjrq-ziW5KVyiTTQfKk,6668
 kfinance/domains/line_items/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-kfinance/domains/line_items/line_item_models.py,sha256=JIdoSYxoJDQVkmqUK6_ABpb6lULXRvrCDJGiKL6kRhE,45399
-kfinance/domains/line_items/line_item_tools.py,sha256=BJImjEsvJG2usqwDTnR6ZZ6613thFYrRPX8jDfA-1iI,4875
+kfinance/domains/line_items/line_item_models.py,sha256=09JnV2RRxl-rSmZEVlKRfEwD-5-zYmvsUAIkmz9gFqc,45530
+kfinance/domains/line_items/line_item_tools.py,sha256=f94XdsNRAev48-RPXpdy1a2OKfTaBWkjX33OQZEljVI,5051
 kfinance/domains/line_items/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/domains/line_items/tests/test_line_item_tools.py,sha256=aJxyDyW--1kyNVtjy2uGVou6NCTiVbypsFTsnvW-GVQ,3441
 kfinance/domains/mergers_and_acquisitions/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -106,7 +106,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=PWNNHaF7mFDZXXfwf4o5Hdemvr8VWl71ODHddr0FMwA,2596
 kfinance/models/permission_models.py,sha256=G0so8ZOsD1YDsCM4he0z5R9M_shUbSRwD3hUDJdqZl0,635
-kensho_kfinance-3.0.2.dist-info/METADATA,sha256=LhheCoDQ86pEZRm7b66qO2IHW34vsxtdAFCT7MfB5aU,6202
-kensho_kfinance-3.0.2.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-3.0.2.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-3.0.2.dist-info/RECORD,,
+kensho_kfinance-3.0.3.dist-info/METADATA,sha256=3GOK0VNZzeKwUmMZ7-UtNx3S6vhKPi3y1NlkYDIje94,6202
+kensho_kfinance-3.0.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-3.0.3.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-3.0.3.dist-info/RECORD,,

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

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."""

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)

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:

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)

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

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.

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)