scipy-doctest 1.3__tar.gz → 1.4__tar.gz

{scipy_doctest-1.3 → scipy_doctest-1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scipy_doctest
-Version: 1.3
+Version: 1.4
 Summary: Configurable, whitespace-insensitive, floating-point-aware doctest helpers.
 Maintainer-email: SciPy developers <scipy-dev@python.org>
 Requires-Python: >=3.8
@@ -67,8 +67,8 @@ Its main features are
   >>> np.random.randint(100)
   42     # may vary
   ```
-Note that the markers (by default, `"# may vary"` and `"# random"`) are applied
-to an example's output, not its source.
+Note that the markers (by default, `"# may vary"` and `"# random"`) can be applied
+to either an example's output, or its source.
 
 Also note a difference with respect to the standard `# doctest: +SKIP`: the latter
 skips the example entirely, while these additional markers only skip checking
@@ -291,12 +291,6 @@ and [a doctest example](https://github.com/scipy/scipy_doctest/blob/main/scipy_d
 for more details.
 
 
-### The SciPy Doctest Pytest Plugin
-
-The pytest plugin enables the use of `scipy_doctest` tools to perform doctests.
-
-Follow the given instructions to utilize the pytest plugin for doctesting.
-
 ### NumPy and SciPy wrappers
 
 
@@ -382,6 +376,19 @@ leads to
 - `scipy.linalg.det`, collected from `scipy/linalg/__init__.py`, is public.
 
 
+- *`pytest`'s assertion rewriting*
+
+In some rare cases you may need to either explicitly register the `scipy_doctest`
+package with the `pytest` assertion rewriting machinery, or ask it to avoid rewriting
+completely, via `pytest --assert=plain`.
+See [the `pytest documentation`](https://docs.pytest.org/en/7.1.x/how-to/assert.html)
+for more details.
+
+In general, rewriting assertions is not very useful for doctests, as the
+output on error is fixed by the doctest machinery anyway. Therefore, we believe
+adding `--assert=plain` is reasonable.
+
+
 ## Prior art and related work
 
 - `pytest` provides some limited floating-point aware `NumericLiteralChecker`.

{scipy_doctest-1.3 → scipy_doctest-1.4}/README.md

@@ -48,8 +48,8 @@ Its main features are
   >>> np.random.randint(100)
   42     # may vary
   ```
-Note that the markers (by default, `"# may vary"` and `"# random"`) are applied
-to an example's output, not its source.
+Note that the markers (by default, `"# may vary"` and `"# random"`) can be applied
+to either an example's output, or its source.
 
 Also note a difference with respect to the standard `# doctest: +SKIP`: the latter
 skips the example entirely, while these additional markers only skip checking
@@ -272,12 +272,6 @@ and [a doctest example](https://github.com/scipy/scipy_doctest/blob/main/scipy_d
 for more details.
 
 
-### The SciPy Doctest Pytest Plugin
-
-The pytest plugin enables the use of `scipy_doctest` tools to perform doctests.
-
-Follow the given instructions to utilize the pytest plugin for doctesting.
-
 ### NumPy and SciPy wrappers
 
 
@@ -363,6 +357,19 @@ leads to
 - `scipy.linalg.det`, collected from `scipy/linalg/__init__.py`, is public.
 
 
+- *`pytest`'s assertion rewriting*
+
+In some rare cases you may need to either explicitly register the `scipy_doctest`
+package with the `pytest` assertion rewriting machinery, or ask it to avoid rewriting
+completely, via `pytest --assert=plain`.
+See [the `pytest documentation`](https://docs.pytest.org/en/7.1.x/how-to/assert.html)
+for more details.
+
+In general, rewriting assertions is not very useful for doctests, as the
+output on error is fixed by the doctest machinery anyway. Therefore, we believe
+adding `--assert=plain` is reasonable.
+
+
 ## Prior art and related work
 
 - `pytest` provides some limited floating-point aware `NumericLiteralChecker`.

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/__init__.py

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

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/impl.py

@@ -40,6 +40,11 @@ class DTConfig:
     rtol : float
         Absolute and relative tolerances to check doctest examples with.
         Specifically, the check is ``np.allclose(want, got, atol=atol, rtol=rtol)``
+    strict_check : bool
+       Whether to check that dtypes match or rely on the lax definition of
+       equality of numpy objects. For instance, `3 == np.float64(3)`, but
+       dtypes do not match.
+       Default is False.
     optionflags : int
         doctest optionflags
         Default is ``NORMALIZE_WHITESPACE | ELLIPSIS | IGNORE_EXCEPTION_DETAIL``
@@ -107,6 +112,7 @@ class DTConfig:
                           rndm_markers=None,
                           atol=1e-8,
                           rtol=1e-2,
+                          strict_check=False,
                           # DTRunner configuration
                           optionflags=None,
                           # DTFinder/DTParser configuration
@@ -161,8 +167,8 @@ class DTConfig:
                             '#random', '#Random',
                             "# may vary"}
         self.rndm_markers = rndm_markers
-
         self.atol, self.rtol = atol, rtol
+        self.strict_check = strict_check
 
         ### DTRunner configuration ###
 
@@ -363,23 +369,35 @@ class DTChecker(doctest.OutputChecker):
             return False
 
         # ... and defer to numpy
+        strict = self.config.strict_check
         try:
-            return self._do_check(a_want, a_got)
+            return self._do_check(a_want, a_got, strict)
         except Exception:
             # heterog tuple, eg (1, np.array([1., 2.]))
             try:
-                return all(self._do_check(w, g) for w, g in zip_longest(a_want, a_got))
+                return all(
+                    self._do_check(w, g, strict) for w, g in zip_longest(a_want, a_got)
+                )
             except (TypeError, ValueError):
                 return False
 
-    def _do_check(self, want, got):
+    def _do_check(self, want, got, strict_check):
         # This should be done exactly as written to correctly handle all of
         # numpy-comparable objects, strings, and heterogeneous tuples
+
+        # NB: 3 == np.float64(3.0) but dtypes differ
+        if strict_check:
+            want_dtype = np.asarray(want).dtype
+            got_dtype = np.asarray(got).dtype
+            if want_dtype != got_dtype:
+                return False
+
         try:
             if want == got:
                 return True
         except Exception:
             pass
+
         with warnings.catch_warnings():
             # NumPy's ragged array deprecation of np.array([1, (2, 3)])
             warnings.simplefilter('ignore', VisibleDeprecationWarning)
@@ -514,6 +532,7 @@ class DTParser(doctest.DocTestParser):
         """
         stopwords = self.config.stopwords
         pseudocode = self.config.pseudocode
+        rndm_markers = self.config.rndm_markers
 
         SKIP = doctest.OPTIONFLAGS_BY_NAME['SKIP']
         keep_skipping_this_block = False
@@ -537,6 +556,11 @@ class DTParser(doctest.DocTestParser):
                 # NB: Could have just skipped it via `continue`.
                 example.options[SKIP] = True
 
+            if any(word in example.source for word in rndm_markers):
+                # Found a `# may vary`. Do not check the output (but do check
+                # that the source is valid python).
+                example.want += "  # _ignore\n"
+
             if any(word in example.source for word in stopwords):
                 # Found a stopword. Do not check the output (but do check
                 # that the source is valid python).

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/tests/failure_cases.py

@@ -45,3 +45,11 @@ def tuple_and_list_2():
     >>> (0, 1, 2)
     [0, 1, 2]
     """
+
+
+def dtype_mismatch():
+    """
+    >>> import numpy as np
+    >>> 3.0
+    3
+    """

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/tests/local_file_cases.py

@@ -3,7 +3,7 @@ from ..conftest import dt_config
 # Specify local files required by doctests
 dt_config.local_resources = {
     'scipy_doctest.tests.local_file_cases.local_files': ['local_file.txt'],
-    'scipy_doctest.local_file_cases.sio': ['octave_a.mat']
+    'scipy_doctest.tests.local_file_cases.sio': ['octave_a.mat']
 }
 
 

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/tests/test_pytest_configuration.py

@@ -49,11 +49,9 @@ def test_stopword_cases(pytester):
     assert result.ret == pytest.ExitCode.OK
 
 
-@pytest.mark.xfail(reason="XXX: passes locally, fails on CI")
 @pytest.mark.skipif(not HAVE_SCIPY, reason='need scipy')
 def test_local_file_cases(pytester):
-    """Test that local files are found for use in doctests.
-    """
+    """Test that local files are found for use in doctests."""
     path_str = local_file_cases.__file__
     python_file = Path(path_str)
     result = pytester.inline_run(python_file, "--doctest-modules")

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/tests/test_skipmarkers.py

@@ -161,8 +161,25 @@ class TestMayVary:
                                   filename='none', lineno=0)
 
         runner = DebugDTRunner()
-        with pytest.raises(doctest.DocTestFailure):
+        runner.run(test)
+
+        # one example tried, of which zero failed
+        assert runner.get_history() == {'may_vary_source': (0, 1)}
+
+    def test_may_vary_syntax_error(self):
+        # `# may vary` markers do not mask syntax errors, unlike `# doctest: +SKIP`
+        string = ">>> 1 += 2    # may vary\n"
+        string += "42\n"
+
+        parser = DTParser()
+        test = parser.get_doctest(string, globs={},
+                                  name='may_vary_err',
+                                  filename='none', lineno=0)
+
+        runner = DebugDTRunner()
+        with pytest.raises(Exception) as exc_info:
             runner.run(test)
+        assert exc_info.type == doctest.UnexpectedException
 
 
 string='''\

{scipy_doctest-1.3 → scipy_doctest-1.4}/scipy_doctest/tests/test_testmod.py

@@ -117,6 +117,16 @@ def test_tuple_and_list():
     assert res.failed == 2
 
 
+@pytest.mark.parametrize('strict, num_fails', [(True, 1), (False, 0)])
+class TestStrictDType:
+    def test_np_fix(self, strict, num_fails):
+        config = DTConfig(strict_check=strict)
+        res, _ = _testmod(failure_cases,
+                          strategy=[failure_cases.dtype_mismatch],
+                          config=config)
+        assert res.failed == num_fails
+
+
 class TestLocalFiles:
     def test_local_files(self):
         # A doctest tries to open a local file. Test that it works