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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: scikit-base
-Version: 0.8.3
+Version: 0.9.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.8.3 is now available. Check out our
+:rocket: Version 0.9.0 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

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

@@ -1,5 +1,5 @@
 docs/source/conf.py,sha256=kFc-4qkb0ZGD5cDej5KPJhMePp9kpVu6ZqFoF0fgovg,9951
-skbase/__init__.py,sha256=mmRe3GJqruvDkWloNpWs_pyuhiE4t0Pt_TrxyHnkccY,345
+skbase/__init__.py,sha256=babaqrj4tsDMuHBzKd205fgdkP1bCL8C_5aQnov7GE0,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
@@ -12,16 +12,16 @@ skbase/base/_pretty_printing/_pprint.py,sha256=VVnw-cywGxArfiFfVWfFSV5VMJvsxpDsJ
 skbase/base/_pretty_printing/tests/__init__.py,sha256=rakHMQAO1NfuMabw-VsqVA9Jd1YQyuSop-Oc3tgc4w0,77
 skbase/base/_pretty_printing/tests/test_pprint.py,sha256=8_CFX9v41ZA-aWkAxm9UZSWcOaXt-u1sLwsNPZOSL24,731
 skbase/lookup/__init__.py,sha256=RNw1mx8nXFHsn-HgnjHzWPn9AG45jSMEKl-Z0pEH7jE,1089
-skbase/lookup/_lookup.py,sha256=Kt_Jnt-ikWYCMuYQAWc-ym0Aiu-wnG4YXwGQj6WtWJk,44606
+skbase/lookup/_lookup.py,sha256=COZhLXRVZUdisoiS53J1LZylyjlM8TX-P9erEp6bk9I,43025
 skbase/lookup/tests/__init__.py,sha256=MVqGlWsUV-gQ4qzW_TqE3UmKO9IQ9mwdDlsIHaGt3bc,68
-skbase/lookup/tests/test_lookup.py,sha256=cldy5v_K_GmAXWe-90eTIoHIm5g5-C77ffkYCWjw7bU,39743
+skbase/lookup/tests/test_lookup.py,sha256=kAgsGyp4EYrXZnqezya-PI14m9mm8-ePoR0Wf-Cu-oo,39782
 skbase/testing/__init__.py,sha256=OdwR-aEU2KzGrU-O0gtNSMNGmF2mtgBmjAnMzcgwe6w,351
 skbase/testing/test_all_objects.py,sha256=FooQ_pukjKKK7q3q7gXGH5pDcg8A4xEmkBAMcAF7jcs,36166
 skbase/testing/utils/__init__.py,sha256=kaLuqQwJsCunRWsUb1JwTVG-iqXbzdUobuYHNHsBlQQ,113
 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=6ydu8acgnb-MydTiUi9iOvpSPUpW2HjCfp3n6necc8Y,9786
+skbase/tests/conftest.py,sha256=tssOYrrWIRDr__UatmRfNTWt_nPa4ShbLRG0cEyfsD0,10190
 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
@@ -57,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.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.9.0.dist-info/LICENSE,sha256=W2h8EYZ_G_mvCmCmXTTYqv66QF5NgSMbzLYJdk8qHVg,1525
+scikit_base-0.9.0.dist-info/METADATA,sha256=Rzmr2c5W-r-O0WPzYWmod5kmvsreXIJAT9CBjT9phCE,8482
+scikit_base-0.9.0.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+scikit_base-0.9.0.dist-info/top_level.txt,sha256=FbRMsZcP-O6pMLGZpxA5pQ-ClfRzoB6Yr-hTViYqwT0,57
+scikit_base-0.9.0.dist-info/zip-safe,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+scikit_base-0.9.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.8.3"
+__version__: str = "0.9.0"

skbase/lookup/_lookup.py

@@ -203,46 +203,16 @@ def _filter_by_tags(obj, tag_filter=None, as_dataframe=True):
     if not hasattr(obj, "get_class_tag"):
         return False
 
-    klass_tags = obj.get_class_tags().keys()
-
-    # todo 0.9.0: remove the warning message
-    # i.e., this message and all warnings referring to it
-    warn_msg = (
-        "The meaning of filter_tags arguments in all_objects of type str "
-        "and iterable of str will change from scikit-base 0.9.0. "
-        "Currently, str or iterable of str arguments select objects that possess the "
-        "tag(s) with the specified name, of any value. "
-        "From 0.9.0 onwards, str or iterable of str "
-        "will select objects that possess the tag with the specified name, "
-        "with the value True (boolean). See scikit-base issue #326 for the rationale "
-        "behind this change. "
-        "To retain previous behaviour, that is, "
-        "to select objects that possess the tag with the specified name, of any value, "
-        "use a dict with the tag name as key, and re.Pattern('*?') as value. "
-        "That is, from re import Pattern, and pass {tag_name: Pattern('*?')} "
-        "as filter_tags, and similarly with multiple tag names. "
-    )
-
     # case: tag_filter is string
     if isinstance(tag_filter, str):
-        # todo 0.9.0: reomove this warning
-        warnings.warn(warn_msg, DeprecationWarning, stacklevel=2)
-        # todo 0.9.0: replace this line
-        return tag_filter in klass_tags
-        # by this line
-        # tag_filter = {tag_filter: True}
+        tag_filter = {tag_filter: True}
 
     # case: tag_filter is iterable of str but not dict
     # If a iterable of strings is provided, check that all are in the returned tag_dict
     if isinstance(tag_filter, Iterable) and not isinstance(tag_filter, dict):
         if not all(isinstance(t, str) for t in tag_filter):
             raise ValueError(f"{type_msg} {tag_filter}")
-        # todo 0.9.0: reomove this warning
-        warnings.warn(warn_msg, DeprecationWarning, stacklevel=2)
-        # todo 0.9.0: replace this line
-        return all(tag in klass_tags for tag in tag_filter)
-        # by this line
-        # tag_filter = {tag: True for tag in tag_filter}
+        tag_filter = dict.fromkeys(tag_filter, True)
 
     # case: tag_filter is dict
     # check that all keys are str
@@ -712,8 +682,6 @@ def get_package_metadata(
     return module_info
 
 
-# todo 0.9.0: change docstring to reflect handling of filter_tags
-# in case of str or iterable of str
 def all_objects(
     object_types=None,
     filter_tags=None,
@@ -760,7 +728,9 @@ def all_objects(
         Filter used to determine if ``klass`` has tag or expected tag values.
 
         - If a str or list of strings is provided, the return will be filtered
-          to keep classes that have all the tag(s) specified by the strings.
+          to keep classes that have all the tag(s) specified by the strings,
+          with the tag value being True.
+
         - If a dict is provided, the return will be filtered to keep exactly the classes
           where tags satisfy all the filter conditions specified by ``filter_tags``.
           Filter conditions are as follows, for ``tag_name: search_value`` pairs in

skbase/lookup/tests/test_lookup.py

@@ -35,6 +35,7 @@ from skbase.tests.conftest import (
     SKBASE_PUBLIC_CLASSES_BY_MODULE,
     SKBASE_PUBLIC_FUNCTIONS_BY_MODULE,
     SKBASE_PUBLIC_MODULES,
+    ClassWithABTrue,
     Parent,
 )
 from skbase.tests.mock_package.test_mock_package import (
@@ -374,18 +375,18 @@ def test_filter_by_tags():
     assert _filter_by_tags(NotABaseObject) is True
 
     # Check when tag_filter is a str and present in the class
-    assert _filter_by_tags(Parent, tag_filter="A") is True
+    assert _filter_by_tags(ClassWithABTrue, tag_filter="A") is True
     # Check when tag_filter is str and not present in the class
-    assert _filter_by_tags(BaseObject, tag_filter="A") is False
+    assert _filter_by_tags(Parent, tag_filter="A") is False
 
     # Test functionality when tag present and object doesn't have tag interface
     assert _filter_by_tags(NotABaseObject, tag_filter="A") is False
 
     # Test functionality where tag_filter is Iterable of str
     # all tags in iterable are in the class
-    assert _filter_by_tags(Parent, ("A", "B", "C")) is True
+    assert _filter_by_tags(ClassWithABTrue, ("A", "B")) is True
     # Some tags in iterable are in class and others aren't
-    assert _filter_by_tags(Parent, ("A", "B", "C", "D", "E")) is False
+    assert _filter_by_tags(ClassWithABTrue, ("A", "B", "C", "D", "E")) is False
 
     # Test functionality where tag_filter is Dict[str, Any]
     # All keys in dict are in tag_filter and values all match

skbase/tests/conftest.py

@@ -314,3 +314,19 @@ class Child(Parent):
     def some_other_method(self):
         """To be implemented in the child class."""
         pass
+
+
+# Fixture class for testing tag system, child overrides tags
+class ClassWithABTrue(Parent):
+    """Child class that sets A, B tags to True."""
+
+    _tags = {"A": True, "B": True}
+    __author__ = ["fkiraly", "RNKuhns"]
+
+    def some_method(self):
+        """Child class' implementation."""
+        pass
+
+    def some_other_method(self):
+        """To be implemented in the child class."""
+        pass