scikit-base 0.6.2__py3-none-any.whl → 0.7.0__py3-none-any.whl

{scikit_base-0.6.2.dist-info → scikit_base-0.7.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.6.2
+Version: 0.7.0
 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.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.2.dist-info → scikit_base-0.7.0.dist-info}/RECORD

@@ -1,9 +1,9 @@
 docs/source/conf.py,sha256=kFc-4qkb0ZGD5cDej5KPJhMePp9kpVu6ZqFoF0fgovg,9951
-skbase/__init__.py,sha256=Bp2C-xPxN2UmAAsk7oVkhtVVg5N1fAbri0DcnsR4fvo,345
+skbase/__init__.py,sha256=A32x7MB8vCuf2dPjV5n12AlDkXZH3yajYQObXDNY6VA,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=1_tsrQhuuG-ludCfwW_8PFbPl8i7glnXVIbCIiBBCRY,50692
+skbase/base/_base.py,sha256=uWfb7xCEh7-9o3gs0ueF_HFEgxc9seUWSGCLLoM7ejo,50947
 skbase/base/_meta.py,sha256=6jhg0JSDt15CN-gutnR8vOF2bHBln9u6u3MmXEgQdMs,39599
 skbase/base/_tagmanager.py,sha256=nKoiIC1yXFFSpN5ljWbMrwA-pwlbxsljgKuUywh1MR4,7289
 skbase/base/_pretty_printing/__init__.py,sha256=bVuKnwafn8c2q2AGJ9BOu9cmu-xBjiOxHf1hxjm8K2A,492
@@ -20,7 +20,7 @@ skbase/testing/utils/_conditional_fixtures.py,sha256=QwI7K28Lsy6RAkDP94goo8uWWvM
 skbase/testing/utils/inspect.py,sha256=XcPdm1-J3YXCTxsrqeJlStPvbC0vH1cgaApN5lzRI2c,741
 skbase/tests/__init__.py,sha256=d2_OTTnt0GX5otQsBuNAb1evg8C5Fi0JjqK2VsfMtXU,37
 skbase/tests/conftest.py,sha256=Uo0Ztm91jmNKYy9Abul99DjQoE_MqDvNogjB0Cfb2Hw,8663
-skbase/tests/test_base.py,sha256=HA4Dg90z_rvzP9CewF6DCWFTz474xGcrrla4i35YRBI,46501
+skbase/tests/test_base.py,sha256=oGDXTZf0aWtu--pYOC_lk9X8uOzvKRuQE9Ce210jz5U,48603
 skbase/tests/test_baseestimator.py,sha256=fuzpwxjYzyl-Vrte1va4AWdbYElhWnED8W10236Xprc,4731
 skbase/tests/test_exceptions.py,sha256=wOdk7Gp8pvbhucna3_9FxTk9xFLjC9XNsGsVabQLYEE,629
 skbase/tests/test_meta.py,sha256=TTZW_BlEbirLjeEQCV1x3IYCf6V2ULJ_KfyVHgs0wkU,5662
@@ -33,14 +33,14 @@ skbase/utils/_nested_iter.py,sha256=omDI2Y75ajWTSV9d59iJTj1RcCk5YFbc7cZNQjz8AC8,
 skbase/utils/_utils.py,sha256=A6sTIUEscEy9TjBmCvXEuhk9q8ROBPyfJGhrjlSA4LY,3134
 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=szrgpxI4fMOZfnqFtBkOL-mxowSg-CGVAsRxV66tVIg,17212
+skbase/utils/deep_equals/_deep_equals.py,sha256=dhsbUn_CsXD-110uztxL7-wBhYMbZ6A6H94faFGyQXc,17215
 skbase/utils/dependencies/__init__.py,sha256=89TNnES--f1PeoPm-_h6a2mCtoGXt6mAd-n89FdusMM,352
 skbase/utils/dependencies/_dependencies.py,sha256=zmlWZ10HtiHE2PK2T7AzsFNKIA95O8hmIySlz2t4Mrs,10359
 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
 skbase/utils/tests/test_check.py,sha256=rMxaQtKegaKZPGjocNB9ntMwMIAq5-7SmNZuFsWFGZE,754
-skbase/utils/tests/test_deep_equals.py,sha256=4nKEYICi8SvvNWSgbY0dr2ukaW_FnKPgWjPXpLQcUNo,2430
+skbase/utils/tests/test_deep_equals.py,sha256=WwQm_WHpCjZsypAPS_GCX9Ni6fMl4tcva-y2VfZYW8s,2488
 skbase/utils/tests/test_iter.py,sha256=HSPprp920q3HPbVoscY7mB9fYLwe8S7_DLblr9vUGAk,4918
 skbase/utils/tests/test_nested_iter.py,sha256=3ytT_qqZKBr90uNDTK6pzCjDv6EpnJOmzkyAnejyKYc,2230
 skbase/utils/tests/test_utils.py,sha256=13P1zYpsyNoX9Ugj37lHZAQm4hIORvsKEo1pF3tTIP0,1182
@@ -50,9 +50,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=G-qwFjXk-8WvXoeOvo2omfFKKjbpWhP-sPf6hsw8q30,14131
-scikit_base-0.6.2.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
-scikit_base-0.6.2.dist-info/METADATA,sha256=zT3z1JIywbNleTdlZPvQaOrH9XIO7XTM4HFD6WStbcw,8704
-scikit_base-0.6.2.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-scikit_base-0.6.2.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
-scikit_base-0.6.2.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-scikit_base-0.6.2.dist-info/RECORD,,
+scikit_base-0.7.0.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
+scikit_base-0.7.0.dist-info/METADATA,sha256=0BalNSQbERguz3MplLtPZKwKlpQnSO_hb2a-Z1WvUQg,8704
+scikit_base-0.7.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
+scikit_base-0.7.0.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
+scikit_base-0.7.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+scikit_base-0.7.0.dist-info/RECORD,,

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.6.2"
+__version__: str = "0.7.0"

skbase/base/_base.py

@@ -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

skbase/tests/test_base.py

@@ -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",
@@ -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

skbase/utils/deep_equals/_deep_equals.py

@@ -488,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, "")

skbase/utils/tests/test_deep_equals.py

@@ -40,6 +40,8 @@ if _check_soft_dependencies("pandas", severity="none"):
         (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