kensho-kfinance 2.2.4__py3-none-any.whl → 2.2.5__py3-none-any.whl

{kensho_kfinance-2.2.4.dist-info → kensho_kfinance-2.2.5.dist-info}/METADATA

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

@@ -1,22 +1,23 @@
-kensho_kfinance-2.2.4.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
-kensho_kfinance-2.2.4.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
-kfinance/CHANGELOG.md,sha256=rBjrg8H9eODymBNuLyOWIRrA5FAVR92WgxswFMkGI9E,1241
+kensho_kfinance-2.2.5.dist-info/licenses/AUTHORS.md,sha256=0h9ClbI0pu1oKj1M28ROUsaxrbZg-6ukQGl6X4y9noI,68
+kensho_kfinance-2.2.5.dist-info/licenses/LICENSE,sha256=bsY4blvSgq6o0FMQ3RXa2NCgco--nHCCchLXzxr6kms,83
+kfinance/CHANGELOG.md,sha256=Nlkx-7DFWd9kyeKUdm7pqHW7bFi8ZdruQxCmOo88TpY,1302
 kfinance/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/batch_request_handling.py,sha256=p6p_G4_BL06GgeKlh7P1k9CUqOMahWCLEw1NoBwbLvU,5698
 kfinance/constants.py,sha256=UuFzqL253-2tRQfma785K9tfaZGv-o821tO2tVLwc5Q,48813
-kfinance/fetch.py,sha256=fguxYy5rjLQKNkmP7gsvZUJtmt9uDNxg6LN9FRJTAVQ,22936
+kfinance/fetch.py,sha256=y4B-xPKrGNDVkicSf904q-M1hXHtNN8AuJ0Y55x_r2s,23464
 kfinance/kfinance.py,sha256=_U69k0Dcwkw1B_lzaUZy8N2-c-v93ZKoUAVVZb6wBUM,52758
-kfinance/meta_classes.py,sha256=1qYkj2L7jcBfdkye6TG2nuRhwzhAbmtxay6rSVY3DsA,19883
+kfinance/meta_classes.py,sha256=3V0nSXDDoake5o7kXnrqXuqNIiwI75KR4IYxFqSPhTE,20736
 kfinance/prompt.py,sha256=PtVB8c_FcSlVdyGgByAnIFGzuUuBaEjciCqnBJl1hSQ,25133
 kfinance/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+kfinance/pydantic_models.py,sha256=WWLjcxBvVOpW2Wzpq1zKKju4uMlIeH4nKvM2GqLsjEE,597
 kfinance/server_thread.py,sha256=jUnt1YGoYDkqqz1MbCwd44zJs1T_Z2BCgvj75bdtLgA,2574
-kfinance/version.py,sha256=Ath1yNFbHtPzluPba0J7EfQTfLH_byRzLfGjqAUl6cY,511
+kfinance/version.py,sha256=VXEVDzLsFHRu1B1J9TV6pbjt3sWduv6BDj43YpV5xIM,511
 kfinance/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 kfinance/tests/conftest.py,sha256=voB-w8P_6L3Nel3rdgylXKe5WWaS1q7nCFt1O04uqoY,948
 kfinance/tests/test_batch_requests.py,sha256=uXJF2IcRdyBm5SthwIUHMKtkGZ21MY84pg_k1JeSNOY,11430
 kfinance/tests/test_client.py,sha256=O7icZCSDhlQ9WGhzoXlpiSvbuA-mQNJHBYVsilyP_dE,2209
 kfinance/tests/test_example_notebook.py,sha256=XhDAJp3H5Y6usLAt3k4Ug4W3H6gLyh68nzmoWgOOLn4,6441
-kfinance/tests/test_fetch.py,sha256=O9qOsffQYJPSAR1X_P6CNoA0Buyq2kx4vfS0FOc2Goc,13564
+kfinance/tests/test_fetch.py,sha256=LbE8JLS4OsByfQ_GsGxYwSX5Z4Dgfr-T6bFaZo1k7Oo,16079
 kfinance/tests/test_group_objects.py,sha256=SoMEZmkG4RYdgWOAwxLHHtzIQho92KM01YbQXPUg578,1689
 kfinance/tests/test_objects.py,sha256=CSk3iN-uDt-E6gaOX4jExuYPT8Up-YNC3hafpenadcA,23614
 kfinance/tests/test_tools.py,sha256=ne4XhebhoxDHFl4kRLl10j4K-SXLrxS6jv6Ypt0Gv_E,16846
@@ -37,7 +38,7 @@ kfinance/tool_calling/get_prices_from_identifier.py,sha256=ViJkwLDvStB7grc8RuoKS
 kfinance/tool_calling/get_segments_from_identifier.py,sha256=WIqJ1wWE6Z87VBREGu42nRc6_eJqUbGKcE9elzqBQJE,1867
 kfinance/tool_calling/resolve_identifier.py,sha256=npslr6bBCu0qEDV1-8d24F5OC3nQ1KBMphuMbHVC1AU,626
 kfinance/tool_calling/shared_models.py,sha256=K-NPQyE_7Ew6Cs0zxG1xO2O47gp5uDHdHtWD7wUDZX4,2132
-kensho_kfinance-2.2.4.dist-info/METADATA,sha256=sx_SF7gbkLwRfyTRUw2WHaqkoSyqQfUoBUS5majgF7w,3436
-kensho_kfinance-2.2.4.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-kensho_kfinance-2.2.4.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
-kensho_kfinance-2.2.4.dist-info/RECORD,,
+kensho_kfinance-2.2.5.dist-info/METADATA,sha256=ilytuQ2DVw1h-i2Qo3EV-VKP6_p0OgiuF-Fzdvo5R9M,3436
+kensho_kfinance-2.2.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+kensho_kfinance-2.2.5.dist-info/top_level.txt,sha256=kT_kNwVhfQoOAecY8W7uYah5xaHMoHoAdBIvXh6DaKM,9
+kensho_kfinance-2.2.5.dist-info/RECORD,,

kfinance/CHANGELOG.md

@@ -1,5 +1,8 @@
 # Changelog
 
+## v2.2.5
+- Add parsing for relationship response with name
+
 ## v2.2.4
 - Add segments as llm tools
 

kfinance/fetch.py

@@ -6,6 +6,7 @@ from typing import Callable, Generator, Optional
 from uuid import uuid4
 
 import jwt
+from pydantic import ValidationError
 import requests
 
 from .constants import (
@@ -17,6 +18,7 @@ from .constants import (
     Permission,
     SegmentType,
 )
+from .pydantic_models import RelationshipResponse, RelationshipResponseNoName
 
 
 # version.py gets autogenerated by setuptools-scm and is not available
@@ -505,26 +507,30 @@ class KFinanceApiClient:
 
     def fetch_companies_from_business_relationship(
         self, company_id: int, relationship_type: BusinessRelationshipType
-    ) -> dict[str, list[int]]:
-        """Fetches a dictionary of current and previous company IDs associated with a given company ID based on the specified relationship type.
-
-        The returned dictionary has the following structure:
-        {
-            "current": List[int],
-            "previous": List[int]
-        }
+    ) -> RelationshipResponse | RelationshipResponseNoName:
+        """Fetches a dictionary of current and previous company IDs and names associated with a given company ID based on the specified relationship type.
 
         Example: fetch_companies_from_business_relationship(company_id=1234, relationship_type="distributor") returns a dictionary of company 1234's current and previous distributors.
 
+        As of 2024-05-28, we are changing the response on the backend from
+        RelationshipResponseNoName to RelationshipResponse. This function can handle both response
+        types.
+
         :param company_id: The ID of the company for which associated companies are being fetched.
         :type company_id: int
         :param relationship_type: The type of relationship to filter by. Valid relationship types are defined in the BusinessRelationshipType class.
         :type relationship_type: BusinessRelationshipType
         :return: A dictionary containing lists of current and previous company IDs that have the specified relationship with the given company_id.
-        :rtype: dict[str, list[int]]
+        :rtype: RelationshipResponse | RelationshipResponseNoName
         """
         url = f"{self.url_base}relationship/{company_id}/{relationship_type}"
-        return self.fetch(url)
+        result = self.fetch(url)
+        # Try to parse as the newer RelationshipResponse and fall back to
+        # RelationshipResponseNoName if that fails.
+        try:
+            return RelationshipResponse.model_validate(result)
+        except ValidationError:
+            return RelationshipResponseNoName.model_validate(result)
 
     def fetch_ticker_from_industry_code(
         self,

kfinance/meta_classes.py

@@ -9,12 +9,12 @@ import pandas as pd
 
 from .constants import LINE_ITEMS, BusinessRelationshipType, PeriodType, SegmentType
 from .fetch import KFinanceApiClient
+from .pydantic_models import RelationshipResponse
 
 
 if TYPE_CHECKING:
     from .kfinance import BusinessRelationships
 
-
 logger = logging.getLogger(__name__)
 
 
@@ -223,14 +223,32 @@ class CompanyFunctionsMetaClass:
         """
         from .kfinance import BusinessRelationships, Companies
 
-        companies = self.kfinance_api_client.fetch_companies_from_business_relationship(
-            self.company_id,
-            relationship_type,
-        )
-        return BusinessRelationships(
-            Companies(self.kfinance_api_client, companies["current"]),
-            Companies(self.kfinance_api_client, companies["previous"]),
+        relationship_resp = self.kfinance_api_client.fetch_companies_from_business_relationship(
+            company_id=self.company_id,
+            relationship_type=relationship_type,
         )
+        if isinstance(relationship_resp, RelationshipResponse):
+            return BusinessRelationships(
+                current=Companies(
+                    kfinance_api_client=self.kfinance_api_client,
+                    company_ids=[c.company_id for c in relationship_resp.current],
+                ),
+                previous=Companies(
+                    kfinance_api_client=self.kfinance_api_client,
+                    company_ids=[c.company_id for c in relationship_resp.previous],
+                ),
+            )
+        else:
+            return BusinessRelationships(
+                current=Companies(
+                    kfinance_api_client=self.kfinance_api_client,
+                    company_ids=relationship_resp.current,
+                ),
+                previous=Companies(
+                    kfinance_api_client=self.kfinance_api_client,
+                    company_ids=relationship_resp.previous,
+                ),
+            )
 
     def market_cap(
         self,

kfinance/pydantic_models.py

@@ -0,0 +1,25 @@
+from pydantic import BaseModel
+
+
+class RelationshipResponseNoName(BaseModel):
+    """A response from the relationship endpoint before adding the company name.
+
+    Each element in `current` and `previous` is a company_id.
+    """
+
+    current: list[int]
+    previous: list[int]
+
+
+class CompanyIdAndName(BaseModel):
+    """A company_id and name"""
+
+    company_id: int
+    company_name: str
+
+
+class RelationshipResponse(BaseModel):
+    """A response from the relationship endpoint that includes both company_id and name."""
+
+    current: list[CompanyIdAndName]
+    previous: list[CompanyIdAndName]

kfinance/tests/test_fetch.py

@@ -2,9 +2,17 @@ from unittest import TestCase
 from unittest.mock import MagicMock
 
 import pytest
+from requests_mock import Mocker
 
-from kfinance.constants import Periodicity, PeriodType
+from kfinance.constants import BusinessRelationshipType, Periodicity, PeriodType
 from kfinance.fetch import KFinanceApiClient
+from kfinance.kfinance import Client
+from kfinance.pydantic_models import (
+    CompanyIdAndName,
+    RelationshipResponse,
+    RelationshipResponseNoName,
+)
+from kfinance.tests.conftest import SPGI_COMPANY_ID
 
 
 def build_mock_api_client() -> KFinanceApiClient:
@@ -279,3 +287,56 @@ class TestMarketCap:
         expected_fetch_url = f"{client.url_base}users/permissions"
         client.fetch_permissions()
         client.fetch.assert_called_with(expected_fetch_url)
+
+
+class TestFetchCompaniesFromBusinessRelationship:
+    def test_old_response_format(self, requests_mock: Mocker, mock_client: Client) -> None:
+        """
+        GIVEN a business relationship request
+        WHEN the api returns a response in the old (no name) format
+        THEN the response can successfully be parsed.
+        """
+        http_resp = {"current": [883103], "previous": [472898, 8182358]}
+        expected_result = RelationshipResponseNoName(current=[883103], previous=[472898, 8182358])
+        requests_mock.get(
+            url=f"{mock_client.kfinance_api_client.url_base}relationship/{SPGI_COMPANY_ID}/{BusinessRelationshipType.supplier}",
+            json=http_resp,
+        )
+
+        resp = mock_client.kfinance_api_client.fetch_companies_from_business_relationship(
+            company_id=SPGI_COMPANY_ID, relationship_type=BusinessRelationshipType.supplier
+        )
+        assert resp == expected_result
+
+    def test_new_response_format(self, requests_mock: Mocker, mock_client: Client) -> None:
+        """
+        GIVEN a business relationship request
+        WHEN the api returns a response in the new (with name) format
+        THEN the response can successfully be parsed.
+        """
+
+        http_resp = {
+            "current": [{"company_name": "foo", "company_id": 883103}],
+            "previous": [
+                {"company_name": "bar", "company_id": 472898},
+                {"company_name": "baz", "company_id": 8182358},
+            ],
+        }
+
+        expected_result = RelationshipResponse(
+            current=[CompanyIdAndName(company_name="foo", company_id=883103)],
+            previous=[
+                CompanyIdAndName(company_name="bar", company_id=472898),
+                CompanyIdAndName(company_name="baz", company_id=8182358),
+            ],
+        )
+
+        requests_mock.get(
+            url=f"{mock_client.kfinance_api_client.url_base}relationship/{SPGI_COMPANY_ID}/{BusinessRelationshipType.supplier}",
+            json=http_resp,
+        )
+
+        resp = mock_client.kfinance_api_client.fetch_companies_from_business_relationship(
+            company_id=SPGI_COMPANY_ID, relationship_type=BusinessRelationshipType.supplier
+        )
+        assert resp == expected_result

kfinance/version.py

@@ -17,5 +17,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.2.4'
-__version_tuple__ = version_tuple = (2, 2, 4)
+__version__ = version = '2.2.5'
+__version_tuple__ = version_tuple = (2, 2, 5)