feat: skbase inheritance for config objects (#31)

This PR changes config and sampler objects to inherit from `skbase`
`BaseObject`, and in turn removes redundant methods such as `__repr__`.

Depends on #10 which
should be merged first.

---------

Co-authored-by: Sankalp Gilda <[email protected]>

Author: fkiraly

src/tsbootstrap/block_bootstrap_configs.py

@@ -247,45 +247,6 @@ def min_block_length(self, value) -> None:
             validate_single_integer(value, min_value=1)
         self._min_block_length = value
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"block_length={self.block_length}, "
-            f"block_length_distribution={self.block_length_distribution}, "
-            f"wrap_around_flag={self.wrap_around_flag}, "
-            f"overlap_flag={self.overlap_flag}, "
-            f"combine_generation_and_sampling_flag={self.combine_generation_and_sampling_flag}, "
-            f"block_weights={self.block_weights}, "
-            f"tapered_weights={self.tapered_weights}, "
-            f"overlap_length={self.overlap_length}, "
-            f"min_block_length={self.min_block_length})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, BlockBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.block_length == other.block_length
-            and self.block_length_distribution
-            == other.block_length_distribution
-            and self.wrap_around_flag == other.wrap_around_flag
-            and self.overlap_flag == other.overlap_flag
-            and self.combine_generation_and_sampling_flag
-            == other.combine_generation_and_sampling_flag
-            and self.block_weights == other.block_weights
-            and self.tapered_weights == other.tapered_weights
-            and self.overlap_length == other.overlap_length
-            and self.min_block_length == other.min_block_length
-        )
-
 
 class BaseBlockBootstrapConfig(BlockBootstrapConfig):
     """
@@ -327,24 +288,6 @@ def bootstrap_type(self, value: str | None):
             raise ValueError(f"bootstrap_type must be one of {valid_types}.")
         self._bootstrap_type = value
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return f"{base_repr[:-1]}, bootstrap_type={self.bootstrap_type})"
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, BaseBlockBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.bootstrap_type == other.bootstrap_type
-        )
-
 
 class MovingBlockBootstrapConfig(BlockBootstrapConfig):
     """
@@ -385,34 +328,6 @@ def __init__(
         self._overlap_flag = True
         self._block_length_distribution = None
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"block_length={self.block_length}, "
-            f"wrap_around_flag={self.wrap_around_flag}, "
-            f"overlap_flag={self.overlap_flag}, "
-            f"block_length_distribution={self.block_length_distribution})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, MovingBlockBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.block_length == other.block_length
-            and self.wrap_around_flag == other.wrap_around_flag
-            and self.overlap_flag == other.overlap_flag
-            and self.block_length_distribution
-            == other.block_length_distribution
-        )
-
 
 class StationaryBlockBootstrapConfig(BlockBootstrapConfig):
     """
@@ -453,34 +368,6 @@ def __init__(
         self._overlap_flag = True
         self._block_length_distribution = "geometric"
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"block_length={self.block_length}, "
-            f"wrap_around_flag={self.wrap_around_flag}, "
-            f"overlap_flag={self.overlap_flag}, "
-            f"block_length_distribution={self.block_length_distribution})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, StationaryBlockBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.block_length == other.block_length
-            and self.wrap_around_flag == other.wrap_around_flag
-            and self.overlap_flag == other.overlap_flag
-            and self.block_length_distribution
-            == other.block_length_distribution
-        )
-
 
 class CircularBlockBootstrapConfig(BlockBootstrapConfig):
     """
@@ -521,34 +408,6 @@ def __init__(
         self._overlap_flag = True
         self._block_length_distribution = None
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"block_length={self.block_length}, "
-            f"wrap_around_flag={self.wrap_around_flag}, "
-            f"overlap_flag={self.overlap_flag}, "
-            f"block_length_distribution={self.block_length_distribution})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, CircularBlockBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.block_length == other.block_length
-            and self.wrap_around_flag == other.wrap_around_flag
-            and self.overlap_flag == other.overlap_flag
-            and self.block_length_distribution
-            == other.block_length_distribution
-        )
-
 
 class NonOverlappingBlockBootstrapConfig(BlockBootstrapConfig):
     """
@@ -589,34 +448,6 @@ def __init__(
         self._overlap_flag = False
         self._block_length_distribution = None
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"block_length={self.block_length}, "
-            f"wrap_around_flag={self.wrap_around_flag}, "
-            f"overlap_flag={self.overlap_flag}, "
-            f"block_length_distribution={self.block_length_distribution})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, NonOverlappingBlockBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.block_length == other.block_length
-            and self.wrap_around_flag == other.wrap_around_flag
-            and self.overlap_flag == other.overlap_flag
-            and self.block_length_distribution
-            == other.block_length_distribution
-        )
-
 
 class BartlettsBootstrapConfig(BaseBlockBootstrapConfig):
     """Config class for BartlettBootstrap.
@@ -653,29 +484,6 @@ def __init__(
         self._bootstrap_type = "moving"
         self._tapered_weights = np.bartlett
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"bootstrap_type={self.bootstrap_type}, "
-            f"tapered_weights={self.tapered_weights})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, BartlettsBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.bootstrap_type == other.bootstrap_type
-            and self.tapered_weights == other.tapered_weights
-        )
-
 
 class HammingBootstrapConfig(BaseBlockBootstrapConfig):
     """Config class for HammingBootstrap.
@@ -712,29 +520,6 @@ def __init__(
         self._bootstrap_type = "moving"
         self._tapered_weights = np.hamming
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"bootstrap_type={self.bootstrap_type}, "
-            f"tapered_weights={self.tapered_weights})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, HammingBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.bootstrap_type == other.bootstrap_type
-            and self.tapered_weights == other.tapered_weights
-        )
-
 
 class HanningBootstrapConfig(BaseBlockBootstrapConfig):
     """Config class for HanningBootstrap.
@@ -771,29 +556,6 @@ def __init__(
         self._bootstrap_type = "moving"
         self._tapered_weights = np.hanning
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"bootstrap_type={self.bootstrap_type}, "
-            f"tapered_weights={self.tapered_weights})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, HanningBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.bootstrap_type == other.bootstrap_type
-            and self.tapered_weights == other.tapered_weights
-        )
-
 
 class BlackmanBootstrapConfig(BaseBlockBootstrapConfig):
     """Config class for BlackmanBootstrap.
@@ -830,29 +592,6 @@ def __init__(
         self._bootstrap_type = "moving"
         self._tapered_weights = np.blackman
 
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"bootstrap_type={self.bootstrap_type}, "
-            f"tapered_weights={self.tapered_weights})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, BlackmanBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.bootstrap_type == other.bootstrap_type
-            and self.tapered_weights == other.tapered_weights
-        )
-
 
 class TukeyBootstrapConfig(BaseBlockBootstrapConfig):
     """Config class for TukeyBootstrap.
@@ -889,26 +628,3 @@ def __init__(
         alpha = kwargs.get("alpha", 0.5)
         self._bootstrap_type = "moving"
         self._tapered_weights = partial(tukey, alpha=alpha)
-
-    def __repr__(self) -> str:
-        """Return repr(self)."""
-        base_repr = super().__repr__()
-        return (
-            f"{base_repr[:-1]}, "
-            f"bootstrap_type={self.bootstrap_type}, "
-            f"tapered_weights={self.tapered_weights})"
-        )
-
-    def __str__(self) -> str:
-        """Return str(self)."""
-        return self.__repr__()
-
-    def __eq__(self, other: object) -> bool:
-        """Return self == other."""
-        if not isinstance(other, TukeyBootstrapConfig):
-            return False
-        return (
-            super().__eq__(other)
-            and self.bootstrap_type == other.bootstrap_type
-            and self.tapered_weights == other.tapered_weights
-        )

src/tsbootstrap/block_length_sampler.py

@@ -37,12 +37,13 @@
 import numpy as np
 from numpy.random import Generator
 from scipy.stats import pareto, weibull_min
+from skbase.base import BaseObject
 
 from tsbootstrap.utils.types import RngTypes
 from tsbootstrap.utils.validate import validate_integers, validate_rng
 
 
-class BlockLengthSampler:
+class BlockLengthSampler(BaseObject):
     """
     A class for sampling block lengths for the random block length bootstrap.
 
@@ -174,19 +175,3 @@ def sample_block_length(self) -> int:
             self.block_length_distribution
         ](self.rng, self.avg_block_length)
         return max(round(sampled_block_length), 2)
-
-    def __repr__(self) -> str:
-        return f"BlockLengthSampler(avg_block_length={self.avg_block_length}, block_length_distribution='{self.block_length_distribution}', rng={self.rng})"
-
-    def __str__(self) -> str:
-        return f"BlockLengthSampler using avg_block_length={self.avg_block_length}, block_length_distribution='{self.block_length_distribution}', and random seed {self.rng}"
-
-    def __eq__(self, other: object) -> bool:
-        if isinstance(other, BlockLengthSampler):
-            return (
-                self.avg_block_length == other.avg_block_length
-                and self.block_length_distribution
-                == other.block_length_distribution
-                and self.rng == other.rng
-            )
-        return False