Make doctest-plus work with spin by stefanv · Pull Request #7786 · scikit-image/scikit-image

stefanv · 2025-04-29T23:08:38Z

--import-mode="importlib" is necessary to successfully collect doctests. Otherwise, the doctest-plus plugin will fail because it finds doctests in skimage/ which don't exist at runtime. E.g, `brief_pythran.py` which exists as a file but is only available at runtime with `brief_cy`. However, there's no need to deviate from the default import mode if doctests are not collected.

I don't really see a reason not to do so. And it may catch errors earlier locally. The argument pattern is copied from what other spin commands do. E.g., spin install --no-editable.

lagru

Works great. Thanks!

I fixed what I think might have been a small logic hiccup and tweaked the interface a bit (more in the commit messages). Is there a reason not to enable doctesting by default?

Please tweak further or revert if you want!

instead of only when `--doctest` option is passed to spin. E.g. users might accidentally use `spin test -- --doctest-...`.

Since the current proposal is to enable doctests by default, we don't need to tell contributors how to run those.

CONTRIBUTING.rst

.spin/cmds.py

* origin/main: Deprecate estimate method in favor of class constructor (scikit-image#7771) Temporary fix for Visual Studio & Clang incompatibility in Windows image (scikit-image#7835) Address deprecations in Pillow 11.3 (scikit-image#7828) Remove unused & obsolete `legacy_datasets`, `legacy_registry` vars (scikit-image#7677) Draft migration guide for skimage2 (scikit-image#7785) Do not report failure in wheels sub-recipe (scikit-image#7806) Use consistent wording in property description. (scikit-image#7804) Add intensity_median to regionprops (scikit-image#7745) CI: Update pypa/gh-action-pypi-publish to v1.12.4 for attestations on PyPI (scikit-image#7793) Document output dtype for transform.resize. (scikit-image#7792) Use `cibuildwheel` to build WASM/Pyodide wheels for `scikit-image`, push nightlies to Anaconda.org (scikit-image#7440) DOC: Include missing gain parameter in adjust_gamma equation (scikit-image#7763) Temporarily pin to `pyodide-build==0.30.0`, and ensure that the correct xbuildenvs are used (scikit-image#7788) Deprecate old names & attributes in RegionProperties (scikit-image#7778) Pin JasonEtco/create-an-issue action to SHA for v2.9.2 (scikit-image#7787) Make doctest-plus work with spin (scikit-image#7786) Report failures on main via issue (scikit-image#7752) Use `workers` instead of alternate parameter names (scikit-image#7302) Fix f-string in otsu plot (scikit-image#7780) Further document use of regionprops function and fix terms. (scikit-image#7518)

Make doctest-plus work with spin

37fb6f4

stefanv added the 🤖 type: Infrastructure CI, packaging, tools and automation label Apr 30, 2025

lagru added 2 commits April 30, 2025 14:02

Test with doctest-plus by default and use --doctest/--no-doctest

c4c2e98

I don't really see a reason not to do so. And it may catch errors earlier locally. The argument pattern is copied from what other spin commands do. E.g., spin install --no-editable.

lagru approved these changes Apr 30, 2025

View reviewed changes

lagru added 2 commits April 30, 2025 14:17

Set importlib mode based on pytest args

6a3b6b4

instead of only when `--doctest` option is passed to spin. E.g. users might accidentally use `spin test -- --doctest-...`.

Update contribution guide

e10c3bf

Since the current proposal is to enable doctests by default, we don't need to tell contributors how to run those.