Slight tweak to Struct semantics after performance measurement

iommi/struct.py

@@ -34,19 +34,11 @@ def __repr__(self):
     __str__ = __repr__
 
     def __getattribute__(self, item):
-        if not dict.__contains__(self, item):
-            try:
-                return object.__getattribute__(self, item)
-            except AttributeError as e:
-                try:
-                    missing_ = object.__getattribute__(self, '__missing__')
-                except AttributeError:
-                    pass
-                else:
-                    return missing_.__get__(self)(item)
-                raise e
         return dict.__getitem__(self, item)
 
+    def __missing__(self, item):
+        return object.__getattribute__(self, item)
+
     def __setattr__(self, key, value):
         self[key] = value
 

iommi/struct__tests.py

@@ -0,0 +1,295 @@
+import pickle
+import platform
+
+import pytest
+
+from iommi.struct import (
+    Frozen,
+    FrozenStruct,
+    merged,
+    Struct,
+)
+
+
+def test_pybasestruct():
+    s = Struct(a=1)
+    assert s['a'] == 1
+    assert s.a == 1
+
+    s.b = 2
+    assert s['b'] == 2
+
+
+def test_constructor():
+    s = Struct(a=1, b=2, c=3)
+    assert s == Struct(dict(a=1, b=2, c=3))
+    assert s == Struct([('a', 1), ('b', 2), ('c', 3)])
+    assert s == Struct((k, v) for k, v in zip('abc', (1, 2, 3)))
+
+
+def test_get_item():
+    s = Struct(a=1, b=2, c=3)
+    assert 1 == s['a']
+    assert 1 == s.a
+    assert 1 == s.get('a')
+
+
+def test_get_attr_broken_shadow():
+    # This is mostly to document the somewhat quirky behavior when shadowing __getitem__
+    class MyStruct(Struct):
+        def __getitem__(self, key):
+            return 17
+
+    assert MyStruct(x=19)['x'] == 17
+    assert MyStruct(x=19).x == 19
+
+
+def test_set_item():
+    s = Struct(a=1, b=2, c=3)
+    s['a'] = 8
+    assert 8 == s['a']
+    assert 8 == s.a
+
+
+def test_isinstance():
+    s = Struct()
+    assert isinstance(s, dict)
+
+    class FooStruct(Struct):
+        pass
+
+    f = FooStruct(x=17)
+    assert isinstance(f, Struct)
+
+
+def test_containment():
+    s = Struct(c=3)
+    assert 3 not in s
+    assert 'c' in s
+
+
+def test_copy():
+    s = Struct(a=1, b=2, c=3)
+    q = s.copy()
+
+    assert 'a' in q
+    assert 'b' in q
+    assert 'c' in q
+
+    q.x = 6
+    with pytest.raises(AttributeError) as e:
+        # noinspection PyStatementEffect
+        s.x
+
+    assert "'Struct' object has no attribute 'x'" in str(e.value)
+
+    class MyStruct(Struct):
+        pass
+
+    s = MyStruct()
+    q = s.copy()
+
+    assert type(s) == type(q)
+
+
+def test_to_dict():
+    s = Struct(a=1, b=2, c=3)
+    assert {'a': 1, 'b': 2, 'c': 3} == dict(s)
+
+
+def test_items():
+    s = Struct(a=1, b=2, c=3)
+    assert [('a', 1), ('b', 2), ('c', 3)] == sorted(s.items())
+
+
+def test_no_longer_has_dict():
+    s = Struct()
+    with pytest.raises(AttributeError) as e:
+        s.__dict__
+    assert "'Struct' object has no attribute '__dict__'" in str(e.value)
+
+    fs = FrozenStruct()
+    with pytest.raises(AttributeError) as e:
+        fs.__dict__
+    assert "'%s' object has no attribute '__dict__'" % FrozenStruct.__name__ in str(e.value)
+
+
+def test_shadow_methods():
+    if platform.python_implementation() == "PyPy":
+        method_str = "<bound method dict.get of Struct"
+    else:
+        method_str = "<built-in method get of Struct object at"
+
+    s = Struct(not_get=17)
+    assert method_str in str(s.get)
+
+    s = Struct(get=17)
+    assert 17 == s.get
+
+    del s.get
+
+    assert method_str in str(s.get)
+
+
+def test_hash():
+    s = Struct(x=17)
+    with pytest.raises(TypeError) as e:
+        hash(s)
+    if platform.python_implementation() == "PyPy":
+        assert "" in str(e.value)
+    else:
+        assert "unhashable type: 'Struct'" in str(e.value)
+
+    class FrozenStruct(Frozen, Struct):
+        __slots__ = ('_hash',)
+
+    f = FrozenStruct(x=17)
+    assert isinstance(hash(f), int)
+    assert '_hash' not in f.keys()
+
+
+def test_equality():
+    a = Struct()
+    b = Struct()
+
+    assert a == b
+
+
+def test_del():
+    s = Struct(a=1)
+    del s.a
+    assert s.get('a', 'sentinel') == 'sentinel'
+    with pytest.raises(AttributeError) as e:
+        del s.a
+    assert str(e.value) == "'Struct' object has no attribute 'a'"
+
+
+def test_stable_str():
+    assert str(Struct(b=1, a=2)) == f'{Struct.__name__}(a=2, b=1)'
+
+
+def test_recursive_repr():
+    s = Struct()
+    s.s = s
+
+    assert str(s) == f'{Struct.__name__}(s={Struct.__name__}(...))'
+
+    # test fix for use-after-free
+    s = Struct()
+    s.a = s
+    s.b = s
+    assert repr(s) == f'{Struct.__name__}(a={Struct.__name__}(...), b={Struct.__name__}(...))'
+
+
+def test_attribute_exception():
+    with pytest.raises(AttributeError) as e:
+        Struct().foo
+    assert str(e.value) == "'Struct' object has no attribute 'foo'"
+    assert e.value.__context__ is None
+
+
+def test_pickle_struct():
+    s = Struct(x=17)
+    assert s == pickle.loads(pickle.dumps(s, pickle.HIGHEST_PROTOCOL))
+    assert type(s) == type(pickle.loads(pickle.dumps(s, pickle.HIGHEST_PROTOCOL)))  # noqa
+
+
+def test_frozen_struct():
+    f1 = FrozenStruct(x=17)
+    f2 = FrozenStruct(x=17)
+    assert f1 == f2
+    assert hash(f1) == hash(f2)
+
+    assert f1 in {f1}
+    assert f2 in {f1}
+    assert f1 not in {FrozenStruct(x=42)}
+    assert f1 not in {FrozenStruct(y=17)}
+
+    assert Struct(x=17) == FrozenStruct(x=17)
+
+
+def test_modify_frozen_struct():
+    f = FrozenStruct(x=17)
+    with pytest.raises(TypeError) as e:
+        f.x = 42
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+    with pytest.raises(TypeError) as e:
+        f['x'] = 42
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+    with pytest.raises(TypeError) as e:
+        f.update(dict(x=42))
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+    with pytest.raises(TypeError) as e:
+        f.setdefault('foo', 11)
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+    with pytest.raises(TypeError) as e:
+        f.clear()
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+    with pytest.raises(TypeError) as e:
+        del f.x
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+    with pytest.raises(TypeError) as e:
+        del f['x']
+    assert "'FrozenStruct' object attributes are read-only" == str(e.value)
+
+
+def test_pickle_frozen_struct():
+    s = FrozenStruct(x=17)
+    assert s == pickle.loads(pickle.dumps(s, pickle.HIGHEST_PROTOCOL))
+    assert type(s) == type(pickle.loads(pickle.dumps(s, pickle.HIGHEST_PROTOCOL)))  # noqa
+
+
+def test_merged():
+    assert Struct(x=1, y=2) == merged(Struct(x=1), Struct(y=2))
+    assert Struct(x=1, y=2) == merged(Struct(x=1), FrozenStruct(y=2))
+    assert FrozenStruct(x=1, y=2) == merged(FrozenStruct(x=1), Struct(y=2))
+    assert {} == merged()
+    assert Struct(x=1, y=2) == merged(Struct(x=1), y=2)
+
+
+def test_merged_with_kwarg_constructor():
+    class MyStruct(Struct):
+        def __init__(self, **kwargs):
+            super(MyStruct, self).__init__(**kwargs)
+
+    s = MyStruct(foo='foo')
+    assert MyStruct(foo='foo', bar='bar') == merged(s, dict(bar='bar'))
+
+
+def test_merge_to_other_type():
+    s1 = Struct(x=1)
+    s2 = dict(y=2)
+    m = merged(FrozenStruct(), s1, s2)
+    assert FrozenStruct(x=1, y=2) == m
+    assert isinstance(m, FrozenStruct)
+
+
+def test_repr_with_value_exception():
+    class MyException(Exception):
+        pass
+
+    with pytest.raises(MyException):
+
+        class Fisk:
+            def __repr__(self):
+                raise MyException("bummer")
+
+        repr(Struct({'a': Fisk()}))
+
+
+def test_module_attribute():
+    assert Struct.__module__ == 'iommi.struct'
+
+
+def test_frozen_struct_cache_actually_caches():
+    f = FrozenStruct(a=1, b=2)
+    old_hash = hash(f)
+    dict.__setitem__(f, 'a', 2)
+    assert hash(f) == old_hash
+    assert f._hash == old_hash