added contains and equals check for ld_list with tests and added issue number to fixmes

Author: notactuallyfinn

src/hermes/model/types/ld_list.py

@@ -15,10 +15,10 @@ class ld_list(ld_container):
     def __init__(self, data, *, parent=None, key=None, index=None, context=None):
         """ Create a new ld_list.py container.
 
-        # FIXME: there is no parameter container
+        # FIXME: #439 there is no parameter container
         :param container: The container type for this list.
         """
-        # FIXME: A set container does not contain "@set" in the expected data format (expanded json ld)
+        # FIXME: #439 A set container does not contain "@set" in the expected data format (expanded json ld)
         # Instead it is just a list of dicts and therefor would raise a ValueError here (and fail ld_list.is_ld_list)
 
         super().__init__(data, parent=parent, key=key, index=index, context=context)
@@ -42,7 +42,7 @@ def __getitem__(self, index):
         return item
 
     def __setitem__(self, index, value):
-        # FIXME: what should your_ld_list[index] = [{"@type": "foo", "name": "bar"}] mean?
+        # FIXME: #439 what should your_ld_list[index] = [{"@type": "foo", "name": "bar"}] mean?
         # set your_ld_list[index] to the dict {"@type": "foo", "name": "bar"} given in expanded form        or
         # set your_ld_list[index] to the list [{"@type": "foo", "name": "bar"}] given in non expanded form  or
         # set your_ld_list[index] to the set [{"@type": "foo", "name": "bar"}] given in expanded form
@@ -52,7 +52,7 @@ def __setitem__(self, index, value):
         #    This is relevent because nested sets get unnested when being expanded and lists not.
         #    Moreover a set inside a list gets automaticaly converted to a list when expanded)
 
-        # FIXME: what happens when a ld_list is put inside another also depends on their container types
+        # FIXME: #439 what happens when a ld_list is put inside another also depends on their container types
 
         if not isinstance(index, slice):
             self.item_list[index] = val[0] if isinstance(val := self._to_expanded_json(self.key, value), list) else val
@@ -74,6 +74,24 @@ def __iter__(self):
                 item.index = index
             yield item
 
+    def __contains__(self, value):
+        expanded_value = val[0] if isinstance(val := self._to_expanded_json(self.key, value), list) else val
+        return expanded_value in self.item_list
+
+    def __eq__(self, other):
+        if isinstance(other, ld_list):
+            # FIXME: #439 When are ld_lists equal?
+            return self.item_list == other.item_list and self.container == other.container
+        if isinstance(other, list):
+            return self.item_list == self._to_expanded_json(self.key, other)[0]["@list"]
+        return NotImplemented
+
+    def __ne__(self, other):
+        x = self.__eq__(other)
+        if x is NotImplemented:
+            return NotImplemented
+        return not x
+
     def append(self, value):
         ld_value = self._to_expanded_json(self.key, value)
         self.item_list.extend(ld_value)
@@ -90,12 +108,12 @@ def to_python(self):
 
     @classmethod
     def is_ld_list(cls, ld_value):
-        # FIXME: every python list that contains at least one dict can be considerd a set in expanded json form
+        # FIXME: #439 every python list that contains at least one dict can be considerd a set in expanded json form
         return cls.is_ld_node(ld_value) and cls.is_container(ld_value[0])
 
     @classmethod
     def is_container(cls, value):
-        # FIXME: "@set" will never be inside a dictionary of an expanded json ld object
+        # FIXME: #439 "@set" will never be inside a dictionary of an expanded json ld object
         return (
             isinstance(value, dict)
             and len([1 for ct in cls.container_types if isinstance(value.get(ct, None), list)]) == 1

test/hermes_test/model/types/test_ld_list.py

@@ -107,6 +107,31 @@ def test_append():
     assert 2 * li[4].item_list == 2 * [li[5].data_dict] == li[6].item_list
 
 
+def test_build_in_contains():
+    li = ld_list([{"@list": []}], key="https://schema.org/name", context=[{"schema": "https://schema.org/"}])
+    li.append("foo")
+    li.append({"@type": "A", "schema:name": "a"})
+    assert "foo" in li and {"@type": "A", "schema:name": "a"} in li
+    assert {"@value": "foo"} in li and {"@type": "A", "https://schema.org/name": "a"} in li
+
+
+def test_build_in_comparison():
+    li = ld_list([{"@list": []}], key="https://schema.org/name", context=[{"schema": "https://schema.org/"}])
+    li2 = ld_list([{"@set": []}], key="https://schema.org/name", context=[{"schema": "https://schema.org/"}])
+    li3 = ld_list([{"@list": []}], key="https://schema.org/name", context=[{"schema2": "https://schema.org/"}])
+    assert li == [] and li2 == [] and [] == li and [] == li2
+    assert li != li2 and li == li3
+    li.append("foo")
+    li.append({"@type": "A", "schema:name": "a"})
+    assert li != li3 and ["foo", {"@type": "A", "schema:name": "a"}] == li and ["foo"] != li3
+    assert ["foo", {"@type": "A", "https://schema.org/name": "a"}] == li
+    li3.extend(["foo", {"@type": "A", "schema2:name": "a"}])
+    assert li == li3
+    li4 = ld_list([{"@list": []}], key="https://schema.org/name", context=[{"schema": "https://schema.org/"}])
+    li4.extend([{"@type": "A", "schema:name": "a"}, "foo"])
+    assert li != li4
+
+
 def test_extend():
     li = ld_list([{"@list": []}], key="https://schema.org/name", context=[{"schema": "https://schema.org/"}])
     li.extend([])