Merge pull request #153 from ev-br/upd_pyproject.toml

Rename to `scipy_doctest`

Author: ev-br

.github/workflows/pip.yml

@@ -45,11 +45,11 @@ jobs:
     # Tests that require Scipy and MPL will be skipped
     - name: Self-test without SciPy and MPL
       run: |
-        pytest --pyargs scpdt -v
+        pytest --pyargs scipy_doctest -v
 
     - name: Self-test CLI without SciPy and MPL
       run: |
-        python -m scpdt scpdt/tests/finder_cases.py -vv
+        python -m scipy_doctest scipy_doctest/tests/finder_cases.py -vv
 
     # Install Scipy and MPL
     - name: Install optional dependencies
@@ -59,29 +59,29 @@ jobs:
     # Tests that require Scipy and MPL can now run
     - name: Self-test with SciPy and MPL
       run: |
-        pytest --pyargs scpdt -v
+        pytest --pyargs scipy_doctest -v
 
     - name: Self-test CLI with SciPy and MPL
       run: |
-        python -m scpdt scpdt/tests/finder_cases.py -vv
+        python -m scipy_doctest scipy_doctest/tests/finder_cases.py -vv
 
     - name: Test testfile CLI
       run: |
-        python -m scpdt ./scpdt/tests/scipy_ndimage_tutorial_clone.rst -v
+        python -m scipy_doctest ./scipy_doctest/tests/scipy_ndimage_tutorial_clone.rst -v
 
     - name: Run testmod a scipy submodule
       run: |
-        python -c'from scipy.linalg import _basic; from scpdt import testmod; testmod(_basic, verbose=True)'
+        python -c'from scipy.linalg import _basic; from scipy_doctest import testmod; testmod(_basic, verbose=True)'
 
     - name: Run testmod a scipy submodule -- Public API onlly
       run: |
         python -m pip install pooch
-        python -c'from scipy import ndimage; from scpdt import testmod; testmod(ndimage, verbose=True, strategy="api")'
+        python -c'from scipy import ndimage; from scipy_doctest import testmod; testmod(ndimage, verbose=True, strategy="api")'
 
     - name: Test pytest plugin
-      # This test will fail in a venv where scpdt has not been installed and the plugin has not been activated
+      # This test will fail in a venv where scipy_doctest has not been installed and the plugin has not been activated
       run: |
-        test_files=("scpdt/tests/module_cases.py" "scpdt/tests/stopwords_cases.py" "scpdt/tests/local_file_cases.py")
+        test_files=("scipy_doctest/tests/module_cases.py" "scipy_doctest/tests/stopwords_cases.py")
           for file in "${test_files[@]}"; do
             python -m pytest "${file}" --doctest-modules
           done

pyproject.toml

@@ -3,18 +3,20 @@ requires = ["flit_core >=3.2,<4"]
 build-backend = "flit_core.buildapi"
 
 [project]
-name = "scpdt"
-authors = [
-    {name = "Evgeni Burovski et al", email = "[email protected]"}
+name = "scipy_doctest"
+maintainers = [
+    {name = "SciPy developers", email = "[email protected]"}
     ]
 readme = "README.md"
 requires-python = ">=3.8"
 license={file = "LICENSE"}
 dynamic = ["version", "description"]
 classifiers = [
-    "Private :: Do Not Upload",
+    "Development Status :: 4 - Beta",
+    "License :: OSI Approved :: BSD License",
+    "Intended Audience :: Developers",
     "Programming Language :: Python :: 3",
-    "Framework :: Pytest"
+    "Framework :: Pytest",
 ]
 dependencies  = [
     "numpy>=1.19.5",
@@ -36,4 +38,4 @@ addopts = "--verbose --color=yes"
 # specify project entrypoints to make each plugin discoverable by pytest
 # ref: https://docs.pytest.org/en/latest/how-to/writing_plugins.html#making-your-plugin-installable-by-others
 [project.entry-points.pytest11]
-scpdt = "scpdt.plugin"
+scipy_doctest = "scipy_doctest.plugin"

scpdt/__init__.py renamed to scipy_doctest/__init__.py

@@ -5,7 +5,7 @@
 """
 
 
-__version__ = "0.1"
+__version__ = "1.1dev0"
 
 from .impl import DTChecker, DTFinder, DTParser, DTRunner, DebugDTRunner, DTConfig  # noqa
 from .frontend import testmod, testfile, find_doctests, run_docstring_examples      # noqa

scpdt/__main__.py renamed to scipy_doctest/__main__.py

@@ -0,0 +1,5 @@
+from .impl import DTConfig
+
+
+dt_config = DTConfig()
+

scipy_doctest/conftest.py

@@ -2,21 +2,19 @@
 A pytest plugin that provides enhanced doctesting for Pydata libraries
 """
 import bdb
-import os
-import shutil
 import warnings
 import doctest
 
-
 import pytest
-from _pytest import doctest as pydoctest, mark, outcomes
+import _pytest
+from _pytest import doctest as pydoctest, outcomes
 from _pytest.doctest import DoctestModule, DoctestTextfile
 from _pytest.pathlib import import_path
 
-from scpdt.impl import DTChecker, DTParser, DebugDTRunner
-from scpdt.conftest import dt_config
-from scpdt.util import np_errstate, matplotlib_make_nongui, temp_cwd
-from scpdt.frontend import find_doctests
+from .impl import DTParser, DebugDTRunner
+from .conftest import dt_config
+from .util import np_errstate, matplotlib_make_nongui, temp_cwd
+from .frontend import find_doctests
 
 
 def pytest_addoption(parser):
@@ -85,7 +83,7 @@ def _maybe_add_markers(item, config):
 
     extra_skip = dt_config.pytest_extra_skip
     skip_it = item.name in extra_skip
-    if item.name in extra_skip:
+    if skip_it:
         reason = extra_skip[item.name] or ''
         item.add_marker(
             pytest.mark.skip(reason=reason)
@@ -163,7 +161,7 @@ def _is_deprecated(module):
 
     res = False
     try:
-        with warnings.catch_warnings() as w:
+        with warnings.catch_warnings():
             warnings.simplefilter('error', DeprecationWarning)
             getattr(module, names[0])
             res = False