scikit-base 0.8.2__py3-none-any.whl → 0.8.3__py3-none-any.whl

{scikit_base-0.8.2.dist-info → scikit_base-0.8.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.8.2
+Version: 0.8.3
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -59,51 +59,51 @@ Requires-Python: <3.13,>=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Provides-Extra: all_extras
-Requires-Dist: numpy ; extra == 'all_extras'
-Requires-Dist: pandas ; extra == 'all_extras'
+Requires-Dist: numpy; extra == "all-extras"
+Requires-Dist: pandas; extra == "all-extras"
 Provides-Extra: binder
-Requires-Dist: jupyter ; extra == 'binder'
+Requires-Dist: jupyter; extra == "binder"
 Provides-Extra: dev
-Requires-Dist: scikit-learn >=0.24.0 ; extra == 'dev'
-Requires-Dist: pre-commit ; extra == 'dev'
-Requires-Dist: pytest ; extra == 'dev'
-Requires-Dist: pytest-cov ; extra == 'dev'
+Requires-Dist: scikit-learn>=0.24.0; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: jupyter ; extra == 'docs'
-Requires-Dist: myst-parser ; extra == 'docs'
-Requires-Dist: nbsphinx >=0.8.6 ; extra == 'docs'
-Requires-Dist: numpydoc ; extra == 'docs'
-Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
-Requires-Dist: sphinx-issues <5.0.0 ; extra == 'docs'
-Requires-Dist: sphinx-gallery <0.18.0 ; extra == 'docs'
-Requires-Dist: sphinx-panels ; extra == 'docs'
-Requires-Dist: sphinx-design <0.7.0 ; extra == 'docs'
-Requires-Dist: Sphinx !=7.2.0,<9.0.0 ; extra == 'docs'
-Requires-Dist: tabulate ; extra == 'docs'
+Requires-Dist: jupyter; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Requires-Dist: nbsphinx>=0.8.6; extra == "docs"
+Requires-Dist: numpydoc; extra == "docs"
+Requires-Dist: pydata-sphinx-theme; extra == "docs"
+Requires-Dist: sphinx-issues<5.0.0; extra == "docs"
+Requires-Dist: sphinx-gallery<0.18.0; extra == "docs"
+Requires-Dist: sphinx-panels; extra == "docs"
+Requires-Dist: sphinx-design<0.7.0; extra == "docs"
+Requires-Dist: Sphinx!=7.2.0,<9.0.0; extra == "docs"
+Requires-Dist: tabulate; extra == "docs"
 Provides-Extra: linters
-Requires-Dist: mypy ; extra == 'linters'
-Requires-Dist: isort ; extra == 'linters'
-Requires-Dist: flake8 ; extra == 'linters'
-Requires-Dist: black ; extra == 'linters'
-Requires-Dist: pydocstyle ; extra == 'linters'
-Requires-Dist: nbqa ; extra == 'linters'
-Requires-Dist: flake8-bugbear ; extra == 'linters'
-Requires-Dist: flake8-builtins ; extra == 'linters'
-Requires-Dist: flake8-quotes ; extra == 'linters'
-Requires-Dist: flake8-comprehensions ; extra == 'linters'
-Requires-Dist: pandas-vet ; extra == 'linters'
-Requires-Dist: flake8-print ; extra == 'linters'
-Requires-Dist: pep8-naming ; extra == 'linters'
-Requires-Dist: doc8 ; extra == 'linters'
+Requires-Dist: mypy; extra == "linters"
+Requires-Dist: isort; extra == "linters"
+Requires-Dist: flake8; extra == "linters"
+Requires-Dist: black; extra == "linters"
+Requires-Dist: pydocstyle; extra == "linters"
+Requires-Dist: nbqa; extra == "linters"
+Requires-Dist: flake8-bugbear; extra == "linters"
+Requires-Dist: flake8-builtins; extra == "linters"
+Requires-Dist: flake8-quotes; extra == "linters"
+Requires-Dist: flake8-comprehensions; extra == "linters"
+Requires-Dist: pandas-vet; extra == "linters"
+Requires-Dist: flake8-print; extra == "linters"
+Requires-Dist: pep8-naming; extra == "linters"
+Requires-Dist: doc8; extra == "linters"
 Provides-Extra: test
-Requires-Dist: pytest ; extra == 'test'
-Requires-Dist: coverage ; extra == 'test'
-Requires-Dist: pytest-cov ; extra == 'test'
-Requires-Dist: safety ; extra == 'test'
-Requires-Dist: numpy ; extra == 'test'
-Requires-Dist: scipy ; extra == 'test'
-Requires-Dist: pandas ; extra == 'test'
-Requires-Dist: scikit-learn >=0.24.0 ; extra == 'test'
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: safety; extra == "test"
+Requires-Dist: numpy; extra == "test"
+Requires-Dist: scipy; extra == "test"
+Requires-Dist: pandas; extra == "test"
+Requires-Dist: scikit-learn>=0.24.0; extra == "test"
 
 <a href="https://skbase.readthedocs.io/en/latest/"><img src="https://github.com/sktime/skbase/blob/main/docs/source/images/skbase-logo-with-name.png" width="175" align="right" /></a>
 
@@ -114,7 +114,7 @@ Requires-Dist: scikit-learn >=0.24.0 ; extra == 'test'
 `skbase` provides base classes for creating scikit-learn-like parametric objects,
 along with tools to make it easier to build your own packages that follow these design patterns.
 
-:rocket: Version 0.8.2 is now available. Check out our
+:rocket: Version 0.8.3 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit_base-0.8.2.dist-info → scikit_base-0.8.3.dist-info}/RECORD

@@ -1,9 +1,9 @@
 docs/source/conf.py,sha256=kFc-4qkb0ZGD5cDej5KPJhMePp9kpVu6ZqFoF0fgovg,9951
-skbase/__init__.py,sha256=DIqf7QEkt2QDidE-9-ErW63rmELfeU2h8gu_iYsXzlY,345
+skbase/__init__.py,sha256=mmRe3GJqruvDkWloNpWs_pyuhiE4t0Pt_TrxyHnkccY,345
 skbase/_exceptions.py,sha256=KXfcVa7Xit-w-Xs_qFSJOEa_Mfp1oJeiHEC3v4Z0h1Q,1112
 skbase/_nopytest_tests.py,sha256=npL5pibSgCpulEGw0NqLKcG0majh6xcdW5A4Zibf78s,1077
 skbase/base/__init__.py,sha256=5ZLlwJeyfKDA1lAylBJgZd3t5JY25xsgQB4waQnroa8,751
-skbase/base/_base.py,sha256=Lb1Ec-IZW7v-OTKtfjFMPpS69gmGurEQ17MujOrtReY,53970
+skbase/base/_base.py,sha256=AU9gU143MADKcciC2Aso01QDuJbLOy4oxsiLkjXi8Hk,55267
 skbase/base/_meta.py,sha256=VY6_R2tE885j-GTDuzLFyho5i382jOni5lkR_ykPZqo,38815
 skbase/base/_tagmanager.py,sha256=nKoiIC1yXFFSpN5ljWbMrwA-pwlbxsljgKuUywh1MR4,7289
 skbase/base/_pretty_printing/__init__.py,sha256=bVuKnwafn8c2q2AGJ9BOu9cmu-xBjiOxHf1hxjm8K2A,492
@@ -21,7 +21,7 @@ skbase/testing/utils/__init__.py,sha256=kaLuqQwJsCunRWsUb1JwTVG-iqXbzdUobuYHNHsB
 skbase/testing/utils/_conditional_fixtures.py,sha256=QwI7K28Lsy6RAkDP94goo8uWWvMzKKNOmXRFtc9RNtI,9890
 skbase/testing/utils/inspect.py,sha256=e6F7AIuDhBTpgK8KKmiuwxeggrMjC7DHuSAKA1jOU2A,761
 skbase/tests/__init__.py,sha256=d2_OTTnt0GX5otQsBuNAb1evg8C5Fi0JjqK2VsfMtXU,37
-skbase/tests/conftest.py,sha256=dSZMtEE6cGB76iWtrHQY0iLpLFUt6Ir8xKNmzpwo0PY,9673
+skbase/tests/conftest.py,sha256=6ydu8acgnb-MydTiUi9iOvpSPUpW2HjCfp3n6necc8Y,9786
 skbase/tests/test_base.py,sha256=kIhBDcTajAvrOh_BNX8gNuwDWhhGPc-jV6qGE5JPAUk,50827
 skbase/tests/test_baseestimator.py,sha256=fuzpwxjYzyl-Vrte1va4AWdbYElhWnED8W10236Xprc,4731
 skbase/tests/test_exceptions.py,sha256=wOdk7Gp8pvbhucna3_9FxTk9xFLjC9XNsGsVabQLYEE,629
@@ -34,12 +34,13 @@ skbase/utils/_iter.py,sha256=puDa2z2DIVDsm48eycrkvkAiTEWswgs9lpxxgwes43w,7653
 skbase/utils/_nested_iter.py,sha256=omDI2Y75ajWTSV9d59iJTj1RcCk5YFbc7cZNQjz8AC8,4566
 skbase/utils/_utils.py,sha256=A6sTIUEscEy9TjBmCvXEuhk9q8ROBPyfJGhrjlSA4LY,3134
 skbase/utils/random_state.py,sha256=QxY-M2u_6my315tdml2CukKj7ZVnbqjU_T9ZzixGuq0,5127
+skbase/utils/stderr_mute.py,sha256=VGMAjYgEjl-T-cFEzGJp_ry2iNR8wYLKL9SDhT8OZ7s,2046
 skbase/utils/stdout_mute.py,sha256=XeeNst0oN2D77x85N0pQsBv_iYj6gtlliNS7WadwypQ,2046
 skbase/utils/deep_equals/__init__.py,sha256=1II3GWV1c1s43y62IidMiTjjyOnE9MFysQ5AKCXMB2g,235
 skbase/utils/deep_equals/_common.py,sha256=O0ODPJGwdq6G-KdeGoHgyote53tNcxu3y2jHvej3bdQ,1273
 skbase/utils/deep_equals/_deep_equals.py,sha256=DT6nE0p1IGsLb82h3JJu24_nWeNE2HI46eL2qPlqxbo,19151
 skbase/utils/dependencies/__init__.py,sha256=cCUa_P-RiDs4pW6cw51uYeoBMaMa9iycwiFkwqkIizc,419
-skbase/utils/dependencies/_dependencies.py,sha256=GRDKuzVqyo1SFRMOyHntYOMMKGr3vJ5414jJjtH3dao,21182
+skbase/utils/dependencies/_dependencies.py,sha256=TIzo9lNM4tbgU6Sn4CYCyr63nYxfIvxh_o4VMm6qPw8,21694
 skbase/utils/dependencies/tests/__init__.py,sha256=UqE6wenG-HffjT2Z974OLzmXG-M8PNOP9nUnNfqtfT4,74
 skbase/utils/dependencies/tests/test_check_dependencies.py,sha256=uxAC3gr4VWTlgctN90pnT1ra_UYkPxQHEla-IljX-n0,2238
 skbase/utils/tests/__init__.py,sha256=YfvP5lpCrTC_6SIakU7jBBdqYyuqE07nZ56ZYKTs3f0,165
@@ -48,6 +49,7 @@ skbase/utils/tests/test_deep_equals.py,sha256=kYR-wRvc_GGdlCwZPPlUL1NvUzJKIvpWTa
 skbase/utils/tests/test_iter.py,sha256=XIJPZ3QjVR5szj5oNS9DBwum6WXRGHSAiC0O9MW4maY,4918
 skbase/utils/tests/test_nested_iter.py,sha256=lZF9jiU_6xw1dOo2QrrVF96Pw8ThutQuVlRspIgNy80,2230
 skbase/utils/tests/test_random_state.py,sha256=XW1KIFy2S-MQjlx4lUdP8K-w1N9eEUWa7PP_Yve7d78,3934
+skbase/utils/tests/test_std_mute.py,sha256=owdd3BhzIw4t5NftNLFSfG8oAa7t_BZ2o5mqx5TmiTI,939
 skbase/utils/tests/test_utils.py,sha256=LJCQHn8a4uW38Tm-z4uMQDSlyvg8tolT77GsaLp2hJo,1182
 skbase/validate/__init__.py,sha256=76hnzzoLYhyGXh8mEtQeLjQnP8ZztMaWtvLB3VeOHF8,676
 skbase/validate/_named_objects.py,sha256=mWco9seUhAWbfsvW2yd6NGqDF7jCC-BV7EEakmWLZkU,12957
@@ -55,9 +57,9 @@ skbase/validate/_types.py,sha256=riVEVlj8ipErZX07OVbzv6zdGKssfegHyMr8XwaBm6M,121
 skbase/validate/tests/__init__.py,sha256=wunQBy6rajyrDymKvuFVajsBjj90VP5IFey5b6ZIRCk,70
 skbase/validate/tests/test_iterable_named_objects.py,sha256=NaEwdmtQJJy4GXMSh9ULOaR4ua7R11BcE6Khz5RKWUk,7438
 skbase/validate/tests/test_type_validations.py,sha256=oIysbDxRlbBMcCOrDMW6MM6VqhhMWJxNP6NO9Id9Q5g,14133
-scikit_base-0.8.2.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
-scikit_base-0.8.2.dist-info/METADATA,sha256=8kQ1XizgepOCLIkY1WdFrBLJl6ShYR5_pm_Pqr1tyW0,8529
-scikit_base-0.8.2.dist-info/WHEEL,sha256=R0nc6qTxuoLk7ShA2_Y-UWkN8ZdfDBG2B6Eqpz2WXbs,91
-scikit_base-0.8.2.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
-scikit_base-0.8.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-scikit_base-0.8.2.dist-info/RECORD,,
+scikit_base-0.8.3.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
+scikit_base-0.8.3.dist-info/METADATA,sha256=zxhd9HCe6P1iVsdY-qMN-jF-LNz8gOOWtPpiiP_kAZw,8482
+scikit_base-0.8.3.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+scikit_base-0.8.3.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
+scikit_base-0.8.3.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+scikit_base-0.8.3.dist-info/RECORD,,

{scikit_base-0.8.2.dist-info → scikit_base-0.8.3.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (72.1.0)
+Generator: setuptools (73.0.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

skbase/__init__.py

@@ -6,4 +6,4 @@
 The included functionality makes it easy to reuse scikit-learn and
 sktime design principles in your project.
 """
-__version__: str = "0.8.2"
+__version__: str = "0.8.3"

skbase/base/_base.py

@@ -1292,10 +1292,47 @@ class BaseEstimator(BaseObject):
         fitted_params = [
             attr for attr in dir(obj) if attr.endswith("_") and not attr.startswith("_")
         ]
-        # remove the "_" at the end
-        fitted_param_dict = {
-            p[:-1]: getattr(obj, p) for p in fitted_params if hasattr(obj, p)
-        }
+
+        def getattr_safe(obj, attr):
+            """Get attribute of object, safely.
+
+            Safe version of getattr, that returns None if attribute does not exist,
+            or if an exception is raised during getattr.
+            Also returns a boolean indicating whether the attribute was successfully
+            retrieved, to distinguish between None value and non-existent attribute,
+            or exception during getattr.
+
+            Parameters
+            ----------
+            obj : any object
+                object to get attribute from
+            attr : str
+                attribute name to get from obj
+
+            Returns
+            -------
+            attr : Any
+                attribute of obj, if it exists and does not raise on getattr;
+                otherwise None
+            success : bool
+                whether the attribute was successfully retrieved
+            """
+            try:
+                if hasattr(obj, attr):
+                    attr = getattr(obj, attr)
+                    return attr, True
+                else:
+                    return None, False
+            except Exception:
+                return None, False
+
+        fitted_param_dict = {}
+
+        for p in fitted_params:
+            attr, success = getattr_safe(obj, p)
+            if success:
+                p_name = p[:-1]  # remove the "_" at the end to get the parameter name
+                fitted_param_dict[p_name] = attr
 
         return fitted_param_dict
 

skbase/tests/conftest.py

@@ -54,6 +54,7 @@ SKBASE_MODULES = (
     "skbase.utils.dependencies",
     "skbase.utils.dependencies._dependencies",
     "skbase.utils.random_state",
+    "skbase.utils.stderr_mute",
     "skbase.utils.stdout_mute",
     "skbase.validate",
     "skbase.validate._named_objects",
@@ -80,6 +81,7 @@ SKBASE_PUBLIC_MODULES = (
     "skbase.utils.deep_equals",
     "skbase.utils.dependencies",
     "skbase.utils.random_state",
+    "skbase.utils.stderr_mute",
     "skbase.utils.stdout_mute",
     "skbase.validate",
 )
@@ -108,6 +110,7 @@ SKBASE_PUBLIC_CLASSES_BY_MODULE = {
         "QuickTester",
         "TestAllObjects",
     ),
+    "skbase.utils.stderr_mute": ("StderrMute",),
     "skbase.utils.stdout_mute": ("StdoutMute",),
 }
 SKBASE_CLASSES_BY_MODULE = SKBASE_PUBLIC_CLASSES_BY_MODULE.copy()

skbase/utils/dependencies/_dependencies.py

@@ -3,7 +3,6 @@
 import sys
 import warnings
 from functools import lru_cache
-from importlib.metadata import distributions
 from inspect import isclass
 
 from packaging.markers import InvalidMarker, Marker
@@ -186,9 +185,19 @@ def _get_installed_packages_private():
     Same as _get_installed_packages, but internal to avoid mutating the lru_cache
     by accident.
     """
+    from importlib.metadata import distributions, version
+
     dists = distributions()
-    packages = {dist.metadata["Name"]: dist.version for dist in dists}
-    return packages
+    package_names = {dist.metadata["Name"] for dist in dists}
+    package_versions = {pkg_name: version(pkg_name) for pkg_name in package_names}
+    # developer note:
+    # we cannot just use distributions naively,
+    # because the same top level package name may appear *twice*,
+    # e.g., in a situation where a virtual env overrides a base env,
+    # such as in deployment environments like databricks.
+    # the "version" contract ensures we always get the version that corresponds
+    # to the importable distribution, i.e., the top one in the sys.path.
+    return package_versions
 
 
 def _get_installed_packages():

skbase/utils/stderr_mute.py

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+"""Context manager to suppress stderr."""
+
+__author__ = ["XinyuWu"]
+
+import io
+import sys
+
+
+class StderrMute:
+    """A context manager to suppress stderr.
+
+    Exception handling on exit can be customized by overriding
+    the ``_handle_exit_exceptions`` method.
+
+    Parameters
+    ----------
+    active : bool, default=True
+        Whether to suppress stderr or not.
+        If True, stderr is suppressed.
+        If False, stderr is not suppressed, and the context manager does nothing
+        except catch and suppress ModuleNotFoundError.
+    """
+
+    def __init__(self, active=True):
+        self.active = active
+
+    def __enter__(self):
+        """Context manager entry point."""
+        # capture stderr if active
+        # store the original stderr so it can be restored in __exit__
+        if self.active:
+            self._stderr = sys.stderr
+            sys.stderr = io.StringIO()
+
+    def __exit__(self, type, value, traceback):  # noqa: A002
+        """Context manager exit point."""
+        # restore stderr if active
+        # if not active, nothing needs to be done, since stderr was not replaced
+        if self.active:
+            sys.stderr = self._stderr
+
+        if type is not None:
+            return self._handle_exit_exceptions(type, value, traceback)
+
+        # if no exception was raised, return True to indicate successful exit
+        # return statement not needed as type was None, but included for clarity
+        return True
+
+    def _handle_exit_exceptions(self, type, value, traceback):  # noqa: A002
+        """Handle exceptions raised during __exit__.
+
+        Parameters
+        ----------
+        type : type
+            The type of the exception raised.
+            Known to be not-None and Exception subtype when this method is called.
+        value : Exception
+            The exception instance raised.
+        traceback : traceback
+            The traceback object associated with the exception.
+        """
+        # by default, all exceptions are raised
+        return False

skbase/utils/tests/test_std_mute.py

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
+"""Tests of stdout_mute and stderr_mute."""
+import io
+import sys
+from contextlib import redirect_stderr, redirect_stdout
+
+import pytest
+
+from skbase.utils.stderr_mute import StderrMute
+from skbase.utils.stdout_mute import StdoutMute
+
+__author__ = ["XinyuWu"]
+
+
+@pytest.mark.parametrize(
+    "mute, expected", [(True, ["", ""]), (False, ["test stdout", "test sterr"])]
+)
+def test_std_mute(mute, expected):
+    """Test StderrMute."""
+    stderr_io = io.StringIO()
+    stdout_io = io.StringIO()
+
+    try:
+        with redirect_stderr(stderr_io), redirect_stdout(stdout_io):
+            with StderrMute(mute), StdoutMute(mute):
+                sys.stdout.write("test stdout")
+                sys.stderr.write("test sterr")
+                1 / 0
+    except ZeroDivisionError:
+        assert expected == [stdout_io.getvalue(), stderr_io.getvalue()]