Merge pull request #373 from t20100/add-properties-get_config-repr

Added `get_config` method and `repr` support to all filters; Add parameter properties to some filters

Author: t20100

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,106 +58,89 @@ 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 dataset compression
-+++++++++++++++++++++++
-
-For **built-in** compression filters (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`,
-the dataset compression configuration is stored in HDF5
-`filter pipeline <https://docs.h5py.org/en/stable/high/dataset.html#filter-pipeline>`_.
-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 the filter id and options.
-
-.. autofunction:: from_filter_options
-
 Get information about hdf5plugin
 ++++++++++++++++++++++++++++++++
 
@@ -186,6 +169,33 @@ Registering with this function is required to perform additional initialisation
 
 .. autofunction:: register
 
+Get dataset compression
++++++++++++++++++++++++
+
+For **built-in** compression filters (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`,
+the dataset compression configuration is stored in HDF5
+`filter pipeline <https://docs.h5py.org/en/stable/high/dataset.html#filter-pipeline>`_.
+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 the filter id and options.
+
+.. autofunction:: from_filter_options
+
 Use HDF5 filters in other applications
 ++++++++++++++++++++++++++++++++++++++