Fix automatic reader table not listing readers with missing dependencies

doc/source/_static/main.js

@@ -1,5 +1,6 @@
 $(document).ready( function () {
     $('table.datatable').DataTable( {
-    "paging": false
+    "paging": false,
+    "dom": 'lfitp'
 } );
 } );

doc/source/reader_table.py

@@ -18,6 +18,8 @@
 # along with satpy.  If not, see <http://www.gnu.org/licenses/>.
 """Module for autogenerating reader table from config files."""
 
+from yaml import BaseLoader
+
 from satpy.readers import available_readers
 
 
@@ -72,7 +74,7 @@ def generate_reader_table():
     table = [rst_table_header("Satpy Readers", header=["Description", "Reader name", "Status", "fsspec support"],
                               widths=[45, 25, 30, 30])]
 
-    reader_configs = available_readers(as_dict=True)
+    reader_configs = available_readers(as_dict=True, yaml_loader=BaseLoader)
     for rc in reader_configs:
         table.append(rst_table_row([rc.get("long_name", "").rstrip("\n"), rc.get("name", ""),
                                     rc.get("status", ""), rc.get("supports_fsspec", "false")]))

satpy/composites/config_loader.py

@@ -25,11 +25,7 @@
 from typing import Callable, Iterable
 
 import yaml
-
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
+from yaml import UnsafeLoader
 
 import satpy
 from satpy import DataID, DataQuery

satpy/plugin_base.py

@@ -20,11 +20,7 @@
 import logging
 
 import yaml
-
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
+from yaml import UnsafeLoader
 
 from satpy._config import config_search_paths
 from satpy.utils import recursive_dict_update

satpy/readers/__init__.py

@@ -26,11 +26,7 @@
 from functools import total_ordering
 
 import yaml
-
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
+from yaml import UnsafeLoader
 
 from satpy._config import config_search_paths, get_entry_points_config_dirs, glob_config
 
@@ -370,7 +366,7 @@ def get_valid_reader_names(reader):
     return new_readers
 
 
-def available_readers(as_dict=False):
+def available_readers(as_dict=False, yaml_loader=UnsafeLoader):
     """Available readers based on current configuration.
 
     Args:
@@ -385,7 +381,7 @@ def available_readers(as_dict=False):
     readers = []
     for reader_configs in configs_for_reader():
         try:
-            reader_info = read_reader_config(reader_configs)
+            reader_info = read_reader_config(reader_configs, loader=yaml_loader)
         except (KeyError, IOError, yaml.YAMLError):
             LOG.debug("Could not import reader config from: %s", reader_configs)
             LOG.debug("Error loading YAML", exc_info=True)

satpy/readers/yaml_reader.py

@@ -26,22 +26,16 @@
 from collections import OrderedDict, deque
 from contextlib import suppress
 from fnmatch import fnmatch
+from functools import cached_property
 from weakref import WeakValueDictionary
 
 import numpy as np
 import xarray as xr
 import yaml
-
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
-
-from functools import cached_property
-
 from pyresample.boundary import AreaDefBoundary, Boundary
 from pyresample.geometry import AreaDefinition, StackedAreaDefinition, SwathDefinition
 from trollsift.parser import globify, parse
+from yaml import UnsafeLoader
 
 from satpy import DatasetDict
 from satpy.aux_download import DataDownloadMixin

satpy/tests/test_readers.py

@@ -17,7 +17,9 @@
 # satpy.  If not, see <http://www.gnu.org/licenses/>.
 """Test classes and functions in the readers/__init__.py module."""
 
+import builtins
 import os
+import sys
 import unittest
 from contextlib import suppress
 from unittest import mock
@@ -55,6 +57,8 @@
 },
 }
 
+real_import = builtins.__import__
+
 
 def make_dataid(**items):
     """Make a data id."""
@@ -625,6 +629,11 @@ def test_old_reader_name_mapping(self):
 class TestYAMLFiles(unittest.TestCase):
     """Test and analyze the reader configuration files."""
 
+    def setUp(self):
+        """Set up monkeypatch."""
+        from _pytest.monkeypatch import MonkeyPatch
+        self.monkeypatch = MonkeyPatch()
+
     def test_filename_matches_reader_name(self):
         """Test that every reader filename matches the name in the YAML."""
         import yaml
@@ -662,6 +671,28 @@ def test_available_readers(self):
             self.assertIn('name', reader_info)
         self.assertEqual(reader_infos, sorted(reader_infos, key=lambda reader_info: reader_info['name']))
 
+    def test_available_readers_base_loader(self):
+        """Test the 'available_readers' function for yaml loader type BaseLoader."""
+        import yaml
+
+        from satpy import available_readers
+        from satpy._config import glob_config
+
+        def patched_import_error(name, globals=None, locals=None, fromlist=(), level=0):
+            if name in ('netcdf4', ):
+                raise ImportError(f"Mocked import error {name}")
+            return real_import(name, globals=globals, locals=locals, fromlist=fromlist, level=level)
+
+        self.monkeypatch.delitem(sys.modules, 'netcdf4', raising=False)
+        self.monkeypatch.setattr(builtins, '__import__', patched_import_error)
+
+        with pytest.raises(ImportError):
+            import netcdf4  # noqa: F401
+
+        reader_names = available_readers(yaml_loader=yaml.BaseLoader)
+        self.assertIn('abi_l1b', reader_names)  # needs netcdf4
+        self.assertEqual(len(reader_names), len(list(glob_config('readers/*.yaml'))))
+
 
 class TestGroupFiles(unittest.TestCase):
     """Test the 'group_files' utility function."""

satpy/utils.py

@@ -31,15 +31,10 @@
 import numpy as np
 import xarray as xr
 import yaml
-from yaml import BaseLoader
+from yaml import BaseLoader, UnsafeLoader
 
 from satpy import CHUNK_SIZE
 
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
-
 _is_logging_on = False
 TRACE_LEVEL = 5
 

satpy/writers/__init__.py

@@ -29,14 +29,9 @@
 import numpy as np
 import xarray as xr
 import yaml
-
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
-
 from trollimage.xrimage import XRImage
 from trollsift import parser
+from yaml import UnsafeLoader
 
 from satpy import CHUNK_SIZE
 from satpy._config import config_search_paths, get_entry_points_config_dirs, glob_config

setup.py

@@ -31,7 +31,7 @@
     pass
 
 requires = ['numpy >=1.13', 'pillow', 'pyresample >=1.24.0', 'trollsift',
-            'trollimage >1.10.1', 'pykdtree', 'pyyaml', 'xarray >=0.10.1, !=0.13.0',
+            'trollimage >1.10.1', 'pykdtree', 'pyyaml >=5.1', 'xarray >=0.10.1, !=0.13.0',
             'dask[array] >=0.17.1', 'pyproj>=2.2', 'zarr', 'donfig', 'appdirs',
             'pooch', 'pyorbital']
 

utils/convert_to_ninjotiff.py

@@ -30,17 +30,12 @@
 import os
 
 import yaml
+from yaml import UnsafeLoader
 
 from satpy import Scene
 from satpy.pyresample import get_area_def
 from satpy.utils import debug_on
 
-try:
-    from yaml import UnsafeLoader
-except ImportError:
-    from yaml import Loader as UnsafeLoader  # type: ignore
-
-
 debug_on()
 
 parser = argparse.ArgumentParser(description='Turn an image into a NinjoTiff.')