Fix bug in getting entity names (#252)

Fixes this error in fetch_entity_names:
https://screenshot.googleplex.com/Bm9BzSUnNYB87N9

There was a recent change that removes auto-flattening when unpacking
arcs (#244), but
fetch_entity_names was still assuming that values would be flattened.

Also updated the tests to use mock responses that are formatted the way
the response would actually come back as.

Author: chejennifer

datacommons_client/endpoints/node.py

@@ -235,12 +235,15 @@ def fetch_entity_names(
 
     # Iterate through the fetched data and populate the names dictionary.
     for dcid, properties in data.items():
+      if not properties:
+        continue
       if language == "en":
-        name = extract_name_from_english_name_property(properties=properties)
+        name = extract_name_from_english_name_property(
+            properties=properties.get(name_property, []))
         lang_used = "en"
       else:
         name, lang_used = extract_name_from_property_with_language(
-            properties=properties,
+            properties=properties.get(name_property, []),
             language=language,
             fallback_language=fallback_language,
         )

datacommons_client/tests/endpoints/test_node_endpoint.py

@@ -4,8 +4,10 @@
 from datacommons_client.endpoints.base import API
 from datacommons_client.endpoints.node import NodeEndpoint
 from datacommons_client.endpoints.response import NodeResponse
+from datacommons_client.models.node import Arcs
 from datacommons_client.models.node import Name
 from datacommons_client.models.node import Node
+from datacommons_client.models.node import NodeGroup
 from datacommons_client.utils.names import DEFAULT_NAME_PROPERTY
 from datacommons_client.utils.names import NAME_WITH_LANGUAGE_PROPERTY
 
@@ -212,13 +214,11 @@ def test_fetch_entity_names_english(mock_extract_name):
   # Mock the response from fetch_property_values
   endpoint.fetch_property_values = MagicMock(return_value=NodeResponse(
       data={
-          "dc/123": {
-              "properties": {
-                  DEFAULT_NAME_PROPERTY: [{
-                      "value": "Guatemala"
-                  }]
-              }
-          }
+          'dc/123':
+              Arcs(arcs={
+                  DEFAULT_NAME_PROPERTY:
+                      NodeGroup(nodes=[Node(value='Guatemala')])
+              })
       }))
 
   result = endpoint.fetch_entity_names("dc/123")
@@ -233,7 +233,8 @@ def test_fetch_entity_names_english(mock_extract_name):
           )
   }
 
-  mock_extract_name.assert_called_once()
+  mock_extract_name.assert_called_once_with(
+      properties=[Node(value="Guatemala")])
 
 
 @patch(
@@ -247,14 +248,12 @@ def test_fetch_entity_names_non_english(mock_extract_name):
 
   endpoint.fetch_property_values = MagicMock(return_value=NodeResponse(
       data={
-          "dc/123": {
-              "properties": {
-                  NAME_WITH_LANGUAGE_PROPERTY: [{
-                      "value": "Californie",
-                      "lang": "fr"
-                  }]
-              }
-          }
+          'dc/123':
+              Arcs(
+                  arcs={
+                      NAME_WITH_LANGUAGE_PROPERTY:
+                          NodeGroup(nodes=[Node(value='Californie')])
+                  })
       }))
 
   result = endpoint.fetch_entity_names("dc/123", language="fr")
@@ -269,7 +268,10 @@ def test_fetch_entity_names_non_english(mock_extract_name):
           )
   }
 
-  mock_extract_name.assert_called_once()
+  mock_extract_name.assert_called_once_with(
+      properties=[Node(value='Californie')],
+      language='fr',
+      fallback_language=None)
 
 
 @patch(
@@ -283,14 +285,12 @@ def test_fetch_entity_names_with_fallback(mock_extract_name_lang):
 
   endpoint.fetch_property_values = MagicMock(return_value=NodeResponse(
       data={
-          "dc/123": {
-              "properties": {
-                  NAME_WITH_LANGUAGE_PROPERTY: [{
-                      "value": "Chiquimula",
-                      "lang": "en"
-                  }]
-              }
-          }
+          'dc/123':
+              Arcs(
+                  arcs={
+                      NAME_WITH_LANGUAGE_PROPERTY:
+                          NodeGroup(nodes=[Node(value='Chiquimula')])
+                  })
       }))
 
   result = endpoint.fetch_entity_names("dc/123",
@@ -305,6 +305,10 @@ def test_fetch_entity_names_with_fallback(mock_extract_name_lang):
               property=NAME_WITH_LANGUAGE_PROPERTY,
           )
   }
+  mock_extract_name_lang.assert_called_once_with(
+      properties=[Node(value='Chiquimula')],
+      language='fr',
+      fallback_language='en')
 
 
 @patch(

datacommons_client/tests/test_names.py

@@ -10,6 +10,12 @@ def test_extract_name_from_english_name_property_with_list():
   assert result == "Test Name"
 
 
+def test_extract_name_from_english_empty_list():
+  """Test extracting name from an empty list."""
+  result = extract_name_from_english_name_property([])
+  assert result == ""
+
+
 def test_extract_name_from_english_not_list():
   """Test extracting name from a single Node (not in a list)."""
   property_node = Node(value="Single Node Name")

datacommons_client/utils/names.py

@@ -15,6 +15,9 @@ def extract_name_from_english_name_property(properties: list | Node) -> str:
     Returns:
         str: The extracted name.
     """
+  if not properties:
+    return ''
+
   if isinstance(properties, Node):
     properties = [properties]
 

requirements.txt

@@ -3,5 +3,5 @@ mock
 pandas
 pytest
 requests==2.32.0
-typing_extensions==3.10.0.0
+typing_extensions==4.7.1
 yapf==0.40.2