Includes OrderedDict objects in the signature (#144)

* changes

* changes

* docs

Author: tjhunter

dds/_introspect_indirect.py

@@ -68,7 +68,7 @@ def _introspect(
 
 
 def _introspect_class(
-    c: type, gctx: EvalMainContext, call_stack: List[CanonicalPath],
+    c: type, gctx: EvalMainContext, call_stack: List[CanonicalPath], debug: bool = False
 ) -> FunctionIndirectInteractions:
     # Check if the function has already been evaluated.
     fun_path = function_path(c)
@@ -93,7 +93,8 @@ def _introspect_class(
     ast_src = ast.parse(src)
     ast_f: ast.ClassDef = ast_src.body[0]  # type: ignore
     assert isinstance(ast_f, ast.ClassDef), type(ast_f)
-    _logger.debug(f"_introspect ast_src:\n {pformat(ast_f)}")
+    if debug:
+        _logger.debug(f"_introspect ast_src:\n {pformat(ast_f)}")
 
     # For each of the functions in the body, look for interactions.
     fiis = InspectFunctionIndirect.inspect_class(

dds/_retrieve_objects.py

@@ -6,6 +6,7 @@
 import logging
 import pathlib
 import typing
+from collections import OrderedDict
 from pathlib import PurePosixPath
 from types import ModuleType, FunctionType
 from typing import (
@@ -59,7 +60,7 @@ def _is_authorized_type(tpe: Type[Any], gctx: EvalMainContext) -> bool:
     # Some specific structural types are more complex and can be user-controlled.
     if get_option(accept_list_option) and tpe in (list,):
         return True
-    if get_option(accept_dict_option) and tpe in (dict,):
+    if get_option(accept_dict_option) and tpe in (dict, OrderedDict):
         return True
     if issubclass(tpe, object):
         mod = inspect.getmodule(tpe)

dds/_version.py

@@ -1 +1 @@
-version = "0.12.0"
+version = "0.12.1"

dds/fun_args.py

@@ -126,9 +126,7 @@ def _dds_hash0(elt: Any) -> PyHash:
         if isinstance(elt, OrderedDict):
             check_len(elt)
             # Directly using the ordering of the items in the dictionary.
-            return _dds_hash(
-                [name + "|" + _dds_hash(v, name) for (name, v) in elt.items()], None
-            )
+            return _dds_hash([_hash_dict_tuple(k, v) for (k, v) in elt.items()], None)
         if isinstance(elt, dict):
             # Starting from python 3.7 the order of the keys in a dictionary is the order of insertion
             # This code should return reliable results for CPython 3.6 and python 3.7+ (i.e. the overwhelming

dds/introspect.py

@@ -130,6 +130,7 @@ def _introspect_class(
     arg_ctx: FunctionArgContext,
     gctx: EvalMainContext,
     call_stack: List[CanonicalPath],
+    debug: bool = False,
 ) -> FunctionInteractions:
     # Check if the function has already been evaluated.
     fun_path = function_path(c)
@@ -153,7 +154,8 @@ def _introspect_class(
     ast_src = ast.parse(src)
     ast_f: ast.ClassDef = ast_src.body[0]  # type: ignore
     assert isinstance(ast_f, ast.ClassDef), type(ast_f)
-    _logger.debug(f"_introspect ast_src:\n {pformat(ast_f)}")
+    if debug:
+        _logger.debug(f"_introspect ast_src:\n {pformat(ast_f)}")
     body_lines = src.split("\n")
 
     # For each of the functions in the body, look for interactions.

dds_tests/test_mod/structures.py

@@ -0,0 +1,13 @@
+import dds
+from ..utils import Counter
+
+
+c = Counter()
+
+l = [1]
+
+
+@dds.data_function("/p")
+def f1():
+    c.increment()
+    return len(l)

dds_tests/test_structures.py

@@ -1,6 +1,8 @@
 import dds
 import pytest
+from collections import OrderedDict
 from .utils import cleandir, Counter
+from .test_mod import structures
 
 _ = cleandir
 
@@ -49,3 +51,38 @@ def test_gh140_dict():
     d[0] = 1
     f2()
     assert _c.value == 2
+
+
+@pytest.mark.usefixtures("cleandir")
+def test_gh140_list():
+    structures.c.reset()
+    structures.f1()
+    assert structures.c.value == 1
+    structures.l[0] = 2
+    structures.f1()
+    assert structures.c.value == 2
+    structures.l[0] = 1
+    structures.f1()
+    assert structures.c.value == 2
+
+
+od = OrderedDict({0: 1})
+
+
+@dds.data_function("/p")
+def f3():
+    _c.increment()
+    return len(od)
+
+
+@pytest.mark.usefixtures("cleandir")
+def test_gh140_ordereddict():
+    _c.reset()
+    f3()
+    assert _c.value == 1
+    od[0] = 2
+    f3()
+    assert _c.value == 2
+    od[0] = 1
+    f3()
+    assert _c.value == 2

doc_source/changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.12.1
+
+Minor relase. Removes verbose logs and ensures that OrderedDict objects are
+also considered in the signature.
+
+
 ## v0.12.0
 
 This is a major release. It adds hashing of lists and dictionaries into the