Skip to content

Improve error message when scipy is missing for NDPointIndex #11085

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Sakshee-D wants to merge 8 commits into
base: main
Choose a base branch
from
+20 −1
Open

Improve error message when scipy is missing for NDPointIndex #11085

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
78691c8
Improve error message when scipy is missing for NDPointIndex
Sakshee-D Jan 12, 2026
ffe9a7a
Add test for missing scipy error in NDPointIndex
Sakshee-D Jan 14, 2026
eefac3a
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 14, 2026
d855290
Merge branch 'main' into ndpointindex-scipy-error-clean
Sakshee-D Jan 14, 2026
9b26615
Fix missing scipy test to avoid leaking import state
Sakshee-D Jan 14, 2026
6f60e96
Test missing scipy via ScipyKDTreeAdapter constructor
Sakshee-D Jan 14, 2026
a836d83
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 14, 2026
d070859
Test missing scipy via ScipyKDTreeAdapter without monkeypatch
Sakshee-D Jan 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion xarray/indexes/nd_point_index.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,13 @@ class ScipyKDTreeAdapter(TreeAdapter):
_kdtree: KDTree

def __init__(self, points: np.ndarray, options: Mapping[str, Any]):
from scipy.spatial import KDTree
try:
from scipy.spatial import KDTree
except ImportError as err:
raise ImportError(
"`NDPointIndex` requires `scipy` when used with `ScipyKDTreeAdapter`. "
"Please ensure that `scipy` is installed and importable."
) from err
Comment on lines +81 to +84
Copy link
Contributor

@ianhi ianhi Jan 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I understand, is the only way to hit this error trying to import the defuault NDPointIndex without scipy installed?

Since there are other possible trees, not all of which necessarily require scipy, is there any those escape this warning?

Copy link
Collaborator

@keewis keewis Jan 14, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NDPointIndex is a generalized class that delegates to a TreeAdapter subclass, which does the import. Thus, every adapter needs to raise its own error if the corresponding optional dependency is missing.

For example, the adapters in xoak would have to raise if sklearn or pys2index are missing.


self._kdtree = KDTree(points, **options)

Expand Down
13 changes: 13 additions & 0 deletions xarray/tests/test_nd_point_index_missing_scipy.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import numpy as np
import pytest

from xarray.indexes.nd_point_index import ScipyKDTreeAdapter
from xarray.tests import has_scipy


@pytest.mark.skipif(has_scipy, reason="requires scipy to be missing")
def test_scipy_kdtree_adapter_missing_scipy():
points = np.random.rand(4, 2)

with pytest.raises(ImportError, match=r"scipy"):
ScipyKDTreeAdapter(points, options={})
Loading