Improve error message for guess engine

xarray/backends/cfgrib_.py

@@ -146,6 +146,9 @@ def open_dataset(
             )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_cfgrib
 
-if has_cfgrib:
-    BACKEND_ENTRYPOINTS["cfgrib"] = CfgribfBackendEntrypoint
+
+BACKEND_ENTRYPOINTS["cfgrib"] = CfgribfBackendEntrypoint

xarray/backends/h5netcdf_.py

@@ -393,6 +393,9 @@ def open_dataset(
         )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_h5netcdf
 
-if has_h5netcdf:
-    BACKEND_ENTRYPOINTS["h5netcdf"] = H5netcdfBackendEntrypoint
+
+BACKEND_ENTRYPOINTS["h5netcdf"] = H5netcdfBackendEntrypoint

xarray/backends/netCDF4_.py

@@ -572,6 +572,9 @@ def open_dataset(
             )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_netcdf4
 
-if has_netcdf4:
-    BACKEND_ENTRYPOINTS["netcdf4"] = NetCDF4BackendEntrypoint
+
+BACKEND_ENTRYPOINTS["netcdf4"] = NetCDF4BackendEntrypoint

xarray/backends/plugins.py

@@ -81,7 +81,10 @@ def sort_backends(backend_entrypoints):
 
 
 def build_engines(pkg_entrypoints):
-    backend_entrypoints = BACKEND_ENTRYPOINTS.copy()
+    backend_entrypoints = {}
+    for backend_name, backend in BACKEND_ENTRYPOINTS.items():
+        if backend.are_dependencies_installed():
+            backend_entrypoints[backend_name] = backend
     pkg_entrypoints = remove_duplicates(pkg_entrypoints)
     external_backend_entrypoints = backends_dict_from_pkg(pkg_entrypoints)
     backend_entrypoints.update(external_backend_entrypoints)
@@ -101,30 +104,49 @@ def guess_engine(store_spec):
 
     for engine, backend in engines.items():
         try:
-            if backend.guess_can_open and backend.guess_can_open(store_spec):
+            if backend.guess_can_open(store_spec):
                 return engine
         except Exception:
             warnings.warn(f"{engine!r} fails while guessing", RuntimeWarning)
 
+    compatible = []
+    for engine, backend_cls in BACKEND_ENTRYPOINTS.items():
+        try:
+            backend = backend_cls()
+            if backend.guess_can_open(store_spec):
+                compatible.append(engine)
+        except Exception:
+            warnings.warn(f"{engine!r} fails while guessing", RuntimeWarning)
+
     installed = [k for k in engines if k != "store"]
-    if installed:
-        raise ValueError(
-            "did not find a match in any of xarray's currently installed IO "
-            f"backends {installed}. Consider explicitly selecting one of the "
-            "installed backends via the ``engine`` parameter to "
-            "xarray.open_dataset(), or installing additional IO dependencies:\n"
-            "http://xarray.pydata.org/en/stable/getting-started-guide/installing.html\n"
-            "http://xarray.pydata.org/en/stable/user-guide/io.html"
-        )
+    if not compatible:
+        if installed:
+            error_msg = (
+                "did not find a match in any of xarray's currently installed IO "
+                f"backends {installed}. Consider explicitly selecting one of the "
+                "installed engines via the ``engine`` parameter, or installing "
+                "additional IO dependencies, see:\n"
+                "http://xarray.pydata.org/en/stable/getting-started-guide/installing.html\n"
+                "http://xarray.pydata.org/en/stable/user-guide/io.html"
+            )
+        else:
+            error_msg = (
+                "xarray is unable to open this file because it has no currently "
+                "installed IO backends. Xarray's read/write support requires "
+                "installing optional IO dependencies, see:\n"
+                "http://xarray.pydata.org/en/stable/getting-started-guide/installing.html\n"
+                "http://xarray.pydata.org/en/stable/user-guide/io"
+            )
     else:
-        raise ValueError(
-            "xarray is unable to open this file because it has no currently "
-            "installed IO backends. Xarray's read/write support requires "
-            "installing optional dependencies:\n"
-            "http://xarray.pydata.org/en/stable/getting-started-guide/installing.html\n"
-            "http://xarray.pydata.org/en/stable/user-guide/io.html"
+        error_msg = (
+            "found the following matches with the input file in xarray's IO "
+            f"backends: {compatible}. But their dependencies may not be installed, see:\n"
+            "http://xarray.pydata.org/en/stable/user-guide/io.html \n"
+            "http://xarray.pydata.org/en/stable/getting-started-guide/installing.html"
         )
 
+    raise ValueError(error_msg)
+
 
 def get_backend(engine):
     """Select open_dataset method based on current engine."""

xarray/backends/pseudonetcdf_.py

@@ -152,6 +152,9 @@ def open_dataset(
             )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_pseudonetcdf
 
-if has_pseudonetcdf:
-    BACKEND_ENTRYPOINTS["pseudonetcdf"] = PseudoNetCDFBackendEntrypoint
+
+BACKEND_ENTRYPOINTS["pseudonetcdf"] = PseudoNetCDFBackendEntrypoint

xarray/backends/pydap_.py

@@ -153,6 +153,9 @@ def open_dataset(
             )
             return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_pydap
 
-if has_pydap:
-    BACKEND_ENTRYPOINTS["pydap"] = PydapBackendEntrypoint
+
+BACKEND_ENTRYPOINTS["pydap"] = PydapBackendEntrypoint

xarray/backends/pynio_.py

@@ -112,13 +112,13 @@ def open_dataset(
         mode="r",
         lock=None,
     ):
+        filename_or_obj = _normalize_path(filename_or_obj)
         store = NioDataStore(
             filename_or_obj,
             mode=mode,
             lock=lock,
         )
 
-        filename_or_obj = _normalize_path(filename_or_obj)
         store_entrypoint = StoreBackendEntrypoint()
         with close_on_error(store):
             ds = store_entrypoint.open_dataset(
@@ -133,6 +133,9 @@ def open_dataset(
             )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_pynio
+
 
-if has_pynio:
-    BACKEND_ENTRYPOINTS["pynio"] = PynioBackendEntrypoint
+BACKEND_ENTRYPOINTS["pynio"] = PynioBackendEntrypoint

xarray/backends/scipy_.py

@@ -289,6 +289,9 @@ def open_dataset(
             )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_scipy
 
-if has_scipy:
-    BACKEND_ENTRYPOINTS["scipy"] = ScipyBackendEntrypoint
+
+BACKEND_ENTRYPOINTS["scipy"] = ScipyBackendEntrypoint

xarray/backends/store.py

@@ -41,5 +41,9 @@ def open_dataset(
 
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return True
+
 
 BACKEND_ENTRYPOINTS["store"] = StoreBackendEntrypoint

xarray/backends/zarr.py

@@ -703,6 +703,13 @@ def open_zarr(
 
 
 class ZarrBackendEntrypoint(BackendEntrypoint):
+    def guess_can_open(self, filename_or_obj):
+        try:
+            _, ext = os.path.splitext(filename_or_obj)
+        except TypeError:
+            return False
+        return ext in {".zarr"}
+
     def open_dataset(
         self,
         filename_or_obj,
@@ -756,6 +763,9 @@ def open_dataset(
             )
         return ds
 
+    @staticmethod
+    def are_dependencies_installed() -> bool:
+        return has_zarr
+
 
-if has_zarr:
-    BACKEND_ENTRYPOINTS["zarr"] = ZarrBackendEntrypoint
+BACKEND_ENTRYPOINTS["zarr"] = ZarrBackendEntrypoint

xarray/tests/test_plugins.py

@@ -164,16 +164,20 @@ def test_build_engines_sorted():
     mock.MagicMock(return_value={"dummy": DummyBackendEntrypointArgs()}),
 )
 def test_no_matching_engine_found():
-    with pytest.raises(
-        ValueError, match="match in any of xarray's currently installed IO"
-    ):
+    with pytest.raises(ValueError, match=r"did not find a match in any"):
         plugins.guess_engine("not-valid")
 
+    with pytest.raises(ValueError, match=r"found the following matches with the input"):
+        plugins.guess_engine("foo.nc")
+
 
 @mock.patch(
     "xarray.backends.plugins.list_engines",
     mock.MagicMock(return_value={}),
 )
-def test_no_engines_installed():
-    with pytest.raises(ValueError, match="no currently installed IO backends."):
+def test_engines_not_installed():
+    with pytest.raises(ValueError, match=r"xarray is unable to open"):
         plugins.guess_engine("not-valid")
+
+    with pytest.raises(ValueError, match=r"found the following matches with the input"):
+        plugins.guess_engine("foo.nc")