scikit-base 1.0.0__tar.gz → 1.0.2__tar.gz

{scikit_base-1.0.0/scikit_base.egg-info → scikit_base-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scikit-base
-Version: 1.0.0
+Version: 1.0.2
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -90,7 +90,7 @@ Requires-Dist: nbsphinx>=0.8.6; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: pydata-sphinx-theme; extra == "docs"
 Requires-Dist: sphinx-issues<7.0.0; extra == "docs"
-Requires-Dist: sphinx-gallery<0.21.0; extra == "docs"
+Requires-Dist: sphinx-gallery<0.22.0; extra == "docs"
 Requires-Dist: sphinx-panels; extra == "docs"
 Requires-Dist: sphinx-design<0.7.0; extra == "docs"
 Requires-Dist: Sphinx!=7.2.0,<10.0.0; extra == "docs"
@@ -115,7 +115,7 @@ Dynamic: license-file
 `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 1.0.0 is now available. Check out our
+:rocket: Version 1.0.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit_base-1.0.0 → scikit_base-1.0.2}/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 1.0.0 is now available. Check out our
+:rocket: Version 1.0.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit_base-1.0.0 → scikit_base-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scikit-base"
-version = "1.0.0"
+version = "1.0.2"
 description = "Base classes for sklearn-like parametric objects"
 authors = [
     {name = "sktime developers", email = "sktime.toolbox@gmail.com"},
@@ -71,7 +71,7 @@ docs = [
     "numpydoc",
     "pydata-sphinx-theme",
     "sphinx-issues<7.0.0",
-    "sphinx-gallery<0.21.0",
+    "sphinx-gallery<0.22.0",
     "sphinx-panels",
     "sphinx-design<0.7.0",
     "Sphinx!=7.2.0,<10.0.0",

{scikit_base-1.0.0 → scikit_base-1.0.2/scikit_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scikit-base
-Version: 1.0.0
+Version: 1.0.2
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -90,7 +90,7 @@ Requires-Dist: nbsphinx>=0.8.6; extra == "docs"
 Requires-Dist: numpydoc; extra == "docs"
 Requires-Dist: pydata-sphinx-theme; extra == "docs"
 Requires-Dist: sphinx-issues<7.0.0; extra == "docs"
-Requires-Dist: sphinx-gallery<0.21.0; extra == "docs"
+Requires-Dist: sphinx-gallery<0.22.0; extra == "docs"
 Requires-Dist: sphinx-panels; extra == "docs"
 Requires-Dist: sphinx-design<0.7.0; extra == "docs"
 Requires-Dist: Sphinx!=7.2.0,<10.0.0; extra == "docs"
@@ -115,7 +115,7 @@ Dynamic: license-file
 `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 1.0.0 is now available. Check out our
+:rocket: Version 1.0.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit_base-1.0.0 → scikit_base-1.0.2}/scikit_base.egg-info/SOURCES.txt

@@ -37,6 +37,7 @@ skbase/tests/__init__.py
 skbase/tests/conftest.py
 skbase/tests/test_base.py
 skbase/tests/test_baseestimator.py
+skbase/tests/test_deep_equals.py
 skbase/tests/test_exceptions.py
 skbase/tests/test_lookup.py
 skbase/tests/test_lookup_metaclasses.py

{scikit_base-1.0.0 → scikit_base-1.0.2}/scikit_base.egg-info/requires.txt

@@ -19,7 +19,7 @@ nbsphinx>=0.8.6
 numpydoc
 pydata-sphinx-theme
 sphinx-issues<7.0.0
-sphinx-gallery<0.21.0
+sphinx-gallery<0.22.0
 sphinx-panels
 sphinx-design<0.7.0
 Sphinx!=7.2.0,<10.0.0

{scikit_base-1.0.0 → scikit_base-1.0.2}/scikit_base.egg-info/top_level.txt

@@ -1,4 +1,3 @@
-build
 build_tools
 docs
 enhancement_proposals

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/__init__.py

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

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/base/_base.py

@@ -58,6 +58,7 @@ import re
 import warnings
 from collections import defaultdict
 from copy import deepcopy
+from inspect import isclass
 from typing import List
 
 from skbase._exceptions import NotFittedError
@@ -330,13 +331,28 @@ class BaseObject(_FlagManager):
         """
         params = {key: getattr(self, key) for key in self.get_param_names()}
 
-        if deep:
-            deep_params = {}
-            for key, value in params.items():
-                if hasattr(value, "get_params"):
-                    deep_items = value.get_params().items()
-                    deep_params.update({f"{key}__{k}": val for k, val in deep_items})
-            params.update(deep_params)
+        if not deep:
+            return params
+
+        # we know deep=True, so recurse
+        deep_params = {}
+        for key, value in params.items():
+            # Skip class objects (e.g. BaseObject subclasses stored as params);
+            # only recurse into instances with a valid get_params method.
+            if isclass(value):
+                continue
+
+            get_params = getattr(value, "get_params", None)
+            if not callable(get_params):
+                continue
+
+            sub_params = get_params()
+            if not isinstance(sub_params, dict):
+                continue
+
+            deep_params.update({f"{key}__{k}": v for k, v in sub_params.items()})
+
+        params.update(deep_params)
 
         return params
 

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/base/_pretty_printing/_object_html_repr.py

@@ -8,6 +8,7 @@
 import html
 import uuid
 from contextlib import closing
+from inspect import isclass
 from io import StringIO
 from string import Template
 
@@ -103,12 +104,12 @@ def _get_visual_block(base_object):
     elif base_object is None:
         return _VisualBlock("single", base_object, names="None", name_details="None")
 
-    # check if base_object looks like a meta base_object wraps base_object
+    # collect BaseObject instances in the first layer to display in parallel
     if hasattr(base_object, "get_params"):
         base_objects = []
         for key, value in base_object.get_params().items():
-            # Only look at the BaseObjects in the first layer
-            if "__" not in key and hasattr(value, "get_params"):
+            # Recurse to nested BaseObject instances in the first layer (not classes)
+            if "__" not in key and hasattr(value, "get_params") and not isclass(value):
                 base_objects.append(value)
         if len(base_objects):
             return _VisualBlock("parallel", base_objects, names=None)

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/base/_pretty_printing/tests/test_object_html_repr.py

@@ -32,6 +32,25 @@ class MetaObjectForHtml(BaseMetaObject):
         super().__init__()
 
 
+class ParentWithClassParam(BaseObject):
+    """BaseObject whose parameter holds a BaseObject subclass, not an instance."""
+
+    def __init__(self, nested_cls):
+        self.nested_cls = nested_cls
+        super().__init__()
+
+
+def test_html_repr_with_baseobject_class_param():
+    """HTML diagram repr must not call get_params on a BaseObject class param.
+
+    Regression test for https://github.com/sktime/skbase/issues/558
+    """
+    parent = ParentWithClassParam(nested_cls=ComponentDummy)
+    html_repr = _object_html_repr(parent)
+    assert isinstance(html_repr, str)
+    assert parent.__class__.__name__ in html_repr
+
+
 def test_meta_object_html_repr_does_not_raise():
     """Ensure HTML repr for a meta-object does not raise (regression test).
 

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/tests/test_base.py

@@ -42,6 +42,7 @@ __all__ = [
     "test_get_param_names",
     "test_get_params",
     "test_get_params_invariance",
+    "test_get_params_deep_with_baseobject_class_param",
     "test_get_params_after_set_params",
     "test_set_params",
     "test_set_params_raises_error_non_existent_param",
@@ -761,6 +762,25 @@ def test_get_params_invariance(
     assert all(item in deep_params.items() for item in shallow_params.items())
 
 
+class ParentWithClassParam(BaseObject):
+    """BaseObject whose parameter holds a BaseObject subclass, not an instance."""
+
+    def __init__(self, nested_cls):
+        self.nested_cls = nested_cls
+        super().__init__()
+
+
+def test_get_params_deep_with_baseobject_class_param():
+    """get_params(deep=True) must not recurse into BaseObject class parameters.
+
+    Regression test for https://github.com/sktime/skbase/issues/558
+    """
+    parent = ParentWithClassParam(nested_cls=Child)
+    params = parent.get_params(deep=True)
+    assert params["nested_cls"] is Child
+    assert not any(key.startswith("nested_cls__") for key in params)
+
+
 def test_get_params_after_set_params(fixture_class_parent: Type[Parent]):
     """Test that get_params returns the same thing before and after set_params.
 
@@ -1498,3 +1518,31 @@ def test_get_class_tags_diamond_inheritance():
     obj = Diamond()
     assert obj.get_tag("A", raise_error=False) == 42
     assert obj.get_tag("B", raise_error=False) == 2
+
+
+class BadGetParamsClass:
+
+    get_params = "This is not a method in order to test get_params nesting handling."
+
+
+class NestedBadGetParamsTester(BaseObject):
+    """Class for testing get_params functionality."""
+
+    clsvar = 210
+
+    def __init__(self, a, b):
+        self.a = a
+        self.b = b
+        super().__init__()
+
+
+def test_get_params_with_nested_bad_get_params():
+    """Test that get_params works when nested get_params is not method."""
+    nested_bad_get_params = BadGetParamsClass()
+    obj = NestedBadGetParamsTester(a=7, b=nested_bad_get_params)
+
+    # this should not raise an error
+    # error mode is attenpting to call get_params of nested_bad_get_params,
+    # which is a string, instead of the get_params of the parent object
+    # instead, get_params should recognize the string type and not call it
+    obj.get_params(deep=True)

scikit_base-1.0.2/skbase/tests/test_deep_equals.py

@@ -0,0 +1,35 @@
+from skbase.utils.deep_equals import deep_equals
+
+
+def test_deep_equals_numpy_string_array():
+    """Test that deep_equals works on string-dtype numpy arrays. GitHub issue #517."""
+    import numpy as np
+
+    s = np.array(["1", "2", "1"])
+    # Same arrays should be equal
+    assert deep_equals(s, s) is True
+
+    # Different arrays should not be equal
+    t = np.array(["1", "2", "3"])
+    assert deep_equals(s, t) is False
+
+
+def test_deep_equals_equal_object():
+    class DummyComposite:
+        def __init__(self, func1, func2, neq_called):
+            self.func1 = func1
+            self.func2 = func2
+            self.neq_called = neq_called
+
+    class Dummy:
+        def __init__(self, func):
+            self.func = func
+
+        def __eq__(self, other) -> DummyComposite:
+            return DummyComposite(self.func, other.func, False)
+
+        def __ne__(self, other) -> DummyComposite:
+            return DummyComposite(self.func, other.func, True)
+
+    a = Dummy(lambda x: x)
+    assert deep_equals(a, a)

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/utils/_iter.py

@@ -210,7 +210,7 @@ def make_strings_unique(str_list):
     str_count = collections.Counter(str_list)
     # if any duplicates, we append _integer of occurrence to non-uniques
     now_count: collections.Counter = collections.Counter()
-    unique_strs = str_list
+    unique_strs = list(str_list)
     for i, x in enumerate(unique_strs):
         if str_count[x] > 1:
             now_count.update([x])

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/utils/deep_equals/_deep_equals.py

@@ -142,7 +142,7 @@ def _numpy_equals_plugin(x, y, return_msg=False, deep_equals=None):
         return ret(False, f".shape, x.shape = {x.shape} != y.shape = {y.shape}")
     if x.dtype != y.dtype:
         return ret(False, f".dtype, x.dtype = {x.dtype} != y.dtype = {y.dtype}")
-    if x.dtype == "str":
+    if x.dtype == "str" or np.issubdtype(x.dtype, np.character):
         return ret(np.array_equal(x, y), ".values")
     elif x.dtype == "object":
         x_flat = x.flatten()
@@ -508,6 +508,9 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
     """
     ret = _make_ret(return_msg)
 
+    if x is y:
+        return ret(True, "")
+
     if type(x) is not type(y):
         return ret(False, f".type, x.type = {type(x)} != y.type = {type(y)}")
 

{scikit_base-1.0.0 → scikit_base-1.0.2}/skbase/utils/tests/test_iter.py

@@ -126,3 +126,20 @@ def test_make_strings_unique_output():
     # Case when input is not flat
     some_strs = ["abc_1", ("abc_2", "bcd")]
     assert make_strings_unique(some_strs) == ["abc_1", ("abc_2", "bcd")]
+
+
+def test_make_strings_unique_immutable_input():
+    """Test that make_strings_unique does not mutate its input in-place."""
+    # Test with a flat list containing duplicates
+    input_list = ["abc", "abc", "bcd"]
+    input_copy = list(input_list)
+    make_strings_unique(input_list)
+    assert input_list == input_copy, "make_strings_unique mutated its input flat list!"
+
+    # Test with a nested list structure
+    nested_list = [["abc", "abc"], "bcd"]
+    nested_copy = [["abc", "abc"], "bcd"]
+    make_strings_unique(nested_list)
+    assert (
+        nested_list == nested_copy
+    ), "make_strings_unique mutated its input nested list!"