Added API to get filter config: properties, get_config; Added repr()

doc/conf.py

@@ -45,3 +45,5 @@
 # a list of builtin themes.
 #
 html_theme = "sphinx_rtd_theme"
+
+autodoc_member_order = "bysource"

doc/usage.rst

@@ -58,76 +58,87 @@ Bitshuffle
 
 .. autoclass:: Bitshuffle
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 Blosc
 =====
 
 .. autoclass:: Blosc
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 Blosc2
 ======
 
 .. autoclass:: Blosc2
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 BZip2
 =====
 
 .. autoclass:: BZip2
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 FciDecomp
 =========
 
 .. autoclass:: FciDecomp
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 LZ4
 ===
 
 .. autoclass:: LZ4
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 Sperr
 =====
 
 .. autoclass:: Sperr
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 SZ
 ==
 
 .. autoclass:: SZ
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 SZ3
 ===
 
 .. autoclass:: SZ3
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 Zfp
 ===
 
 .. autoclass:: Zfp
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 Zstd
 ====
 
 .. autoclass:: Zstd
    :members:
+   :inherited-members: FilterRefBase, Mapping
    :undoc-members:
 
 Get information about hdf5plugin
@@ -158,6 +169,33 @@ Registering with this function is required to perform additional initialisation
 
 .. autofunction:: register
 
+Get dataset compression
++++++++++++++++++++++++
+
+For compression filters provided by HDF5 and `h5py`_ (i.e., GZIP, LZF, SZIP),
+dataset compression configuration can be retrieved with `h5py.Dataset`_'s
+`compression <https://docs.h5py.org/en/stable/high/dataset.html#h5py.Dataset.compression>`_ and
+`compression_opts <https://docs.h5py.org/en/stable/high/dataset.html#h5py.Dataset.compression_opts>`_ properties.
+
+For third-party compression filters such as the one supported by `hdf5plugin`,
+information about dataset compression is stored in HDF5
+`filter pipeline <https://docs.h5py.org/en/stable/high/dataset.html#filter-pipeline>`_ configuration.
+This filter pipeline configuration can be retrieved with `h5py.Dataset`_ "low level" API.
+For a given `h5py.Dataset`_, ``dataset``:
+
+.. code-block:: python
+
+   create_plist = dataset.id.get_create_plist()
+
+   for index in range(create_plist.get_nfilters()):
+       filter_id, _, filter_options, _ = create_plist.get_filter(index)
+       print(filter_id, filter_options)
+
+For compression filters supported by `hdf5plugin`,
+:func:`hdf5plugin.from_filter_options` instantiates the filter configuration from ``filter_id`` and ``filter_options``.
+
+.. autofunction:: from_filter_options
+
 Use HDF5 filters in other applications
 ++++++++++++++++++++++++++++++++++++++
 
@@ -176,3 +214,4 @@ Setting the ``HDF5_PLUGIN_PATH`` environment variable allows already existing pr
 .. _h5py: https://www.h5py.org
 .. _h5py.h5z: https://github.com/h5py/h5py/blob/master/h5py/h5z.pyx
 .. _h5py.Group.create_dataset: https://docs.h5py.org/en/stable/high/group.html#h5py.Group.create_dataset
+.. _h5py.Dataset: https://docs.h5py.org/en/stable/high/dataset.html

src/hdf5plugin/__init__.py

@@ -52,7 +52,13 @@
     Zfp,
     Zstd,
 )
-from ._utils import PLUGIN_PATH, get_config, get_filters, register  # noqa
+from ._utils import (  # noqa
+    PLUGIN_PATH,
+    from_filter_options,
+    get_config,
+    get_filters,
+    register,
+)
 from ._version import version  # noqa
 
 # Backward compatibility