Changed tuple or list to iterable

gemd/util/impl.py

@@ -5,6 +5,8 @@
 from gemd.entity.base_entity import BaseEntity
 from gemd.entity.dict_serializable import DictSerializable
 from gemd.entity.link_by_uid import LinkByUID
+
+from collections.abc import Reversible, Iterable
 from toolz import concatv
 
 
@@ -63,7 +65,8 @@ def func(obj):
 
 # The overhead for all the invocations of isinstance was substantial
 isinstance_base_entity = _cached_isinstance_generator(BaseEntity)
-isinstance_list_or_tuple = _cached_isinstance_generator((list, tuple))
+isinstance_iterable = _cached_isinstance_generator(Iterable)
+isinstance_reversible = _cached_isinstance_generator(Reversible)
 isinstance_list = _cached_isinstance_generator(list)
 isinstance_tuple = _cached_isinstance_generator(tuple)
 isinstance_dict = _cached_isinstance_generator(dict)
@@ -289,15 +292,15 @@ def recursive_foreach(obj: Union[List, Tuple, Dict, BaseEntity, DictSerializable
         if apply_first and isinstance_base_entity(this):
             func(this)
 
-        if isinstance_list_or_tuple(this):
-            for x in this:
-                queue.append(x)
-        elif isinstance_dict(this):
+        if isinstance_dict(this):
             for x in concatv(this.keys(), this.values()):
                 queue.append(x)
         elif isinstance_dict_serializable(this):
             for k, x in this.__dict__.items():
                 queue.append(x)
+        elif isinstance_iterable(this):
+            for x in this:
+                queue.append(x)
 
         if not apply_first and isinstance_base_entity(this):
             func(this)
@@ -343,15 +346,17 @@ def recursive_flatmap(obj: Union[List, Tuple, Dict, BaseEntity, DictSerializable
         if isinstance_base_entity(this):
             res.extend(func(this))
 
-        if isinstance_list_or_tuple(this):
-            queue.extend(reversed(this))  # Preserve order of the list/tuple
-        elif isinstance_dict(this):
+        if isinstance_dict(this):
             queue.extend(concatv(this.keys(), this.values()))
         elif isinstance_dict_serializable(this):
             for k, x in sorted(this.__dict__.items()):
                 if unidirectional and isinstance_base_entity(this) and k in this.skip:
                     continue
                 queue.append(x)
+        elif isinstance_reversible(this):
+            queue.extend(reversed(this))  # Preserve order of the list/tuple
+        elif isinstance_iterable(this):
+            queue.extend(this)  # No control over order
 
     return res
 

gemd/util/tests/test_flatten.py

@@ -98,3 +98,24 @@ def test_recursive_flatmap_maintains_order():
     p2 = ProcessSpec(name="two")
     orig = [p1, p2]
     assert [x.name for x in orig] == recursive_flatmap(orig, lambda x: [x.name])
+
+
+def test_more_iterable_types():
+    """Verify recursive_flatmap behaves for additional iterable types."""
+    obj = MaterialRun("foo", tags=["1", "2", "3"])
+
+    assert "1" in obj.tags
+    res = recursive_flatmap({obj}, lambda x: [x.tags.pop(0)])
+    assert "1" in res
+    assert "1" not in obj.tags
+
+    dct = {obj: obj}
+    assert "2" in obj.tags
+    res = recursive_flatmap(dct.keys(), lambda x: [x.tags.pop(0)])
+    assert "2" in res
+    assert "2" not in obj.tags
+
+    assert "3" in obj.tags
+    res = recursive_flatmap(dct.values(), lambda x: [x.tags.pop(0)])
+    assert "3" in res
+    assert "3" not in obj.tags

gemd/util/tests/test_foreach.py

@@ -28,3 +28,21 @@ def test_recursive_foreach():
                 "property_template"
                 ]
     assert sorted(types) == sorted(expected)
+
+
+def test_more_iterable_types():
+    """Verify recursive_foreach behaves for additional iterable types."""
+    obj = MaterialRun("foo", tags=["1", "2", "3"])
+
+    assert "1" in obj.tags
+    recursive_foreach({obj}, lambda x: x.tags.remove("1"))
+    assert "1" not in obj.tags
+
+    dct = {obj: obj}
+    assert "2" in obj.tags
+    recursive_foreach(dct.keys(), lambda x: x.tags.remove("2"))
+    assert "2" not in obj.tags
+
+    assert "3" in obj.tags
+    recursive_foreach(dct.values(), lambda x: x.tags.remove("3"))
+    assert "3" not in obj.tags

setup.py

@@ -2,7 +2,7 @@
 
 
 setup(name='gemd',
-      version='1.2.0',
+      version='1.2.1',
       url='http://github.com/CitrineInformatics/gemd-python',
       description="Python binding for Citrine's GEMD data model",
       author='Max Hutchinson',