Added get_config method and repr support to all filters; Add parameter properties to some filters
#373
Conversation
t20100
force-pushed
the
add-properties-get_config-repr
branch
4 times, most recently
from
158889b to
b08012d
Compare
t20100
force-pushed
the
add-properties-get_config-repr
branch
from
b08012d to
2bd766c
Compare
t20100
changed the title
get_config method and repr support to all filters; Add parameter properties to some filters
t20100
force-pushed
the
add-properties-get_config-repr
branch
from
2bd766c to
d63b597
Compare
src/hdf5plugin/_filters.py
Outdated
| filter_id: int | ||
| filter_name: str | ||
|
|
||
| def _init( |
There was a problem hiding this comment.
Do not use __init__ to avoid providing a typed signature for __init__ since all inherited classes have a different __init__..
Not so nice but working
There was a problem hiding this comment.
Fine having _init else to not have it typed you can have something very generic like __init__(self, *args, **kwargs) maybe ?
| @property | ||
| def nelems(self) -> int: | ||
| """Number of elements per block""" | ||
| return self.filter_options[0] | ||
|
|
||
| @property | ||
| def cname(self) -> Bitshuffle._CNameType: | ||
| """Compressor name""" | ||
| return _cname_from_id(self.filter_options[1], self.__COMPRESSIONS) | ||
|
|
||
| @property | ||
| def clevel(self) -> int | None: | ||
| """Compression level, only for `zstd` compressor, None for others""" | ||
| return self.filter_options[2] if self.cname == "zstd" else None |
There was a problem hiding this comment.
Adding properties for the "simple" filter_options.
There was a problem hiding this comment.
if compressor is zstd are we sure filter_options with have at least 3 elements ?
| with self.subTest(filter=filter_class.filter_name): | ||
| filter_instance = filter_class() | ||
| repr_string = repr(filter_instance) | ||
| repr_instance = eval( |
There was a problem hiding this comment.
Keeping this test here so it is not installed since it uses eval.
| @property | ||
| def nelems(self) -> int: | ||
| """Number of elements per block""" | ||
| return self.filter_options[0] |
There was a problem hiding this comment.
filter_options can be empty I think (default value is an empty tuple).
src/hdf5plugin/_filters.py
Outdated
| filter_id: int | ||
| filter_name: str | ||
|
|
||
| def _init( |
There was a problem hiding this comment.
Fine having _init else to not have it typed you can have something very generic like __init__(self, *args, **kwargs) maybe ?
| @property | ||
| def nelems(self) -> int: | ||
| """Number of elements per block""" | ||
| return self.filter_options[0] | ||
|
|
||
| @property | ||
| def cname(self) -> Bitshuffle._CNameType: | ||
| """Compressor name""" | ||
| return _cname_from_id(self.filter_options[1], self.__COMPRESSIONS) | ||
|
|
||
| @property | ||
| def clevel(self) -> int | None: | ||
| """Compression level, only for `zstd` compressor, None for others""" | ||
| return self.filter_options[2] if self.cname == "zstd" else None |
There was a problem hiding this comment.
if compressor is zstd are we sure filter_options with have at least 3 elements ?
2 participants
This MR adds API to retrieve the configuration of the filter in a more explicit way than through the
filter_optionstuple of ints.get_config() -> dictmethods (to do the same asnumcodecs) to all filters which returns the kwargs to pass to the given filter to instantiate one with the same configuration.@propertyto give access to those parameters to some filters. This is not done for Zfp, Sperr, SZ and SZ3 where the parameter schema is a bit more complex.reprcloses #371
closes #370