Allow table_guid to be None when searching for and deleting list items (#417)

Co-authored-by: pyansys-ci-bot <[email protected]>

Author: Andy-Grigg

doc/changelog.d/417.added.md

@@ -0,0 +1 @@
+Allow table_guid to be None when searching for and deleting list items

src/ansys/grantami/recordlists/_connection.py

@@ -1142,6 +1142,9 @@ def _is_item_resolvable_in_db(self, item: RecordListItem, db_key: str) -> bool:
         """
         try:
             if item.record_version is not None and item.record_guid is not None:
+                assert (
+                    item.table_guid
+                ), "RecordListItem.table_guid must be populated to check record version resolvability"
                 self._record_versions_api.get_record_version(
                     database_key=db_key,
                     table_guid=item.table_guid,

src/ansys/grantami/recordlists/_models.py

@@ -223,8 +223,8 @@ class RecordListItem:
     ----------
     database_guid : str
        GUID of the database.
-    table_guid : str
-       GUID of the table.
+    table_guid : str or None
+       GUID of the table. Must be provided if this object is added to a RecordList. Optional otherwise.
     record_history_guid : str
        Record History GUID.
     record_version : int, optional
@@ -236,12 +236,12 @@ class RecordListItem:
     def __init__(
         self,
         database_guid: str,
-        table_guid: str,
+        table_guid: str | None,
         record_history_guid: str,
         record_version: Optional[int] = None,
     ):
         self._database_guid: str = database_guid
-        self._table_guid: str = table_guid
+        self._table_guid: str | None = table_guid
         self._record_history_guid: str = record_history_guid
         self._record_version: Optional[int] = record_version
         self._record_guid: Optional[str] = None
@@ -252,7 +252,7 @@ def database_guid(self) -> str:
         return self._database_guid
 
     @property
-    def table_guid(self) -> str:
+    def table_guid(self) -> str | None:
         """Table GUID."""
         return self._table_guid
 
@@ -306,6 +306,10 @@ def _from_model(cls, model: models.GsaListItem) -> "RecordListItem":
     def _to_create_list_item_model(self) -> models.GsaCreateListItem:
         """Generate the Create List Item DTO for use with the auto-generated client code."""
         logger.debug("Serializing RecordListItem to GsaCreateListItem API model")
+        if self.table_guid is None:
+            raise ValueError(
+                "table_guid must be provided for a RecordListItem which is added to a RecordList."
+            )
         model = models.GsaCreateListItem(
             database_guid=self.database_guid,
             table_guid=self.table_guid,

tests/integration/conftest.py

@@ -254,6 +254,18 @@ def resolvable_items(admin_client, training_database_guid) -> List[RecordListIte
     ]
 
 
+@pytest.fixture(scope="session")
+def resolvable_items_without_table_guids(resolvable_items) -> List[RecordListItem]:
+    return [
+        RecordListItem(
+            database_guid=item.database_guid,
+            table_guid=None,
+            record_history_guid=item.record_history_guid,
+        )
+        for item in resolvable_items
+    ]
+
+
 @pytest.fixture(scope="session")
 def rs_database_guid(admin_client) -> str:
     schema_api = SchemaDatabasesApi(admin_client)

tests/integration/test_integration.py

@@ -121,7 +121,10 @@ def test_get_list_items_many_unresolvable_items(
         assert all(isinstance(item, RecordListItem) for item in record_list_items)
         assert len(record_list_items) == len(many_unresolvable_items)
 
-    def test_items_management(self, admin_client, new_list, unresolvable_item):
+    @pytest.mark.parametrize("include_table_guid_for_deletion", [True, False])
+    def test_items_management(
+        self, admin_client, new_list, unresolvable_item, include_table_guid_for_deletion
+    ):
         another_item = RecordListItem(
             unresolvable_item.database_guid,
             unresolvable_item.table_guid,
@@ -136,6 +139,12 @@ def test_items_management(self, admin_client, new_list, unresolvable_item):
         items = admin_client.remove_items_from_list(new_list, items=[unresolvable_item])
         assert items == [another_item]
 
+        if include_table_guid_for_deletion is False:
+            another_item = RecordListItem(
+                database_guid=another_item.database_guid,
+                table_guid=None,
+                record_history_guid=another_item.record_history_guid,
+            )
         items = admin_client.remove_items_from_list(new_list, items=[another_item])
         assert items == []
 
@@ -1094,17 +1103,22 @@ def test_two_tables_two_hits(
             )
 
 
+@pytest.mark.parametrize(
+    "resolvable_item_fixture_name", ["resolvable_items", "resolvable_items_without_table_guids"]
+)
 @pytest.mark.parametrize("include_items", [True, False])
 class TestSearchByRecord(_TestSearch):
     def test_single_record_two_hits(
         self,
         include_items,
         admin_client,
         list_name,
-        resolvable_items,
+        resolvable_item_fixture_name,
+        request,
         resolvable_rs_items,
         list_mi_training_items,
     ):
+        resolvable_items = request.getfixturevalue(resolvable_item_fixture_name)
         record_reference = resolvable_items[0]
         criteria = SearchCriterion(
             name_contains=list_name,
@@ -1129,10 +1143,12 @@ def test_two_records_same_database_two_hits(
         include_items,
         admin_client,
         list_name,
-        resolvable_items,
+        resolvable_item_fixture_name,
+        request,
         resolvable_rs_items,
         list_mi_training_items,
     ):
+        resolvable_items = request.getfixturevalue(resolvable_item_fixture_name)
         record_reference_1 = resolvable_items[0]
         record_reference_2 = resolvable_items[1]
 
@@ -1160,10 +1176,12 @@ def test_two_records_different_databases_three_hits(
         include_items,
         admin_client,
         list_name,
-        resolvable_items,
+        resolvable_item_fixture_name,
+        request,
         resolvable_rs_items,
         list_mi_training_items,
     ):
+        resolvable_items = request.getfixturevalue(resolvable_item_fixture_name)
         training_record_reference = resolvable_items[0]
         rs_record_reference = resolvable_rs_items[0]
         criteria = SearchCriterion(
@@ -1191,10 +1209,12 @@ def test_two_records_different_databases_three_hits_2025_r1(
         include_items,
         admin_client,
         list_name,
-        resolvable_items,
+        resolvable_item_fixture_name,
+        request,
         resolvable_rs_items,
         list_mi_training_items,
     ):
+        resolvable_items = request.getfixturevalue(resolvable_item_fixture_name)
         training_record_reference = resolvable_items[0]
         rs_record_reference = resolvable_rs_items[0]
         criteria = BooleanCriterion(

tests/test_client.py

@@ -191,6 +191,11 @@ def test_add_items(self, client, api_method, mock_list):
         api_method.assert_called_once_with(list_identifier=mock_list.identifier, body=expected_body)
         assert response == [self._existing_item, new_item]
 
+    def test_add_item_without_table_guids_raises_value_error(self, client, api_method, mock_list):
+        new_item = RecordListItem("a", None, "c")
+        with pytest.raises(ValueError, match="table_guid must be provided"):
+            client.add_items_to_list(mock_list, [new_item])
+
 
 class TestRemoveItems(TestClientMethod):
     _api = ListItemApi

tests/test_models.py

@@ -264,7 +264,7 @@ class TestItemEquality:
     RHG1 = str(uuid.uuid4())
     RV1 = 1
 
-    # Voluntary inconsistent naming scheme to highlight differences in test matrix
+    # Intentionally inconsistent naming scheme to highlight differences in test matrix
     db_guid_2 = str(uuid.uuid4())
     table_guid_2 = str(uuid.uuid4())
     record_hguid_2 = str(uuid.uuid4())