Merge pull request #196 from scipy/dicts

ENH: handle dicts to check values not only the keys

Author: ev-br

scipy_doctest/impl.py

@@ -2,6 +2,7 @@
 import warnings
 import inspect
 import doctest
+import operator
 from doctest import NORMALIZE_WHITESPACE, ELLIPSIS, IGNORE_EXCEPTION_DETAIL
 from itertools import zip_longest
 from sys import version_info
@@ -413,6 +414,19 @@ def check_output(self, want, got, optionflags):
         if is_list_or_tuple and type(a_want) is not type(a_got):
             return False
 
+        # dicts and other mappings need special treatment
+        want_is_dict = hasattr(a_want, 'items')
+        got_is_dict = hasattr(a_got, 'items')
+        if operator.xor(want_is_dict, got_is_dict):
+            # either both are dicts or both are not
+            return False
+
+        if want_is_dict:
+            # convert dicts into lists of key-value pairs and retry
+            want_items = str(list(a_want.items()))
+            got_items = str(list(a_got.items()))
+            return self.check_output(want_items, got_items, optionflags)
+
         # ... and defer to numpy
         strict = self.config.strict_check
         try:

scipy_doctest/tests/failure_cases.py

@@ -53,3 +53,46 @@ def dtype_mismatch():
     >>> 3.0
     3
     """
+
+
+def dict_not_dict():
+    """
+    >>> dict(a=1, b=2)
+    ['a', 'b']
+    """
+
+def dict_not_dict_2():
+    """
+    >>> [('a', 1), ('b', 2)]
+    {'a': 1, 'b': 2}
+    """
+
+
+def dict_wrong_keys():
+    """
+    >>> dict(a=1, b=2)
+    {'c': 1, 'd': 2}
+    """
+
+
+def dict_wrong_values():
+    """
+    >>> dict(a=1, b=2)
+    {'a': -1, 'b': -2}
+    """
+
+
+def dict_wrong_values_np():
+    """
+    >>> import numpy as np
+    >>> dict(a=1, b=np.arange(3)/3)
+    {'a': 1, 'b': array([0, 0.335, 0.669])}
+    """
+
+
+def dict_nested_wrong_values_np():
+    """
+    >>> import numpy as np
+    >>> dict(a=1, b=dict(blurb=np.arange(3)/3))
+    {'a': 1, 'b': {'blurb': array([0, 0.335, 0.669])}}
+    """

scipy_doctest/tests/module_cases.py

@@ -242,3 +242,21 @@ def array_and_list_2():
     >>> [1, 2, 3]
     array([1, 2, 3])
     """
+
+
+def two_dicts():
+    """
+    >>> import numpy as np
+    >>> dict(a=0, b=1)
+    {'a': 0, 'b': 1}
+    >>> {'a': 0., 'b': np.arange(3) / 3 }
+    {'a': 0.0, 'b': array([0, 0.33333333, 0.66666667])}
+    """
+
+def nested_dicts():
+    """
+    >>> import numpy as np
+    >>> {'a': 1.0, 'b': dict(blurb=np.arange(3)/3)}
+    {'a': 1.0, 'b': {'blurb': array([0, 0.33333333, 0.66666667])}}
+    """
+

scipy_doctest/tests/test_testmod.py

@@ -117,6 +117,18 @@ def test_tuple_and_list():
                       config=config)
     assert res.failed == 2
 
+def test_dict():
+    config = DTConfig()
+    res, _ = _testmod(failure_cases,
+                      strategy=[failure_cases.dict_not_dict,
+                                failure_cases.dict_not_dict_2,
+                                failure_cases.dict_wrong_keys,
+                                failure_cases.dict_wrong_values,
+                                failure_cases.dict_wrong_values_np,
+                                failure_cases.dict_nested_wrong_values_np],
+                      config=config)
+    assert res.failed == 6
+
 
 @pytest.mark.parametrize('strict, num_fails', [(True, 1), (False, 0)])
 class TestStrictDType: