scipy-doctest 1.7__tar.gz → 1.8.0__tar.gz

{scipy_doctest-1.7 → scipy_doctest-1.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scipy_doctest
-Version: 1.7
+Version: 1.8.0
 Summary: Configurable, whitespace-insensitive, floating-point-aware doctest helpers.
 Maintainer-email: SciPy developers <scipy-dev@python.org>
 Requires-Python: >=3.8
@@ -17,7 +17,7 @@ Requires-Dist: furo==2024.8.6 ; extra == "doc"
 Requires-Dist: myst-parser==4.0.0 ; extra == "doc"
 Requires-Dist: sphinx==8.1.3 ; extra == "doc"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "doc"
-Requires-Dist: scipy <= 1.14.1 ; extra == "test"
+Requires-Dist: scipy ; extra == "test"
 Requires-Dist: matplotlib ; extra == "test"
 Project-URL: Home, https://github.com/scipy/scipy_doctest
 Provides-Extra: doc
@@ -176,6 +176,22 @@ $ pytest --pyargs <your-package> --doctest-modules --doctest-collect=api
 See [More fine-grained control](#more-fine-grained-control) section
 for details on how to customize the behavior.
 
+** NOTE ** Currently, `pytest --doctest-modules` only collects doctests and skips
+'regular' unit tests. This differs from the vanilla `pytest` behavior, which collects
+both doctests and unit tests.
+The behavior will change in a future version: `scipy-doctest==2.0` **will change the
+default** to align with the vanilla `pytest`.
+
+To retain the current behavior, use the `--doctest-only-doctests` CLI option:
+
+```
+$ pytest --doctest-modules --doctest-only-doctests
+```
+
+is unambiguous and will behave identically in the current version 1.8 and upcoming
+versions of `scipy-doctest`. 
+
+
 ### Basic usage
 
 The use of `pytest` is optional, and you can use the `doctest` layer API.
@@ -316,11 +332,11 @@ NumPy wraps `scipy-doctest` with the `spin` command
 $ spin check-docs
 ```
 
-SciPy wraps `scipy-doctest` with custom `dev.py` commands:
+In SciPy, the name of the `spin` command is `smoke-docs`::
 
 ```
-$ python dev.py smoke-docs    # check docstrings
-$ python dev.py smoke-tutorials   # ReST user guide tutorials
+$ spin smoke-docs    # check docstrings
+$ spin smoke-tutorials   # ReST user guide tutorials
 ```
 
 ## Rough edges and sharp bits

{scipy_doctest-1.7 → scipy_doctest-1.8.0}/README.md

@@ -151,6 +151,22 @@ $ pytest --pyargs <your-package> --doctest-modules --doctest-collect=api
 See [More fine-grained control](#more-fine-grained-control) section
 for details on how to customize the behavior.
 
+** NOTE ** Currently, `pytest --doctest-modules` only collects doctests and skips
+'regular' unit tests. This differs from the vanilla `pytest` behavior, which collects
+both doctests and unit tests.
+The behavior will change in a future version: `scipy-doctest==2.0` **will change the
+default** to align with the vanilla `pytest`.
+
+To retain the current behavior, use the `--doctest-only-doctests` CLI option:
+
+```
+$ pytest --doctest-modules --doctest-only-doctests
+```
+
+is unambiguous and will behave identically in the current version 1.8 and upcoming
+versions of `scipy-doctest`. 
+
+
 ### Basic usage
 
 The use of `pytest` is optional, and you can use the `doctest` layer API.
@@ -291,11 +307,11 @@ NumPy wraps `scipy-doctest` with the `spin` command
 $ spin check-docs
 ```
 
-SciPy wraps `scipy-doctest` with custom `dev.py` commands:
+In SciPy, the name of the `spin` command is `smoke-docs`::
 
 ```
-$ python dev.py smoke-docs    # check docstrings
-$ python dev.py smoke-tutorials   # ReST user guide tutorials
+$ spin smoke-docs    # check docstrings
+$ spin smoke-tutorials   # ReST user guide tutorials
 ```
 
 ## Rough edges and sharp bits

{scipy_doctest-1.7 → scipy_doctest-1.8.0}/pyproject.toml

@@ -25,7 +25,7 @@ dependencies  = [
 
 [project.optional-dependencies]
 test = [
-    "scipy <= 1.14.1",   # black-list 1.5.1 ?
+    "scipy",
     "matplotlib"
 ]
 doc = [

{scipy_doctest-1.7 → scipy_doctest-1.8.0}/scipy_doctest/__init__.py

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

{scipy_doctest-1.7 → scipy_doctest-1.8.0}/scipy_doctest/impl.py

@@ -2,6 +2,7 @@ import re
 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 @@ class DTChecker(doctest.OutputChecker):
         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-1.7 → scipy_doctest-1.8.0}/scipy_doctest/plugin.py

@@ -29,6 +29,28 @@ def pytest_addoption(parser):
         dest="collection_strategy"
     )
 
+    # We cannot add `--doctest-only` option because of
+    # https://github.com/pytest-dev/pytest/discussions/13435
+    #
+    # Therefore, we add a new option, --doctest-only-doctests,
+    # which is `true` by default, for now.
+    #
+    # In v2.0, it the default will become `false`, so that
+    #
+    # $ pytest --doctest-modules
+    #
+    # will run both doctests and unit tests, and the way to use the
+    # current behavior (only run doctests, skip unit tests) will be
+    #
+    # $ pytest --doctest-modules --doctest-only-doctests=true
+    #
+    group.addoption("--doctest-only-doctests",
+        action="store",
+        default="true",
+        help="Whether to only collect doctests, or also collect unit tests, too.",
+        choices=("true", "false"),
+        dest="doctest_only_doctests"
+    )
 
 def pytest_configure(config):
     """
@@ -49,7 +71,13 @@ def pytest_ignore_collect(collection_path, config):
     This function is used to exclude the 'tests' directory and test modules when
     the `--doctest-modules` option is used.
     """
-    if config.getoption("--doctest-modules"):
+    # XXX: in v2.0, --doctest-modules will mean "run both doctests and unit tests",
+    # (consistent with vanilla pytest), and the way to retain the current behavior
+    # will be to add --doctest-only-doctests=true to the CLI command
+    if (
+        config.getoption("--doctest-modules") and
+        config.getoption("--doctest-only-doctests") == 'true'
+    ):
         path_str = str(collection_path)
         if "tests" in path_str or "test_" in path_str:
             return True

{scipy_doctest-1.7 → scipy_doctest-1.8.0}/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-1.7 → scipy_doctest-1.8.0}/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-1.7 → scipy_doctest-1.8.0}/scipy_doctest/tests/test_testmod.py

@@ -15,6 +15,7 @@ import pytest
 
 try:
     import scipy    # noqa
+    from scipy import stats   # https://github.com/scipy/scipy_doctest/issues/184
     HAVE_SCIPY = True
 except Exception:
     HAVE_SCIPY = False
@@ -116,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:

scipy_doctest-1.7/scipy_doctest/.ruff_cache/.gitignore

@@ -1,2 +0,0 @@
-# Automatically created by ruff.
-*

scipy_doctest-1.7/scipy_doctest/.ruff_cache/CACHEDIR.TAG

@@ -1 +0,0 @@
-Signature: 8a477f597d28d172789f06886806bc55