scikit-base 0.8.2__tar.gz → 0.8.3__tar.gz

{scikit_base-0.8.2/scikit_base.egg-info → scikit_base-0.8.3}/PKG-INFO

@@ -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
@@ -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 → scikit_base-0.8.3}/README.md

@@ -7,7 +7,7 @@
 `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 → scikit_base-0.8.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scikit-base"
-version = "0.8.2"
+version = "0.8.3"
 description = "Base classes for sklearn-like parametric objects"
 authors = [
     {name = "sktime developers", email = "sktime.toolbox@gmail.com"},

{scikit_base-0.8.2 → scikit_base-0.8.3/scikit_base.egg-info}/PKG-INFO

@@ -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
@@ -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 → scikit_base-0.8.3}/scikit_base.egg-info/SOURCES.txt

@@ -44,6 +44,7 @@ skbase/utils/_iter.py
 skbase/utils/_nested_iter.py
 skbase/utils/_utils.py
 skbase/utils/random_state.py
+skbase/utils/stderr_mute.py
 skbase/utils/stdout_mute.py
 skbase/utils/deep_equals/__init__.py
 skbase/utils/deep_equals/_common.py
@@ -58,6 +59,7 @@ skbase/utils/tests/test_deep_equals.py
 skbase/utils/tests/test_iter.py
 skbase/utils/tests/test_nested_iter.py
 skbase/utils/tests/test_random_state.py
+skbase/utils/tests/test_std_mute.py
 skbase/utils/tests/test_utils.py
 skbase/validate/__init__.py
 skbase/validate/_named_objects.py

{scikit_base-0.8.2 → scikit_base-0.8.3}/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"

{scikit_base-0.8.2 → scikit_base-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
 

{scikit_base-0.8.2 → scikit_base-0.8.3}/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()

{scikit_base-0.8.2 → scikit_base-0.8.3}/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():

scikit_base-0.8.3/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

scikit_base-0.8.3/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()]