scipy-doctest 1.5.1__py3-none-any.whl → 1.6__py3-none-any.whl

scipy_doctest/__init__.py

@@ -3,7 +3,7 @@ Configurable, whitespace-insensitive, floating-point-aware doctest helpers.
 """
 
 
-__version__ = "1.5.1"
+__version__ = "1.6"
 
 try:
     # register internal modules with pytest; obscure errors galore otherwise

scipy_doctest/frontend.py

@@ -90,14 +90,24 @@ def find_doctests(module, strategy=None,
     # Having collected the list of objects, extract doctests
     tests = []
     for item, name in zip(items, names):
-        full_name = module.__name__ + '.' + name
         if inspect.ismodule(item):
             # do not recurse, only inspect the module docstring
             _finder = DTFinder(recurse=False, config=config)
             t = _finder.find(item, name, globs=globs, extraglobs=extraglobs)
+            unique_t = set(t)
         else:
+            full_name = module.__name__ + '.' + name
             t = finder.find(item, full_name, globs=globs, extraglobs=extraglobs)
-        tests += t
+
+            unique_t = set(t)
+            if hasattr(item, '__mro__'):
+                # is a class, inspect superclasses
+                # cf https://github.com/scipy/scipy_doctest/issues/177
+                # item.__mro__ starts with itself, ends with `object`
+                for item_ in item.__mro__[1:-1]:
+                    t_ = finder.find(item_, full_name, globs=globs, extraglobs=extraglobs)
+                    unique_t.update(set(t_))
+        tests += list(unique_t)
 
     # If the skiplist contains methods of objects, their doctests may have been
     # left in the `tests` list. Remove them.

scipy_doctest/impl.py

@@ -1,5 +1,6 @@
 import re
 import warnings
+import inspect
 import doctest
 from doctest import NORMALIZE_WHITESPACE, ELLIPSIS, IGNORE_EXCEPTION_DETAIL
 from itertools import zip_longest
@@ -538,6 +539,13 @@ class DTFinder(doctest.DocTestFinder):
         # XXX: does this make similar checks in testmod/testfile duplicate?
         if module not in self.config.skiplist:   
             tests = super().find(obj, name, module, globs, extraglobs)
+
+            if inspect.isclass(obj):
+                for name_, method in inspect.getmembers(obj):
+                    if inspect.isdatadescriptor(method):
+                        tests += super().find(
+                            method, f'{name}.{name_}', module, globs, extraglobs
+                        )
             return tests
 
 

scipy_doctest/tests/finder_cases_2.py

@@ -0,0 +1,22 @@
+"""
+Private method in subclasses
+"""
+
+__all__ = ["Klass"]
+
+class _PrivateKlass:
+    def private_method(self):
+        """
+        >>> 2 / 3
+        0.667
+        """
+        pass
+
+
+class Klass(_PrivateKlass):
+    def public_method(self):
+        """
+        >>> 3 / 4
+        0.74
+        """
+        pass

scipy_doctest/tests/test_finder.py

@@ -1,10 +1,14 @@
 import pytest
 
+import numpy as np
+
 from . import finder_cases
+from . import finder_cases_2
 from ..util import get_all_list, get_public_objects
 from ..impl import DTFinder, DTConfig
 from ..frontend import find_doctests
 
+
 def test_get_all_list():
     items, depr, other = get_all_list(finder_cases)
     assert sorted(items) == ['Klass', 'func']
@@ -111,6 +115,7 @@ class TestSkiplist:
         #   - *private* stuff, which is not in `__all__`
         wanted_names = ['Klass', 'Klass.meth']
         wanted_names = [base] + [base + '.' + n for n in wanted_names]
+        wanted_names += [f'{base}.Klass.__weakref__']
 
         assert sorted(names) == sorted(wanted_names)
 
@@ -129,6 +134,7 @@ class TestSkiplist:
         #   - the 'base' module (via the strategy=<list>)
         wanted_names = ['Klass', 'Klass.meth']
         wanted_names = [base + '.' + n for n in wanted_names]
+        wanted_names += [f'{base}.Klass.__weakref__']
 
         assert sorted(names) == sorted(wanted_names)
 
@@ -137,9 +143,13 @@ def test_explicit_object_list():
     objs = [finder_cases.Klass]
     tests = find_doctests(finder_cases, strategy=objs)
 
+    names = sorted([test.name for test in tests])
+
     base = 'scipy_doctest.tests.finder_cases'
-    assert ([test.name for test in tests] ==
-            [base + '.Klass', base + '.Klass.meth', base + '.Klass.meth_2'])
+    expected = sorted([f'{base}.Klass', f'{base}.Klass.__weakref__',
+                       f'{base}.Klass.meth', f'{base}.Klass.meth_2',])
+
+    assert names == expected
 
 
 def test_explicit_object_list_with_module():
@@ -149,22 +159,64 @@ def test_explicit_object_list_with_module():
     objs = [finder_cases, finder_cases.Klass]
     tests = find_doctests(finder_cases, strategy=objs)
 
+    names = sorted([test.name for test in tests])
+
     base = 'scipy_doctest.tests.finder_cases'
-    assert ([test.name for test in tests] ==
-            [base, base + '.Klass', base + '.Klass.meth', base + '.Klass.meth_2'])
+    expected = sorted([base, f'{base}.Klass', f'{base}.Klass.__weakref__',
+                       f'{base}.Klass.meth', f'{base}.Klass.meth_2'])
+
+    assert names == expected
 
 
 def test_find_doctests_api():
     # Test that the module itself is included with strategy='api'
     tests = find_doctests(finder_cases, strategy='api')
 
+    names = sorted([test.name for test in tests])
+
     base = 'scipy_doctest.tests.finder_cases'
-    assert ([test.name for test in tests] ==
-            [base + '.func', base + '.Klass', base + '.Klass.meth',
-             base + '.Klass.meth_2', base])
+    expected = sorted([base + '.func', base + '.Klass', base + '.Klass.meth',
+             base + '.Klass.meth_2', base + '.Klass.__weakref__', base])
+
+    assert names == expected
 
 
 def test_dtfinder_config():
     config = DTConfig()
     finder = DTFinder(config=config)
     assert finder.config is config
+
+
+@pytest.mark.skipif(np.__version__ < '2', reason="XXX check if works on numpy 1.x")
+def test_descriptors_get_collected():
+    tests = find_doctests(np, strategy=[np.dtype])
+    names = [test.name for test in tests]
+    assert 'numpy.dtype.kind' in names   # was previously missing
+
+
+@pytest.mark.parametrize('strategy', [None, 'api'])
+def test_private_superclasses(strategy):
+    # Test that methods from inherited private superclasses get collected
+    tests = find_doctests(finder_cases_2, strategy=strategy)
+
+    names = set(test.name.split('.')[-1] for test in tests)
+    expected_names = ['finder_cases_2', 'public_method', 'private_method']
+    if strategy == 'api':
+        expected_names += ['__weakref__']
+
+    assert len(tests) == len(expected_names)
+    assert names == set(expected_names)
+
+
+def test_private_superclasses_2():
+    # similar to test_private_superclass, only with an explicit strategy=list
+    tests = find_doctests(finder_cases_2, strategy=[finder_cases_2.Klass])
+
+    names = set(test.name.split('.')[-1] for test in tests)
+    expected_names = ['public_method', 'private_method', '__weakref__']
+
+    assert len(tests) == len(expected_names)
+    assert names == set(expected_names)
+
+
+

{scipy_doctest-1.5.1.dist-info → scipy_doctest-1.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: scipy_doctest
-Version: 1.5.1
+Version: 1.6
 Summary: Configurable, whitespace-insensitive, floating-point-aware doctest helpers.
 Maintainer-email: SciPy developers <scipy-dev@python.org>
 Requires-Python: >=3.8

{scipy_doctest-1.5.1.dist-info → scipy_doctest-1.6.dist-info}/RECORD

@@ -1,29 +1,30 @@
-scipy_doctest/__init__.py,sha256=-RFBEAnfRqgEUJmvLL5MBc6HfuyqetcTQgPsRcVFREU,651
+scipy_doctest/__init__.py,sha256=7yxrEzBJa5wOYwTNIVk07V_hvLLH-SFLEZGwDIAYurs,649
 scipy_doctest/__main__.py,sha256=H8jTO13GlOLzexbgu7lHMJW1y3_NhLOSArARFZ5WS7o,90
 scipy_doctest/conftest.py,sha256=5vZxzuH042urYIToiKWANDJHQPoGkfQI-ppQ_cuHgM0,53
-scipy_doctest/frontend.py,sha256=7Vz9VIRmzdkmwPD1OtI9sJSxCXIF7jmSxXyt6asjaI0,18628
-scipy_doctest/impl.py,sha256=NC61Qy-4VXd3Vjk9WXyTf0oPcm6ZdIiv7WxeVSffTrw,24083
+scipy_doctest/frontend.py,sha256=g4CIPcQH-q1dWc6B0NgkeO5_lDVh2kX7oDHJDEJObLM,19124
+scipy_doctest/impl.py,sha256=tEetxiCUcwz4XFmlDbeBx7ahZvYSQvOFwiaDbBZQEe0,24409
 scipy_doctest/plugin.py,sha256=DzTPBCDIre5b2e8JLiTGw7d9zhCP9hYqXcxeKpFTtys,12900
 scipy_doctest/util.py,sha256=R-pS9FSL5hQNmOA0nhRDLOL1riFVAoK-OhG70ilaKhw,8057
 scipy_doctest/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scipy_doctest/tests/failure_cases.py,sha256=ReSRSugjKDNoWO5M4h-vwCbX_7BwkktlwEjFiGWI3F4,732
 scipy_doctest/tests/failure_cases_2.py,sha256=gupqwSICvzurGIiKVNJRJX9jkmtFR7_Rf3snWU-4Nac,784
 scipy_doctest/tests/finder_cases.py,sha256=s4sq5HZ7m5mXEi1N8dbkgCRY6AxEGcirFRYhEyEG7rw,872
+scipy_doctest/tests/finder_cases_2.py,sha256=Z5pnvVQKk3Z8bWpnQyBSnM02qk-80R0doi7DYUbMBaU,306
 scipy_doctest/tests/local_file.txt,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scipy_doctest/tests/local_file_cases.py,sha256=xQeD809EoLxY-QIb0X7ZPl6Ecyme3zjnf95AHJ_8gp0,914
 scipy_doctest/tests/module_cases.py,sha256=W3u97oMJ8yf0rqrsiQbB1yMMTkKAVz4gNpBLDhijHek,5860
 scipy_doctest/tests/octave_a.mat,sha256=lOfXBSOdMG7_kruTnOHjixXkPy3zSUt10A1FSVjfngI,288
 scipy_doctest/tests/scipy_ndimage_tutorial_clone.rst,sha256=uCtH99RQM0hvDK2_5lgBO2hqtMUOUQhPKxWn4zwHjSs,81594
 scipy_doctest/tests/stopwords_cases.py,sha256=OEZkoFW3B9nHUCG_5adSkLI91avSwNjw-NeUS0D6Yz0,156
-scipy_doctest/tests/test_finder.py,sha256=9bBa3OvB8aTPixMkAFAPlCul7Bm7J95GKri0npOMp9M,6136
+scipy_doctest/tests/test_finder.py,sha256=lzxLj0QSSKYjy9Cp74d5jzl4BZ5pA667iXGd7xRxPkY,7781
 scipy_doctest/tests/test_parser.py,sha256=cmK5kXqTWPUdSVor4bPu6yoikIukDIkVXjIjk1TTPI8,925
 scipy_doctest/tests/test_pytest_configuration.py,sha256=2aesrRyHFdMcRMjARXJ5g8nMtaYC0gb_48Mh8U58RzE,2573
 scipy_doctest/tests/test_runner.py,sha256=qP4u8ngbUK946HhMM6Py70hi0W0DcZGcCN258phhM7g,2936
 scipy_doctest/tests/test_skipmarkers.py,sha256=C5U8BKF3Ti-nPWekt2yK6a3j3Tcg_pq-Z5IuiR-F9eU,7835
 scipy_doctest/tests/test_testfile.py,sha256=66ZHUpEGGg8MfQT8EKSZ8Zx5pV55gP__TZejGMYwBHA,733
 scipy_doctest/tests/test_testmod.py,sha256=PoOI0o2_dXjWDmDkUUKqcJiyZvh46YpjlmMxyW6PXyI,5874
-scipy_doctest-1.5.1.dist-info/entry_points.txt,sha256=dFda3z6PjFL7pEWokv_QmoLwE8X1HETCY1H60xopQ-s,47
-scipy_doctest-1.5.1.dist-info/LICENSE,sha256=xH5PVX8bm8e1JxkmJ-e5FsZsOa7FsNOMfepmCvMoR9g,1523
-scipy_doctest-1.5.1.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-scipy_doctest-1.5.1.dist-info/METADATA,sha256=r7zprKH8IAsQde_mAkhp8SOYdlpV6iUc9pttsYu7wu4,14869
-scipy_doctest-1.5.1.dist-info/RECORD,,
+scipy_doctest-1.6.dist-info/entry_points.txt,sha256=dFda3z6PjFL7pEWokv_QmoLwE8X1HETCY1H60xopQ-s,47
+scipy_doctest-1.6.dist-info/LICENSE,sha256=xH5PVX8bm8e1JxkmJ-e5FsZsOa7FsNOMfepmCvMoR9g,1523
+scipy_doctest-1.6.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+scipy_doctest-1.6.dist-info/METADATA,sha256=a7JvqLaDc-LQ0nsKN9X3gEa4MzQ7aNA8pH8zMqOMHNw,14867
+scipy_doctest-1.6.dist-info/RECORD,,