scikit-base 0.6.1__tar.gz → 0.7.0__tar.gz

{scikit-base-0.6.1/scikit_base.egg-info → scikit-base-0.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.6.1
+Version: 0.7.0
 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<4.0.0; extra == "docs"
-Requires-Dist: sphinx-gallery<0.15.0; extra == "docs"
+Requires-Dist: sphinx-gallery<0.16.0; extra == "docs"
 Requires-Dist: sphinx-panels; extra == "docs"
 Requires-Dist: sphinx-design<0.6.0; extra == "docs"
 Requires-Dist: Sphinx!=7.2.0,<8.0.0; extra == "docs"
@@ -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.6.1 is now available. Check out our
+:rocket: Version 0.6.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

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

{scikit-base-0.6.1 → scikit-base-0.7.0}/docs/source/conf.py

@@ -270,7 +270,7 @@ nbsphinx_execute = "never"  # always  # whether to run notebooks
 nbsphinx_allow_errors = False  # False
 nbsphinx_timeout = 600  # seconds, set to -1 to disable timeout
 
-# add Binder launch buttom at the top
+# add Binder launch button at the top
 current_file = "{{ env.doc2path( env.docname, base=None) }}"
 
 # make sure Binder points to latest stable release, not main

{scikit-base-0.6.1 → scikit-base-0.7.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "scikit-base"
-version = "0.6.1"
+version = "0.7.0"
 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<4.0.0",
-    "sphinx-gallery<0.15.0",
+    "sphinx-gallery<0.16.0",
     "sphinx-panels",
     "sphinx-design<0.6.0",
     "Sphinx<8.0.0,!=7.2.0",

{scikit-base-0.6.1 → scikit-base-0.7.0/scikit_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.6.1
+Version: 0.7.0
 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<4.0.0; extra == "docs"
-Requires-Dist: sphinx-gallery<0.15.0; extra == "docs"
+Requires-Dist: sphinx-gallery<0.16.0; extra == "docs"
 Requires-Dist: sphinx-panels; extra == "docs"
 Requires-Dist: sphinx-design<0.6.0; extra == "docs"
 Requires-Dist: Sphinx!=7.2.0,<8.0.0; extra == "docs"
@@ -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.6.1 is now available. Check out our
+:rocket: Version 0.6.2 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit-base-0.6.1 → scikit-base-0.7.0}/scikit_base.egg-info/requires.txt

@@ -19,7 +19,7 @@ nbsphinx>=0.8.6
 numpydoc
 pydata-sphinx-theme
 sphinx-issues<4.0.0
-sphinx-gallery<0.15.0
+sphinx-gallery<0.16.0
 sphinx-panels
 sphinx-design<0.6.0
 Sphinx!=7.2.0,<8.0.0

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/__init__.py

@@ -3,7 +3,7 @@
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 """:mod:`skbase` contains tools for creating and working with parametric objects.
 
-The included functionality makes it easy to re-use scikit-learn and
+The included functionality makes it easy to reuse scikit-learn and
 sktime design principles in your project.
 """
-__version__: str = "0.6.1"
+__version__: str = "0.7.0"

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/_exceptions.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-# NotFittedError re-use code developed in scikit-learn. These elements
+# NotFittedError reuse code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
 """Custom exceptions used in ``skbase``."""

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/base/__init__.py

@@ -3,7 +3,7 @@
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 """:mod:`skbase.base` contains base classes for creating parametric objects.
 
-The included functionality makes it easy to re-use scikit-learn and
+The included functionality makes it easy to reuse scikit-learn and
 sktime design principles in your project.
 """
 from typing import List

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/base/_base.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-# Elements of BaseObject re-use code developed in scikit-learn. These elements
+# Elements of BaseObject reuse code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
 """Base class template for objects and fittable objects.
@@ -77,6 +77,7 @@ class BaseObject(_FlagManager):
         "display": "diagram",
         "print_changed_only": True,
         "check_clone": False,  # whether to execute validity checks in clone
+        "clone_config": True,  # clone config values (True) or use defaults (False)
     }
 
     def __init__(self):
@@ -127,6 +128,7 @@ class BaseObject(_FlagManager):
         """
         # retrieve parameters to copy them later
         params = self.get_params(deep=False)
+        config = self.get_config()
 
         # delete all object attributes in self
         attrs = [attr for attr in dir(self) if "__" not in attr]
@@ -137,6 +139,7 @@ class BaseObject(_FlagManager):
 
         # run init with a copy of parameters self had at the start
         self.__init__(**params)
+        self.set_config(**config)
 
         return self
 
@@ -157,6 +160,9 @@ class BaseObject(_FlagManager):
         self_params = self.get_params(deep=False)
         self_clone = self._clone(self)
 
+        if self.get_config()["clone_config"]:
+            self_clone.set_config(**self.get_config())
+
         # if checking the clone is turned off, return now
         if not self.get_config()["check_clone"]:
             return self_clone
@@ -258,7 +264,7 @@ class BaseObject(_FlagManager):
 
     @classmethod
     def _get_init_signature(cls):
-        """Get class init sigature.
+        """Get class init signature.
 
         Useful in parameter inspection.
 
@@ -597,7 +603,7 @@ class BaseObject(_FlagManager):
 
         Notes
         -----
-        Changes object state by settting tag values in tag_dict as dynamic tags in self.
+        Changes object state by setting tag values in tag_dict as dynamic tags in self.
         """
         self._set_flags(flag_attr_name="_tags", **tag_dict)
 
@@ -1097,7 +1103,7 @@ class TagAliaserMixin:
 
         Notes
         -----
-        Changes object state by settting tag values in tag_dict as dynamic tags
+        Changes object state by setting tag values in tag_dict as dynamic tags
         in self.
         """
         self._deprecate_tag_warn(tag_dict.keys())

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/base/_meta.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python3 -u
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-# BaseMetaObject and BaseMetaEstimator re-use code developed in scikit-learn and sktime.
+# BaseMetaObject and BaseMetaEstimator reuse code developed in scikit-learn and sktime.
 # These elements are copyrighted by the respective
 # scikit-learn developers (BSD-3-Clause License) and sktime (BSD-3-Clause) developers.
 # For conditions see licensing:
@@ -335,7 +335,7 @@ class _MetaObjectMixin:
             Named object tuple.
 
             - If `obj` was an object then returns (obj.__class__.__name__, obj).
-            - If `obj` was aleady a (name, object) tuple it is returned (a copy
+            - If `obj` was already a (name, object) tuple it is returned (a copy
               is returned if ``clone=True``).
         """
         if isinstance(obj, tuple) and len(obj) >= 2:
@@ -567,7 +567,7 @@ class _MetaObjectMixin:
         Parameters
         ----------
         other : BaseObject subclass
-            An object inheritting from `composite_class` or `base_class`, otherwise
+            An object inheriting from `composite_class` or `base_class`, otherwise
             `NotImplemented` is returned.
         base_class : BaseObject subclass
             Class assumed as base class for self and `other`. ,

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/base/_pretty_printing/_object_html_repr.py

@@ -346,7 +346,7 @@ def _object_html_repr(base_object):
     Parameters
     ----------
     base_object : base object
-        The BaseObject or inheritting class to visualize.
+        The BaseObject or inheriting class to visualize.
 
     Returns
     -------

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/base/_tagmanager.py

@@ -165,7 +165,7 @@ class _FlagManager:
 
         Notes
         -----
-        Changes object state by settting flag values in flag_dict as dynamic flags
+        Changes object state by setting flag values in flag_dict as dynamic flags
         in self.
         """
         flag_update = deepcopy(flag_dict)

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/lookup/_lookup.py

@@ -115,8 +115,8 @@ def _is_ignored_module(
     returned for `module_name`-s `"bar.foo"`, `"foo"`, `"foo.bar"`,
     `"bar.foo.bar"`, etc.
 
-    Paramters
-    ---------
+    Parameters
+    ----------
     module_name : str
         Name of the module.
     modules_to_ignore : str, list[str] or tuple[str]
@@ -304,7 +304,7 @@ def _import_module(
             loader.exec_module(imported_mod)
         exc = None
     except Exception as e:
-        # we store the exception so we can restore the stdout fisrt
+        # we store the exception so we can restore the stdout first
         exc = e
 
     # if we set up a text trap, restore it to the initial value
@@ -590,7 +590,7 @@ def get_package_metadata(
         following key:value pairs:
 
         - "path": str path to the submodule.
-        - "name": str name of hte submodule.
+        - "name": str name of the submodule.
         - "classes": dictionary with submodule's class names (keys) mapped to
           dictionaries with metadata about the class.
         - "functions": dictionary with function names (keys) mapped to
@@ -700,7 +700,7 @@ def all_objects(
 ):
     """Get a list of all objects in a package with name `package_name`.
 
-    This function crawls the package/module to retreive all classes
+    This function crawls the package/module to retrieve all classes
     that are descendents of BaseObject. By default it does this for the `skbase`
     package, but users can specify `package_name` or `path` to another project
     and `all_objects` will crawl and retrieve BaseObjects found in that project.

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/lookup/tests/test_lookup.py

@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
 """Tests for skbase lookup functionality."""
-# Elements of the lookup tests re-use code developed in sktime. These elements
+# Elements of the lookup tests reuse code developed in sktime. These elements
 # are copyrighted by the sktime developers, BSD-3-Clause License. For
 # conditions see https://github.com/sktime/sktime/blob/main/LICENSE
 import importlib
@@ -158,7 +158,7 @@ def _check_package_metadata_result(results):
             isinstance(mod_metadata[k], str) for k in ("path", "name", "authors")
         ):
             return False
-        # Verify keys with bool values have bool valeus
+        # Verify keys with bool values have bool values
         if not all(
             isinstance(mod_metadata[k], bool)
             for k in (
@@ -309,7 +309,7 @@ def test_check_package_metadata_result(fixture_sample_package_metadata):
 
 
 def test_is_non_public_module(mod_names):
-    """Test _is_non_public_module correctly indentifies non-public modules."""
+    """Test _is_non_public_module correctly identifies non-public modules."""
     for mod in mod_names["public"]:
         assert _is_non_public_module(mod) is False
     for mod in mod_names["non_public"]:
@@ -328,7 +328,7 @@ def test_is_ignored_module(mod_names):
     for mod in mod_names["public"]:
         assert _is_ignored_module(mod) is False
 
-    # No modules should be flagged as ignored if the ignored moduels aren't encountered
+    # No modules should be flagged as ignored if the ignored modules aren't encountered
     modules_to_ignore = ("a_module_not_encountered",)
     for mod in mod_names["public"]:
         assert _is_ignored_module(mod, modules_to_ignore=modules_to_ignore) is False
@@ -355,7 +355,7 @@ def test_filter_by_class():
     # Test case when no class filter is applied (should always return True)
     assert _filter_by_class(CompositionDummy) is True
 
-    # Test case where a signle filter is applied
+    # Test case where a single filter is applied
     assert _filter_by_class(Parent, BaseObject) is True
     assert _filter_by_class(NotABaseObject, BaseObject) is False
     assert _filter_by_class(NotABaseObject, CompositionDummy) is False
@@ -391,7 +391,7 @@ def test_filter_by_tags():
     assert _filter_by_tags(Parent, {"A": "1", "B": 2}) is True
     # All keys in dict are in tag_filter, but at least 1 value doesn't match
     assert _filter_by_tags(Parent, {"A": 1, "B": 2}) is False
-    # Atleast 1 key in dict is not in tag_filter
+    # At least 1 key in dict is not in tag_filter
     assert _filter_by_tags(Parent, {"E": 1, "B": 2}) is False
 
     # Iterable tags should be all strings
@@ -413,7 +413,7 @@ def test_walk_returns_expected_format(fixture_skbase_root_path):
     def _test_walk_return(p):
         assert (
             isinstance(p, tuple) and len(p) == 3
-        ), "_walk shoul return tuple of length 3"
+        ), "_walk should return tuple of length 3"
         assert (
             isinstance(p[0], str)
             and isinstance(p[1], bool)
@@ -834,7 +834,7 @@ def test_get_return_tags():
 
 @pytest.mark.parametrize("as_dataframe", [True, False])
 @pytest.mark.parametrize("return_names", [True, False])
-@pytest.mark.parametrize("return_tags", [None, "A", ["A", "a_non_existant_tag"]])
+@pytest.mark.parametrize("return_tags", [None, "A", ["A", "a_non_existent_tag"]])
 @pytest.mark.parametrize("modules_to_ignore", ["tests", ("testing", "lookup"), None])
 @pytest.mark.parametrize("exclude_objects", [None, "Child", ["CompositionDummy"]])
 @pytest.mark.parametrize("suppress_import_stdout", [True, False])

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/tests/mock_package/test_mock_package.py

@@ -52,7 +52,7 @@ class InheritsFromBaseObject(BaseObject):
 
 
 class AnotherClass(BaseObject):
-    """Another class inheritting from BaseObject."""
+    """Another class inheriting from BaseObject."""
 
 
 class NotABaseObject:
@@ -63,7 +63,7 @@ class NotABaseObject:
 
 
 class _NonPublicClass(BaseObject):
-    """A nonpublic class inheritting from BaseObject."""
+    """A nonpublic class inheriting from BaseObject."""
 
 
 MOCK_PACKAGE_OBJECTS = [

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/tests/test_base.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-# Elements of these tests re-use code developed in scikit-learn. These elements
+# Elements of these tests reuse code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
 """Tests for BaseObject universal base class.
@@ -829,13 +829,13 @@ def test_set_params_raises_error_non_existent_param(
     # non-existing parameter in svc
     with pytest.raises(ValueError):
         fixture_class_parent_instance.set_params(
-            non_existant_param="updated param value"
+            non_existent_param="updated param value"
         )
 
     # non-existing parameter of composite
     composite = fixture_composition_dummy(foo=fixture_class_parent_instance, bar=84)
     with pytest.raises(ValueError):
-        composite.set_params(foo__non_existant_param=True)
+        composite.set_params(foo__non_existent_param=True)
 
 
 def test_set_params_raises_error_non_interface_composite(
@@ -931,6 +931,41 @@ def test_clone_raises_error_for_nonconforming_objects(
     #     obj_that_modifies.clone()
 
 
+@pytest.mark.parametrize("clone_config", [True, False])
+def test_config_after_clone_tags(clone_config):
+    """Test clone also clones config works as expected."""
+
+    class TestClass(BaseObject):
+        _tags = {"some_tag": True, "another_tag": 37}
+        _config = {"check_clone": 0}
+
+    test_obj = TestClass()
+    test_obj.set_config(**{"check_clone": 42, "foo": "bar"})
+
+    if not clone_config:
+        # if clone_config config is set to False:
+        # config key check_clone should be default, 0
+        # the new config key foo should not be present
+        test_obj.set_config(**{"clone_config": False})
+        expected = 0
+    else:
+        # if clone_config config is set to True:
+        # config key check_clone should be 42, as set above
+        # the new config key foo should be present, as it has non default
+        expected = 42
+
+    test_obj_clone = test_obj.clone()
+
+    assert "check_clone" in test_obj_clone.get_config().keys()
+    assert test_obj_clone.get_config()["check_clone"] == expected
+
+    if clone_config:
+        assert "foo" in test_obj_clone.get_config().keys()
+        assert test_obj_clone.get_config()["foo"] == "bar"
+    else:
+        assert "foo" not in test_obj_clone.get_config().keys()
+
+
 @pytest.mark.skipif(
     not _check_soft_dependencies("sklearn", severity="none"),
     reason="skip test if sklearn is not available",
@@ -1203,7 +1238,7 @@ def test_has_implementation_of(
     """Test _has_implementation_of detects methods in class with overrides in mro."""
     # When the class overrides a parent classes method should return True
     assert fixture_class_child_instance._has_implementation_of("some_method")
-    # When class implements method first time it shoudl return False
+    # When class implements method first time it should return False
     assert not fixture_class_child_instance._has_implementation_of("some_other_method")
 
     # If the method is defined the first time in the parent class it should not
@@ -1297,3 +1332,37 @@ def test_eq_dunder():
     assert composite == composite_2
     assert composite != composite_3
     assert composite_2 != composite_3
+
+
+def test_get_set_config():
+    """Tests get_config and set_config methods."""
+
+    class _TestConfig(BaseObject):
+        _config = {"foo_config": 42, "bar": "a"}
+
+        clsvar = 210
+
+        def __init__(self, a, b=42):
+            self.a = a
+            self.b = b
+            self.c = 84
+
+    test_obj = _TestConfig(7)
+
+    expected_config_orig = BaseObject._config.copy()
+    expected_config_orig.update({"foo_config": 42, "bar": "a"})
+
+    # Test get_config
+    assert test_obj.get_config() == expected_config_orig
+
+    expected_config = BaseObject._config.copy()
+    expected_config.update({"foo_config": 37, "bar": "a"})
+
+    # Test set_config
+    test_obj.set_config(foo_config=37)
+
+    assert test_obj.get_config() == expected_config
+
+    # test that reset does not reset config
+    test_obj.reset()
+    assert test_obj.get_config() == expected_config

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/tests/test_baseestimator.py

@@ -6,7 +6,7 @@ tests in this module:
 
     test_baseestimator_inheritance - Test BaseEstimator inherits from BaseObject.
     test_has_is_fitted - Test that BaseEstimator has is_fitted interface.
-    test_has_check_is_fitted - Test that BaseEstimator has check_is_fitted inteface.
+    test_has_check_is_fitted - Test that BaseEstimator has check_is_fitted interface.
     test_is_fitted  - Test that is_fitted property returns _is_fitted as expected.
     test_check_is_fitted_raises_error_when_unfitted - Test check_is_fitted raises error.
 """

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/tests/test_meta.py

@@ -66,7 +66,7 @@ def fixture_meta_estimator():
     return MetaEstimatorTester()
 
 
-def test_is_composit_returns_true(fixture_meta_object, fixture_meta_estimator):
+def test_is_composite_returns_true(fixture_meta_object, fixture_meta_estimator):
     """Test that `is_composite` method returns True."""
     msg = "`is_composite` should always be True for subclasses of "
     assert fixture_meta_object.is_composite() is True, msg + "`BaseMetaObject`."

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/utils/_check.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-# Elements of _is_scalar_nan re-use code developed in scikit-learn. These elements
+# Elements of _is_scalar_nan reuse code developed in scikit-learn. These elements
 # are copyrighted by the scikit-learn developers, BSD-3-Clause License. For
 # conditions see https://github.com/scikit-learn/scikit-learn/blob/main/COPYING
 

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/utils/_iter.py

@@ -90,7 +90,7 @@ def _format_seq_to_str(
     last_sep: Optional[str] = None,
     remove_type_text: bool = True,
 ) -> str:
-    """Format a sequence to a string of delimitted elements.
+    """Format a sequence to a string of delimited elements.
 
     This is useful to format sequences into a pretty printing format for
     creating error messages or warnings.

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/utils/deep_equals/_deep_equals.py

@@ -7,12 +7,11 @@ Objects compared can have one of the following valid types:
     lists, tuples, or dicts of a valid type (recursive)
 """
 from inspect import isclass, signature
-from typing import List
 
 from skbase.utils.deep_equals._common import _make_ret
 
-__author__: List[str] = ["fkiraly"]
-__all__: List[str] = ["deep_equals"]
+__author__ = ["fkiraly"]
+__all__ = ["deep_equals"]
 
 
 # flag variables for available soft dependencies
@@ -96,8 +95,9 @@ def _is_pandas(x):
 
 
 def _is_npndarray(x):
-    clstr = type(x).__name__
-    return clstr == "ndarray"
+    import numpy as np
+
+    return isinstance(x, np.ndarray)
 
 
 def _is_npnan(x):
@@ -150,6 +150,7 @@ def _pandas_equals_plugin(x, y, return_msg=False, deep_equals=None):
 
 
 def _pandas_equals(x, y, return_msg=False, deep_equals=None):
+    import numpy as np  # pandas depends on numpy, so this import is fine
     import pandas as pd
 
     ret = _make_ret(return_msg)
@@ -173,13 +174,68 @@ def _pandas_equals(x, y, return_msg=False, deep_equals=None):
         else:
             return ret(x.equals(y), ".series_equals, x = {} != y = {}", [x, y])
     elif isinstance(x, pd.DataFrame):
+        # check column names for equality
         if not x.columns.equals(y.columns):
             return ret(
-                False,
-                ".columns, x.columns = {} != y.columns = {}",
-                [x.columns, y.columns],
+                False, f".columns, x.columns = {x.columns} != y.columns = {y.columns}"
             )
         # if columns are equal and at least one is object, recurse over Series
+        # check dtypes for equality
+        if not x.dtypes.equals(y.dtypes):
+            return ret(
+                False, f".dtypes, x.dtypes = {x.dtypes} != y.dtypes = {y.dtypes}"
+            )
+        # check index for equality
+        # we are not recursing due to ambiguity in integer index types
+        # which may differ from pandas version to pandas version
+        # and would upset the type check, e.g., RangeIndex(2) vs Index([0, 1])
+        xix = x.index
+        yix = y.index
+        if hasattr(xix, "dtype") and hasattr(xix, "dtype"):
+            if not xix.dtype == yix.dtype:
+                return ret(
+                    False,
+                    ".index.dtype, x.index.dtype = {} != y.index.dtype = {}",
+                    [xix.dtype, yix.dtype],
+                )
+        if hasattr(xix, "dtypes") and hasattr(yix, "dtypes"):
+            if not x.dtypes.equals(y.dtypes):
+                return ret(
+                    False,
+                    ".index.dtypes, x.dtypes = {} != y.index.dtypes = {}",
+                    [xix.dtypes, yix.dtypes],
+                )
+        ix_eq = xix.equals(yix)
+        if not ix_eq:
+            if not len(xix) == len(yix):
+                return ret(
+                    False,
+                    ".index.len, x.index.len = {} != y.index.len = {}",
+                    [len(xix), len(yix)],
+                )
+            if hasattr(xix, "name") and hasattr(yix, "name"):
+                if not xix.name == yix.name:
+                    return ret(
+                        False,
+                        ".index.name, x.index.name = {} != y.index.name = {}",
+                        [xix.name, yix.name],
+                    )
+            if hasattr(xix, "names") and hasattr(yix, "names"):
+                if not len(xix.names) == len(yix.names):
+                    return ret(
+                        False,
+                        ".index.names, x.index.names = {} != y.index.name = {}",
+                        [xix.names, yix.names],
+                    )
+                if not np.all(xix.names == yix.names):
+                    return ret(
+                        False,
+                        ".index.names, x.index.names = {} != y.index.name = {}",
+                        [xix.names, yix.names],
+                    )
+            elts_eq = np.all(xix == yix)
+            return ret(elts_eq, ".index.equals, x = {} != y = {}", [xix, yix])
+        # if columns, dtypes are equal and at least one is object, recurse over Series
         if sum(x.dtypes == "object") > 0:
             for c in x.columns:
                 is_equal, msg = deep_equals(x[c], y[c], return_msg=True)
@@ -189,7 +245,14 @@ def _pandas_equals(x, y, return_msg=False, deep_equals=None):
         else:
             return ret(x.equals(y), ".df_equals, x = {} != y = {}", [x, y])
     elif isinstance(x, pd.Index):
-        return ret(x.equals(y), ".index_equals, x = {} != y = {}", [x, y])
+        if hasattr(x, "dtype") and hasattr(y, "dtype"):
+            if not x.dtype == y.dtype:
+                return ret(False, f".dtype, x.dtype = {x.dtype} != y.dtype = {y.dtype}")
+        if hasattr(x, "dtypes") and hasattr(y, "dtypes"):
+            if not x.dtypes.equals(y.dtypes):
+                return ret(
+                    False, f".dtypes, x.dtypes = {x.dtypes} != y.dtypes = {y.dtypes}"
+                )
     else:
         raise RuntimeError(
             f"Unexpected type of pandas object in _pandas_equals: type(x)={type(x)},"
@@ -198,7 +261,7 @@ def _pandas_equals(x, y, return_msg=False, deep_equals=None):
         )
 
 
-def _tuple_equals(x, y, return_msg=False):
+def _tuple_equals(x, y, return_msg=False, deep_equals=None):
     """Test two tuples or lists for equality.
 
     Correct if tuples/lists contain the following valid types:
@@ -243,7 +306,7 @@ def _tuple_equals(x, y, return_msg=False):
     return ret(True, "")
 
 
-def _dict_equals(x, y, return_msg=False):
+def _dict_equals(x, y, return_msg=False, deep_equals=None):
     """Test two dicts for equality.
 
     Correct if dicts contain the following valid types:
@@ -303,8 +366,8 @@ def _fh_equals_plugin(x, y, return_msg=False, deep_equals=None):
 
     Parameters
     ----------
-    x: ForcastingHorizon
-    y: ForcastingHorizon
+    x: ForecastingHorizon
+    y: ForecastingHorizon
     return_msg : bool, optional, default=False
         whether to return informative message about what is not equal
 
@@ -357,7 +420,7 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
         entries must be functions with the signature:
         ``(x, y, return_msg: bool) -> return``
         where return is:
-        ``None``, if the plugin does not apply, otheriwse:
+        ``None``, if the plugin does not apply, otherwise:
         ``is_equal: bool`` if ``return_msg=False``,
         ``(is_equal: bool, msg: str)`` if return_msg=True.
         Plugins can have an additional argument ``deep_equals=None``
@@ -378,11 +441,17 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
     # we now know all types are the same
     # so now we compare values
 
+    # we need to pass in the same plugins, so we curry
+    def deep_equals_curried(x, y, return_msg=False):
+        return deep_equals_custom(x, y, return_msg=return_msg, plugins=plugins)
+
     # recursion through lists, tuples and dicts
     if isinstance(x, (list, tuple)):
-        return ret(*_tuple_equals(x, y, return_msg=True))
+        dec = deep_equals_curried
+        return ret(*_tuple_equals(x, y, return_msg=True, deep_equals=dec))
     elif isinstance(x, dict):
-        return ret(*_dict_equals(x, y, return_msg=True))
+        dec = deep_equals_curried
+        return ret(*_dict_equals(x, y, return_msg=True, deep_equals=dec))
     elif _is_npnan(x):
         return ret(_is_npnan(y), f"type(x)={type(x)} != type(y)={type(y)}")
     elif isclass(x):
@@ -398,12 +467,6 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
             sig = signature(plugin)
             # check if deep_equals is an argument of the plugin
             if "deep_equals" in sig.parameters:
-                # we need to pass in the same plugins, so we curry
-                def deep_equals_curried(x, y, return_msg=False):
-                    return deep_equals_custom(
-                        x, y, return_msg=return_msg, plugins=plugins
-                    )
-
                 kwargs = {"deep_equals": deep_equals_curried}
             else:
                 kwargs = {}
@@ -425,7 +488,7 @@ def deep_equals_custom(x, y, return_msg=False, plugins=None):
         import numpy as np
 
     # deal with the case where != returns a vector
-    if numpy_available and np.any(x != y) or any(_coerce_list(x != y)):
+    if numpy_available and np.any(x != y) or np.any(_coerce_list(x != y)):
         return ret(False, f" !=, {x} != {y}")
 
     return ret(True, "")

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/utils/tests/test_deep_equals.py

@@ -24,6 +24,10 @@ if _check_soft_dependencies("numpy", severity="none"):
         np.array([2, 3, 4]),
         np.array([2, 4, 5]),
         np.nan,
+        # these cases test that plugins are passed to recursions
+        # in this case, the numpy equality plugin
+        {"a": np.array([2, 3, 4]), "b": np.array([4, 3, 2])},
+        [np.array([2, 3, 4]), np.array([4, 3, 2])],
     ]
 
 if _check_soft_dependencies("pandas", severity="none"):
@@ -32,9 +36,12 @@ if _check_soft_dependencies("pandas", severity="none"):
     EXAMPLES += [
         pd.DataFrame({"a": [4, 2]}),
         pd.DataFrame({"a": [4, 3]}),
+        pd.DataFrame({"a": ["4", "3"]}),
         (np.array([1, 2, 4]), [pd.DataFrame({"a": [4, 2]})]),
         {"foo": [42], "bar": pd.Series([1, 2])},
         {"bar": [42], "foo": pd.Series([1, 2])},
+        pd.Index([1, 2, 3]),
+        pd.Index([2, 3, 4]),
     ]
 
     # nested DataFrame example

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/utils/tests/test_iter.py

@@ -8,7 +8,7 @@ tests in this module incdlue:
 - test_format_seq_to_str: verify that _format_seq_to_str outputs expected format.
 - test_format_seq_to_str_raises: verify _format_seq_to_str raises error on unexpected
   output.
-- test_scalar_to_seq_expected_output: verify that _scalar_to_seq returns exepcted
+- test_scalar_to_seq_expected_output: verify that _scalar_to_seq returns expected
   output.
 - test_scalar_to_seq_raises: verify that _scalar_to_seq raises error when an
   invalid value is provided for sequence_type parameter.

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/validate/_named_objects.py

@@ -27,7 +27,7 @@ __author__: List[str] = ["RNKuhns"]
 def _named_baseobject_error_msg(
     sequence_name: Optional[str] = None, allow_dict: bool = True
 ):
-    """Create error message for non-comformance with named BaseObject api."""
+    """Create error message for non-conformance with named BaseObject api."""
     name_str = f"{sequence_name}" if sequence_name is not None else "Input"
     allowed_types = "a sequence of (string name, BaseObject instance) tuples"
 
@@ -70,7 +70,7 @@ def is_named_object_tuple(
     >>> from skbase.base import BaseObject, BaseEstimator
     >>> from skbase.validate import is_named_object_tuple
 
-    Default checks for object to be an instance of BaseOBject
+    Default checks for object to be an instance of BaseObject
 
     >>> is_named_object_tuple(("Step 1", BaseObject()))
     True
@@ -163,7 +163,7 @@ def is_sequence_named_objects(
     --------
     is_named_object_tuple :
         Indicate (True/False) if input follows the named object API format for
-        a single named object (e.g., tupe[str, expected class type]).
+        a single named object (e.g., tuple[str, expected class type]).
     check_sequence_named_objects :
         Validate input to see if it follows sequence of named objects API. An error
         is raised for input that does not conform to the API format.
@@ -346,7 +346,7 @@ def check_sequence_named_objects(
     --------
     is_named_object_tuple :
         Indicate (True/False) if input follows the named object API format for
-        a single named object (e.g., tupe[str, expected class type]).
+        a single named object (e.g., tuple[str, expected class type]).
     is_sequence_named_objects :
         Indicate (True/False) if an input sequence follows the named object API.
 

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/validate/_types.py

@@ -306,13 +306,13 @@ def check_sequence(
         else:
             input_seq = _scalar_to_seq(input_seq, sequence_type=sequence_type)
 
-    is_valid_seqeunce = is_sequence(
+    is_valid_sequence = is_sequence(
         input_seq,
         sequence_type=sequence_type,
         element_type=element_type,
     )
     # Raise error is format is not expected.
-    if not is_valid_seqeunce:
+    if not is_valid_sequence:
         name_str = "Input sequence" if sequence_name is None else f"`{sequence_name}`"
         if sequence_type is None:
             seq_str = "a sequence"

{scikit-base-0.6.1 → scikit-base-0.7.0}/skbase/validate/tests/test_iterable_named_objects.py

@@ -36,7 +36,7 @@ def test_is_named_object_tuple_output(
     fixture_estimator_instance, fixture_object_instance
 ):
     """Test is_named_object_tuple returns expected value."""
-    # Default checks for object to be an instance of BaseOBject
+    # Default checks for object to be an instance of BaseObject
     assert is_named_object_tuple(("Step 1", fixture_object_instance)) is True
     assert is_named_object_tuple(("Step 2", fixture_estimator_instance)) is True