Improve metadata error messages

Author: juankx-bodo

pydough/errors/error_utils.py

@@ -89,7 +89,6 @@ def verify(self, obj: object, error_name: str) -> None:
             `PyDoughMetadataException`: if `obj` did not satisfy the predicate.
         """
         if not self.accept(obj):
-            error_name = f"{error_name}: [{repr(obj)}]"
             raise PyDoughMetadataException(self.error_message(error_name))
 
 

pydough/metadata/collections/collection_metadata.py

@@ -48,8 +48,8 @@ def __init__(
             PropertyMetadata,
         )
 
-        is_valid_name.verify(name, "name")
-        HasType(GraphMetadata).verify(graph, "graph")
+        is_valid_name.verify(name, f"name {name!r}")
+        HasType(GraphMetadata).verify(graph, f"graph {graph}")
 
         self._graph: GraphMetadata = graph
         self._name: str = name

pydough/metadata/graphs/graph_metadata.py

@@ -43,8 +43,7 @@ def __init__(
         synonyms: list[str] | None,
         extra_semantic_info: dict | None,
     ):
-        breakpoint()
-        is_valid_name.verify(name, "graph name")
+        is_valid_name.verify(name, f"graph name {name!r}")
         self._additional_definitions: list[str] | None = additional_definitions
         self._verified_pydough_analysis: list[dict] | None = verified_pydough_analysis
         self._name: str = name
@@ -117,7 +116,7 @@ def add_collection(self, collection: AbstractMetadata) -> None:
         from pydough.metadata.collections import CollectionMetadata
 
         # Make sure the collection is actually a collection
-        HasType(CollectionMetadata).verify(collection, "collection")
+        HasType(CollectionMetadata).verify(collection, f"collection {collection!r}")
         assert isinstance(collection, CollectionMetadata)
 
         # Verify sure the collection has not already been added to the graph
@@ -180,7 +179,7 @@ def add_function(self, name: str, function: "ExpressionFunctionOperator") -> Non
             `PyDoughMetadataException`: if `function` cannot be inserted
             into the graph because of a name collision.
         """
-        is_valid_name.verify(name, "function name")
+        is_valid_name.verify(name, f"function name {name!r}")
         if name == self.name:
             raise PyDoughMetadataException(
                 f"Function name {name!r} cannot be the same as the graph name {self.name!r}"

pydough/metadata/properties/property_metadata.py

@@ -45,8 +45,8 @@ def __init__(
         synonyms: list[str] | None,
         extra_semantic_info: dict | None,
     ):
-        is_valid_name.verify(name, "name")
-        HasType(CollectionMetadata).verify(collection, "collection")
+        is_valid_name.verify(name, f"name {name!r}")
+        HasType(CollectionMetadata).verify(collection, f"collection {collection!r}")
         self._name: str = name
         self._collection: CollectionMetadata = collection
         super().__init__(description, synonyms, extra_semantic_info)

tests/test_metadata/invalid_graphs.json

@@ -52,7 +52,7 @@
       "version": "V2",
       "collections": [
         {
-          "name": "0",
+          "name": "Invalid name",
           "type": "simple table",
           "table path": "TableName",
           "unique properties": ["key"],
@@ -66,7 +66,7 @@
       "version": "V2",
       "collections": [
         {
-          "name": "0",
+          "name": "table_name",
           "type": "simple table",
           "table path": "TableName",
           "unique properties": ["key"],
@@ -93,6 +93,44 @@
       ],
       "relationships": []
     },
+    {
+      "name": "BAD_COLUMN_NAME",
+      "version": "V2",
+      "collections": [
+        {
+          "name": "collection",
+          "type": "simple table",
+          "table path": "TableName",
+          "unique properties": ["key"],
+          "properties": [
+            {
+              "name": "invalid column name",
+              "type": "table column",
+              "column name": "column_name",
+              "data type": "string",
+              "description": "column description"
+            }
+          ]
+        }
+      ],
+      "relationships": []
+    },
+    {
+      "name": "BAD_TABLE_NAME",
+      "version": "V2",
+      "collections": [
+        {
+          "name": "invalid table_name",
+          "type": "simple table",
+          "table path": "TableName",
+          "unique properties": ["key"],
+          "properties": [
+            {"name": "property"}
+          ]
+        }
+      ],
+      "relationships": []
+    },
     {
       "name": "BAD_RELATIONSHIP_NAME",
       "version": "V2",

tests/test_metadata_errors.py

@@ -53,7 +53,7 @@ def test_missing_property(get_sample_graph: graph_fetcher) -> None:
         ),
         pytest.param(
             "#BadGraphName",
-            "graph name must be a string that is a Python identifier",
+            "graph name '#BadGraphName' must be a string that is a valid Python identifier",
             id="#BadGraphName",
         ),
         pytest.param(
@@ -85,22 +85,32 @@ def test_missing_property(get_sample_graph: graph_fetcher) -> None:
         ),
         pytest.param(
             "BAD_COLLECTION_NAME_1",
-            "name must be a string that is a Python identifier",
+            "name '0' must be a string that is a valid Python identifier",
             id="BAD_COLLECTION_NAME_1",
         ),
         pytest.param(
             "BAD_COLLECTION_NAME_2",
-            "name must be a string that is a Python identifier",
+            "name 'Invalid name' must be a string that is a valid Python identifier",
             id="BAD_COLLECTION_NAME_2",
         ),
         pytest.param(
             "BAD_PROPERTY_NAME_1",
-            "name must be a string that is a Python identifier",
+            "property 'bad name' of simple table collection 'table_name' in graph 'BAD_PROPERTY_NAME_1' must be a JSON object containing a field 'type' and field 'type' must be a string",
             id="BAD_PROPERTY_NAME_1",
         ),
         pytest.param(
             "BAD_PROPERTY_NAME_2",
-            "name must be a string that is a Python identifier",
+            "name '0' must be a string that is a valid Python identifier",
+            id="BAD_PROPERTY_NAME_2",
+        ),
+        pytest.param(
+            "BAD_COLUMN_NAME",
+            "name 'invalid column name' must be a string that is a valid Python identifier",
+            id="BAD_PROPERTY_NAME_2",
+        ),
+        pytest.param(
+            "BAD_TABLE_NAME",
+            "name 'invalid table_name' must be a string that is a valid Python identifier",
             id="BAD_PROPERTY_NAME_2",
         ),
         pytest.param(
@@ -463,7 +473,7 @@ def test_missing_property(get_sample_graph: graph_fetcher) -> None:
         ),
         pytest.param(
             "BAD_FUNCTION_BAD_NAME_2",
-            "function name must be a string that is a Python identifier",
+            "function name '' must be a string that is a valid Python identifier",
             id="BAD_FUNCTION_BAD_NAME_2",
         ),
         pytest.param(