Add support for filter name as filter_id argument for

from_filter_options

Author: t20100

src/hdf5plugin/_utils.py

@@ -230,14 +230,22 @@ def get_filters(
     return tuple(filter_classes)
 
 
-def from_filter_options(filter_id: int, filter_options: tuple[int, ...]) -> FilterBase:
+def from_filter_options(
+    filter_id: int | str, filter_options: tuple[int, ...]
+) -> FilterBase:
     """Returns corresponding compression filter configuration instance.
 
     :param filter_id: HDF5 compression filter ID
     :param filter_options: Compression filter configuration as stored in HDF5 datasets
     :raises ValueError: Unsupported or invalid filter_id, filter_options combination
     :raises NotImplementedError: Given filter or version of the filter is not supported
     """
+    if isinstance(filter_id, str):
+        try:
+            filter_id = FILTERS[filter_id]
+        except KeyError:
+            raise ValueError(f"Unsupported filter id: {filter_id}")
+
     for filter_cls in FILTER_CLASSES:
         if filter_id == filter_cls.filter_id:
             return filter_cls._from_filter_options(filter_options)

src/hdf5plugin/test.py

@@ -499,7 +499,7 @@ def testStringsZstd(self):
         self._test_strings("zstd")
 
 
-class TestFromFilterOptions(unittest.TestCase):
+class TestFromFilterOptionsMethods(unittest.TestCase):
     """Test _from_filter_options methods"""
 
     def testBitshuffle(self):
@@ -690,6 +690,14 @@ def testZstd(self):
                 self.assertEqual(compression_filter.filter_options, expected_options)
 
 
+class TestFromFilterOptions(unittest.TestCase):
+    """Test from_filter_options function"""
+
+    def test_filter_name(self):
+        compression_filter = hdf5plugin.from_filter_options("bzip2", (5,))
+        self.assertEqual(compression_filter, hdf5plugin.BZip2(blocksize=5))
+
+
 class TestFromFilterOptionsRoundtrip(unittest.TestCase):
     """Test from_filter_options function roundtrip"""
 
@@ -1027,6 +1035,7 @@ def suite() -> unittest.TestSuite:
     for cls in (
         TestHDF5PluginRW,
         TestStrings,
+        TestFromFilterOptionsMethods,
         TestFromFilterOptions,
         TestFromFilterOptionsRoundtrip,
         TestPackage,