scikit-base 0.12.2__tar.gz → 0.12.3__tar.gz

{scikit_base-0.12.2/scikit_base.egg-info → scikit_base-0.12.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scikit-base
-Version: 0.12.2
+Version: 0.12.3
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -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 0.12.2 is now available. Check out our
+:rocket: Version 0.12.3 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

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

{scikit_base-0.12.2 → scikit_base-0.12.3}/pyproject.toml

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

{scikit_base-0.12.2 → scikit_base-0.12.3/scikit_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scikit-base
-Version: 0.12.2
+Version: 0.12.3
 Summary: Base classes for sklearn-like parametric objects
 Author-email: sktime developers <sktime.toolbox@gmail.com>
 Maintainer: Franz Király
@@ -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 0.12.2 is now available. Check out our
+:rocket: Version 0.12.3 is now available. Check out our
 [release notes](https://skbase.readthedocs.io/en/latest/changelog.html).
 
 | Overview | |

{scikit_base-0.12.2 → scikit_base-0.12.3}/scikit_base.egg-info/SOURCES.txt

@@ -45,6 +45,7 @@ skbase/utils/_check.py
 skbase/utils/_iter.py
 skbase/utils/_nested_iter.py
 skbase/utils/_utils.py
+skbase/utils/doctest_run.py
 skbase/utils/random_state.py
 skbase/utils/stderr_mute.py
 skbase/utils/stdout_mute.py

{scikit_base-0.12.2 → scikit_base-0.12.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.12.2"
+__version__: str = "0.12.3"

{scikit_base-0.12.2 → scikit_base-0.12.3}/skbase/base/_base.py

@@ -1201,6 +1201,9 @@ class TagAliaserMixin:
     # key = old tag; value = version in which tag will be removed, as string
     deprecate_dict = {"old_tag": "0.12.0", "tag_to_remove": "99.99.99"}
 
+    # package name used for deprecation warnings
+    _package_name = ""
+
     def __init__(self):
         """Construct TagAliaserMixin."""
         super(TagAliaserMixin, self).__init__()
@@ -1248,6 +1251,7 @@ class TagAliaserMixin:
             tags set by ``set_tags`` or ``clone_tags``.
         """
         collected_tags = super(TagAliaserMixin, cls).get_class_tags()
+        cls._deprecate_tag_warn(collected_tags)
         collected_tags = cls._complete_dict(collected_tags)
         return collected_tags
 
@@ -1328,6 +1332,7 @@ class TagAliaserMixin:
             and new tags from ``_tags_dynamic`` object attribute.
         """
         collected_tags = super(TagAliaserMixin, self).get_tags()
+        self._deprecate_tag_warn(collected_tags)
         collected_tags = self._complete_dict(collected_tags)
         return collected_tags
 
@@ -1458,14 +1463,19 @@ class TagAliaserMixin:
             if tag_name in cls.alias_dict.keys():
                 version = cls.deprecate_dict[tag_name]
                 new_tag = cls.alias_dict[tag_name]
-                msg = f"tag {tag_name!r} will be removed in sktime version {version}"
+                pkg_name = cls._package_name
+                if pkg_name != "":
+                    pkg_name = f"{pkg_name} "
+                msg = (
+                    f"tag {tag_name!r} will be removed in {pkg_name} version {version}"
+                )
                 if new_tag != "":
                     msg += (
                         f" and replaced by {new_tag!r}, please use {new_tag!r} instead"
                     )
                 else:
                     msg += ", please remove code that access or sets {tag_name!r}"
-                warnings.warn(msg, category=DeprecationWarning, stacklevel=2)
+                warnings.warn(msg, category=FutureWarning, stacklevel=2)
 
 
 class BaseEstimator(BaseObject):

{scikit_base-0.12.2 → scikit_base-0.12.3}/skbase/lookup/_lookup.py

@@ -430,7 +430,7 @@ def _get_module_info(
         authors = ", ".join(authors)
     # Compile information on classes in the module
     module_classes: MutableMapping = {}  # of ClassInfo type
-    for name, klass in inspect.getmembers(module, inspect.isclass):
+    for name, klass in _get_members_uw(module, inspect.isclass):
         # Skip a class if non-public items should be excluded and it starts with "_"
         if (
             (exclude_non_public_items and klass.__name__.startswith("_"))
@@ -440,7 +440,9 @@ def _get_module_info(
         ):
             continue
         # Otherwise, store info about the class
-        if klass.__module__ == module.__name__ or name in designed_imports:
+        uw_klass = inspect.unwrap(klass)  # unwrap any decorators
+        klassname = uw_klass.__name__
+        if uw_klass.__module__ == module.__name__ or name in designed_imports:
             klass_authors = getattr(klass, "__author__", authors)
             if isinstance(klass_authors, (list, tuple)):
                 klass_authors = ", ".join(klass_authors)
@@ -453,9 +455,9 @@ def _get_module_info(
                 )
             module_classes[name] = {
                 "klass": klass,
-                "name": klass.__name__,
+                "name": klassname,
                 "description": (
-                    "" if klass.__doc__ is None else klass.__doc__.split("\n")[0]
+                    "" if uw_klass.__doc__ is None else uw_klass.__doc__.split("\n")[0]
                 ),
                 "tags": (
                     klass.get_class_tags() if hasattr(klass, "get_class_tags") else None
@@ -464,23 +466,25 @@ def _get_module_info(
                 "is_base_class": klass in package_base_classes,
                 "is_base_object": issubclass(klass, BaseObject),
                 "authors": klass_authors,
-                "module_name": module.__name__,
+                "module_name": uw_klass.__module__,
             }
 
     module_functions: MutableMapping = {}  # of FunctionInfo type
-    for name, func in inspect.getmembers(module, inspect.isfunction):
-        if func.__module__ == module.__name__ or name in designed_imports:
+    for name, func in _get_members_uw(module, inspect.isfunction):
+        uw_func = inspect.unwrap(func)  # unwrap any decorators
+        funcname = uw_func.__name__
+        if uw_func.__module__ == module.__name__ or name in designed_imports:
             # Skip a class if non-public items should be excluded and it starts with "_"
-            if exclude_non_public_items and func.__name__.startswith("_"):
+            if exclude_non_public_items and funcname.startswith("_"):
                 continue
             # Otherwise, store info about the class
             module_functions[name] = {
                 "func": func,
-                "name": func.__name__,
+                "name": funcname,
                 "description": (
-                    "" if func.__doc__ is None else func.__doc__.split("\n")[0]
+                    "" if uw_func.__doc__ is None else uw_func.__doc__.split("\n")[0]
                 ),
-                "module_name": module.__name__,
+                "module_name": uw_func.__module__,
             }
 
     # Combine all the information on the module together
@@ -505,6 +509,22 @@ def _get_module_info(
     return module_info
 
 
+def _get_members_uw(module, predicate=None):
+    """Get members of a module. Same as inspect.getmembers, but robust to decorators."""
+    for name, obj in vars(module).items():
+        if not callable(obj):
+            continue
+
+        try:
+            unwrapped = inspect.unwrap(obj)
+        except ValueError:
+            continue  # skip circular wrappers or broken decorators
+
+        if predicate is not None and not predicate(unwrapped):
+            continue
+        yield name, obj
+
+
 def get_package_metadata(
     package_name: str,
     path: Optional[str] = None,
@@ -876,7 +896,7 @@ def all_objects(
 
     # remove names if return_names=False
     if not return_names:
-        all_estimators = [estimator for (name, estimator) in all_estimators]
+        all_estimators = [estimator for (_, estimator) in all_estimators]
         columns = ["object"]
     else:
         columns = ["name", "object"]

{scikit_base-0.12.2 → scikit_base-0.12.3}/skbase/tests/conftest.py

@@ -56,6 +56,7 @@ SKBASE_MODULES = (
     "skbase.utils.dependencies",
     "skbase.utils.dependencies._dependencies",
     "skbase.utils.dependencies._import",
+    "skbase.utils.doctest_run",
     "skbase.utils.random_state",
     "skbase.utils.stderr_mute",
     "skbase.utils.stdout_mute",
@@ -83,6 +84,7 @@ SKBASE_PUBLIC_MODULES = (
     "skbase.utils",
     "skbase.utils.deep_equals",
     "skbase.utils.dependencies",
+    "skbase.utils.doctest_run",
     "skbase.utils.random_state",
     "skbase.utils.stderr_mute",
     "skbase.utils.stdout_mute",
@@ -188,6 +190,7 @@ SKBASE_PUBLIC_FUNCTIONS_BY_MODULE = {
     "skbase.utils._utils": ("subset_dict_keys",),
     "skbase.utils.deep_equals": ("deep_equals",),
     "skbase.utils.deep_equals._deep_equals": ("deep_equals", "deep_equals_custom"),
+    "skbase.utils.doctest_run": ("run_doctest",),
     "skbase.utils.random_state": (
         "check_random_state",
         "sample_dependent_seed",
@@ -199,7 +202,11 @@ SKBASE_FUNCTIONS_BY_MODULE = SKBASE_PUBLIC_FUNCTIONS_BY_MODULE.copy()
 SKBASE_FUNCTIONS_BY_MODULE.update(
     {
         "skbase.base._clone_base": {"_check_clone", "_clone"},
-        "skbase.base._clone_plugins": ("_default_clone",),
+        "skbase.base._clone_plugins": (
+            "_default_clone",
+            "_get_sklearn_clone",
+            "_is_sklearn_present",
+        ),
         "skbase.base._pretty_printing._object_html_repr": (
             "_get_visual_block",
             "_object_html_repr",
@@ -208,20 +215,22 @@ SKBASE_FUNCTIONS_BY_MODULE.update(
         ),
         "skbase.base._pretty_printing._pprint": ("_changed_params", "_safe_repr"),
         "skbase.lookup._lookup": (
+            "all_objects",
+            "get_package_metadata",
+            "_check_object_types",
+            "_coerce_to_tuple",
             "_determine_module_path",
+            "_filter_by_tags",
+            "_filter_by_class",
+            "_get_members_uw",
+            "_get_module_info",
             "_get_return_tags",
+            "_import_module",
             "_is_ignored_module",
-            "all_objects",
             "_is_non_public_module",
-            "get_package_metadata",
             "_make_dataframe",
             "_walk",
-            "_filter_by_tags",
-            "_filter_by_class",
-            "_import_module",
-            "_check_object_types",
-            "_get_module_info",
-            "_coerce_to_tuple",
+            "_walk_and_retrieve_all_objs",
         ),
         "skbase.testing.utils.inspect": ("_get_args",),
         "skbase.utils._check": ("_is_scalar_nan",),
@@ -265,12 +274,13 @@ SKBASE_FUNCTIONS_BY_MODULE.update(
             "deep_equals_custom",
         ),
         "skbase.utils.dependencies._dependencies": (
-            "_check_soft_dependencies",
-            "_check_python_version",
             "_check_env_marker",
             "_check_estimator_deps",
+            "_check_python_version",
+            "_check_soft_dependencies",
             "_get_pkg_version",
             "_get_installed_packages",
+            "_get_installed_packages_private",
             "_normalize_requirement",
             "_normalize_version",
             "_raise_at_severity",

{scikit_base-0.12.2 → scikit_base-0.12.3}/skbase/utils/dependencies/_dependencies.py

@@ -17,23 +17,36 @@ def _check_soft_dependencies(
     obj=None,
     msg=None,
     normalize_reqs=True,
+    case_sensitive=False,
 ):
     """Check if required soft dependencies are installed and raise error or warning.
 
     Parameters
     ----------
-    packages : str or list/tuple of str, or length-1-tuple containing list/tuple of str
+    packages : str or list/tuple of str nested up to two levels
         str should be package names and/or package version specifications to check.
         Each str must be a PEP 440 compatible specifier string, for a single package.
         For instance, the PEP 440 compatible package name such as ``"pandas"``;
         or a package requirement specifier string such as ``"pandas>1.2.3"``.
         arg can be str, kwargs tuple, or tuple/list of str, following calls are valid:
-        ``_check_soft_dependencies("package1")``
+
+        * ``_check_soft_dependencies("package1")``
+        * ``_check_soft_dependencies("package1", "package2")``
+        * ``_check_soft_dependencies(("package1", "package2"))``
+        * ``_check_soft_dependencies(["package1", "package2"])``
+        * ``_check_soft_dependencies(("package1", "package2"), "package3")``
+        * ``_check_soft_dependencies(["package1", "package2"], "package3")``
+        * ``_check_soft_dependencies((["package1", "package2"], "package3"))``
+
+        The first level is interpreted as conjunction, the second level as disjunction,
+        that is, conjunction = "and", disjunction = "or".
+
+        In case of more than a single arg, an outer level of "and" (brackets)
+        is added, that is,
+
         ``_check_soft_dependencies("package1", "package2")``
-        ``_check_soft_dependencies(("package1", "package2"))``
-        ``_check_soft_dependencies(["package1", "package2"])``
 
-    package_import_alias : ignored, present only for backwards compatibility
+        is the same as ``_check_soft_dependencies(("package1", "package2"))``
 
     severity : str, "error" (default), "warning", "none"
         whether the check should raise an error, a warning, or nothing
@@ -63,6 +76,19 @@ def _check_soft_dependencies(
         an actual version "my_pkg==2.3.4.post1" will be considered compatible with
         "my_pkg==2.3.4". If False, the this situation would raise an error.
 
+    case_sensitive : bool, default=False
+        whether package names are case sensitive or not.
+        pypi package names are case sensitive, but pypi disallows
+        multiple package names that differ only in case.
+        Hence there is at most a single correct case for a given package name,
+        and a user will most likely intend to refer to the correct package,
+        even when providing an incorrect case for the pypi name.
+
+        * If set to True, package names are case sensitive, and the check will fail
+          if the correct case is not provided, e.g., ``mapie`` instead of ``MAPIE``.
+        * If set to False, package names are case insensitive, and the check will pass
+          for all case combinations, e.g., ``mapie``, ``MAPIE``, ``Mapie``, ``mApIe``.
+
     Raises
     ------
     InvalidRequirement
@@ -78,10 +104,26 @@ def _check_soft_dependencies(
     """
     if len(packages) == 1 and isinstance(packages[0], (tuple, list)):
         packages = packages[0]
-    if not all(isinstance(x, str) for x in packages):
+
+    def _is_str_or_tuple_of_strs(obj):
+        """Check that obj is a str or list/tuple nesting up to 1st level of str.
+
+        Valid examples:
+
+        * "pandas"
+        * ("pandas", "scikit-learn")
+        * ["pandas", "scikit-learn"]
+        """
+        if isinstance(obj, (tuple, list)):
+            return all(isinstance(x, str) for x in obj)
+
+        return isinstance(obj, str)
+
+    if not all(_is_str_or_tuple_of_strs(x) for x in packages):
         raise TypeError(
-            "packages argument of _check_soft_dependencies must be str or tuple of "
-            f"str, but found packages argument of type {type(packages)}"
+            "packages argument of _check_soft_dependencies must be str or tuple/list "
+            "of str or of tuple/list of str, "
+            f"but found packages argument of type {type(packages)}"
         )
 
     if obj is None:
@@ -105,7 +147,20 @@ def _check_soft_dependencies(
             f"or None, but found msg of type {type(msg)}"
         )
 
-    for package in packages:
+    def _get_pkg_version_and_req(package):
+        """Get package version and requirement object from package string.
+
+        Parameters
+        ----------
+        package : str
+
+        Returns
+        -------
+        package_version_req: SpecifierSet
+            version requirement object from package string
+        pkg_env_version: Version
+            version object of package in python environment
+        """
         try:
             req = Requirement(package)
             if normalize_reqs:
@@ -122,27 +177,70 @@ def _check_soft_dependencies(
         package_name = req.name
         package_version_req = req.specifier
 
-        pkg_env_version = _get_pkg_version(package_name)
+        pkg_env_version = _get_pkg_version(package_name, case_sensitive=case_sensitive)
         if normalize_reqs:
             pkg_env_version = _normalize_version(pkg_env_version)
 
+        return package_version_req, pkg_env_version
+
+    # each element of the list "package" must be satisfied
+    for package_req in packages:
+        # for elemehts, two cases can happen:
+        #
+        # 1. package is a string, e.g., "pandas". Then this must be present.
+        # 2. package is a tuple or list, e.g., ("pandas", "scikit-learn").
+        #    Then at least one of these must be present.
+        if not isinstance(package_req, (tuple, list)):
+            package_req = (package_req,)
+        else:
+            package_req = tuple(package_req)
+
+        def _is_version_req_satisfied(pkg_env_version, pkg_version_req):
+            if pkg_env_version is None:
+                return False
+            if pkg_version_req != SpecifierSet(""):
+                return pkg_env_version in pkg_version_req
+            else:
+                return True
+
+        pkg_version_reqs = []
+        pkg_env_versions = []
+        nontrivital_bound = []
+        req_sat = []
+
+        for package in package_req:
+            pkg_version_req, pkg_env_version = _get_pkg_version_and_req(package)
+            pkg_version_reqs.append(pkg_version_req)
+            pkg_env_versions.append(pkg_env_version)
+            nontrivital_bound.append(pkg_version_req != SpecifierSet(""))
+            req_sat.append(_is_version_req_satisfied(pkg_env_version, pkg_version_req))
+
+        package_req_strs = [f"{x!r}" for x in package_req]
+        # example: ["'scipy<1.7.0'"] or ["'scipy<1.7.0'", "'numpy'"]
+
+        package_str_q = " or ".join(package_req_strs)
+        # example: "'scipy<1.7.0'"" or "'scipy<1.7.0' or 'numpy'""
+
+        package_str = " or ".join(f"`pip install {r}`" for r in package_req)
+        # example: "pip install scipy<1.7.0 or pip install numpy"
+
         # if package not present, make the user aware of installation reqs
-        if pkg_env_version is None:
+        if all(pkg_env_version is None for pkg_env_version in pkg_env_versions):
             if obj is None and msg is None:
                 msg = (
-                    f"{class_name} requires package {package!r} to be present "
-                    f"in the python environment, but {package!r} was not found. "
+                    f"{class_name} requires package {package_str_q} to be present "
+                    f"in the python environment, but {package_str_q} was not found. "
                 )
             elif msg is None:  # obj is not None, msg is None
                 msg = (
-                    f"{class_name} requires package {package!r} to be present "
-                    f"in the python environment, but {package!r} was not found. "
-                    f"{package!r} is a dependency of {class_name} and required "
+                    f"{class_name} requires package {package_str_q} to be present "
+                    f"in the python environment, but {package_str_q} was not found. "
+                    f"{package_str_q} is a dependency of {class_name} and required "
                     f"to construct it. "
                 )
             msg = msg + (
-                f"Please run: `pip install {package}` to "
-                f"install the {package!r} package. "
+                f"To install the requirement {package_str_q}, please run: "
+                f"{package_str} "
             )
             # if msg is not None, none of the above is executed,
             # so if msg is passed it overrides the default messages
@@ -151,22 +249,28 @@ def _check_soft_dependencies(
             return False
 
         # now we check compatibility with the version specifier if non-empty
-        if package_version_req != SpecifierSet(""):
+        if not any(req_sat):
+            reqs_not_satisfied = [
+                x for x in zip(package_req, pkg_env_versions, req_sat) if x[2] is False
+            ]
+            actual_vers = [f"{x[0]} {x[1]}" for x in reqs_not_satisfied]
+            pkg_env_version_str = ", ".join(actual_vers)
+
             msg = (
-                f"{class_name} requires package {package!r} to be present "
-                f"in the python environment, with version {package_version_req}, "
-                f"but incompatible version {pkg_env_version} was found. "
+                f"{class_name} requires package {package_str_q} to be present "
+                f"in the python environment, with versions as specified, "
+                f"but incompatible version {pkg_env_version_str} was found. "
             )
             if obj is not None:
                 msg = msg + (
-                    f"{package!r}, with version {package_version_req},"
-                    f"is a dependency of {class_name} and required to construct it. "
+                    f"This version requirement is not one by sktime, but specific "
+                    f"to the module, class or object with name {obj}."
                 )
 
             # raise error/warning or return False if version is incompatible
-            if pkg_env_version not in package_version_req:
-                _raise_at_severity(msg, severity, caller="_check_soft_dependencies")
-                return False
+
+            _raise_at_severity(msg, severity, caller="_check_soft_dependencies")
+            return False
 
     # if package can be imported and no version issue was caught for any string,
     # then obj is compatible with the requirements and we should return True
@@ -174,7 +278,7 @@ def _check_soft_dependencies(
 
 
 @lru_cache
-def _get_installed_packages_private():
+def _get_installed_packages_private(lowercase=False):
     """Get a dictionary of installed packages and their versions.
 
     Same as _get_installed_packages, but internal to avoid mutating the lru_cache
@@ -192,22 +296,30 @@ def _get_installed_packages_private():
     # 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.
+    if lowercase:
+        package_versions = {k.lower(): v for k, v in package_versions.items()}
     return package_versions
 
 
-def _get_installed_packages():
+def _get_installed_packages(lowercase=False):
     """Get a dictionary of installed packages and their versions.
 
+    Parameters
+    ----------
+    lowercase : bool, default=False
+        whether to lowercase the package names in the returned dictionary.
+
     Returns
     -------
     dict : dictionary of installed packages and their versions
         keys are PEP 440 compatible package names, values are package versions
         MAJOR.MINOR.PATCH version format is used for versions, e.g., "1.2.3"
     """
-    return _get_installed_packages_private().copy()
+    return _get_installed_packages_private(lowercase=lowercase).copy()
 
 
-def _get_pkg_version(package_name):
+@lru_cache
+def _get_pkg_version(package_name, case_sensitive=False):
     """Check whether package is available in environment, and return its version if yes.
 
     Returns ``Version`` object from ``lru_cache``, this should not be mutated.
@@ -220,12 +332,27 @@ def _get_pkg_version(package_name):
         This is the pypi package name, not the import name, e.g.,
         ``scikit-learn``, not ``sklearn``.
 
+    case_sensitive : bool, default=False
+        whether package names are case sensitive or not.
+        pypi package names are case sensitive, but pypi disallows
+        multiple package names that differ only in case.
+        Hence there is at most a single correct case for a given package name,
+        and a user will most likely intend to refer to the correct package,
+        even when providing an incorrect case for the pypi name.
+
+        * If set to True, package names are case sensitive, and None is returned
+          if the correct case is not provided, e.g., ``mapie`` instead of ``MAPIE``.
+        * If set to False, package names are case insensitive, and a version is returned
+          for all case combinations, e.g., ``mapie``, ``MAPIE``, ``Mapie``, ``mApIe``.
+
     Returns
     -------
     None, if package is not found in python environment.
     ``importlib`` ``Version`` of package, if present in environment.
     """
-    pkgs = _get_installed_packages()
+    pkgs = _get_installed_packages(lowercase=not case_sensitive)
+    if not case_sensitive:
+        package_name = package_name.lower()
     pkg_vers_str = pkgs.get(package_name, None)
     if pkg_vers_str is None:
         return None

{scikit_base-0.12.2 → scikit_base-0.12.3}/skbase/utils/dependencies/tests/test_check_dependencies.py

@@ -5,7 +5,10 @@ from unittest.mock import patch
 import pytest
 from packaging.requirements import InvalidRequirement
 
-from skbase.utils.dependencies import _check_python_version, _check_soft_dependencies
+from skbase.utils.dependencies import (
+    _check_python_version,
+    _check_soft_dependencies,
+)
 
 
 def test_check_soft_deps():
@@ -51,6 +54,74 @@ def test_check_soft_deps():
         )
 
 
+def test_check_soft_dependencies_nested():
+    """Test check_soft_dependencies with ."""
+    ALWAYS_INSTALLED = "pytest"  # noqa: N806
+    ALWAYS_INSTALLED2 = "numpy"  # noqa: N806
+    ALWAYS_INSTALLED_W_V = "pytest>=0.5.0"  # noqa: N806
+    ALWAYS_INSTALLED_W_V2 = "numpy>=0.1.0"  # noqa: N806
+    NEVER_INSTALLED = "nonexistent__package_foo_bar"  # noqa: N806
+    NEVER_INSTALLED_W_V = "pytest<0.1.0"  # noqa: N806
+
+    # Test that the function does not raise an error when all dependencies are installed
+    _check_soft_dependencies(ALWAYS_INSTALLED)
+    _check_soft_dependencies(ALWAYS_INSTALLED, ALWAYS_INSTALLED2)
+    _check_soft_dependencies(ALWAYS_INSTALLED_W_V)
+    _check_soft_dependencies(ALWAYS_INSTALLED_W_V, ALWAYS_INSTALLED_W_V2)
+    _check_soft_dependencies(ALWAYS_INSTALLED, ALWAYS_INSTALLED2, ALWAYS_INSTALLED_W_V2)
+    _check_soft_dependencies([ALWAYS_INSTALLED, ALWAYS_INSTALLED2])
+
+    # Test that error is raised when a dependency is not installed
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies(NEVER_INSTALLED)
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies(NEVER_INSTALLED, ALWAYS_INSTALLED)
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies([ALWAYS_INSTALLED, NEVER_INSTALLED])
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies(ALWAYS_INSTALLED, NEVER_INSTALLED_W_V)
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies([ALWAYS_INSTALLED, NEVER_INSTALLED_W_V])
+
+    # disjunction cases, "or" - positive cases
+    _check_soft_dependencies([[ALWAYS_INSTALLED, NEVER_INSTALLED]])
+    _check_soft_dependencies(
+        [
+            [ALWAYS_INSTALLED, NEVER_INSTALLED],
+            [ALWAYS_INSTALLED_W_V, NEVER_INSTALLED_W_V],
+            ALWAYS_INSTALLED2,
+        ]
+    )
+
+    # disjunction cases, "or" - negative cases
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies([[NEVER_INSTALLED, NEVER_INSTALLED_W_V]])
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies(
+            [
+                [NEVER_INSTALLED, NEVER_INSTALLED_W_V],
+                [ALWAYS_INSTALLED, NEVER_INSTALLED],
+                ALWAYS_INSTALLED2,
+            ]
+        )
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies(
+            [
+                ALWAYS_INSTALLED2,
+                [ALWAYS_INSTALLED, NEVER_INSTALLED],
+                NEVER_INSTALLED_W_V,
+            ]
+        )
+    with pytest.raises(ModuleNotFoundError):
+        _check_soft_dependencies(
+            [
+                [ALWAYS_INSTALLED, ALWAYS_INSTALLED2],
+                NEVER_INSTALLED,
+                ALWAYS_INSTALLED2,
+            ]
+        )
+
+
 @patch("skbase.utils.dependencies._dependencies.sys")
 @pytest.mark.parametrize(
     "mock_release_version, prereleases, expect_exception",

scikit_base-0.12.3/skbase/utils/doctest_run.py

@@ -0,0 +1,65 @@
+# -*- coding: utf-8 -*-
+"""Doctest utilities."""
+# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
+
+import contextlib
+import doctest
+import io
+
+
+def run_doctest(
+    f,
+    verbose=False,
+    name=None,
+    compileflags=None,
+    optionflags=doctest.ELLIPSIS,
+    raise_on_error=True,
+):
+    """Run doctests for a given function or class, and return or raise.
+
+    Parameters
+    ----------
+    f : callable
+        Function or class to run doctests for.
+    verbose : bool, optional (default=False)
+        If True, print the results of the doctests.
+    name : str, optional (default=f.__name__, if available, otherwise "NoName")
+        Name of the function or class.
+    compileflags : int, optional (default=None)
+        Flags to pass to the Python parser.
+    optionflags : int, optional (default=doctest.ELLIPSIS)
+        Flags to control the behaviour of the doctest.
+    raise_on_error : bool, optional (default=True)
+        If True, raise an exception if the doctests fail.
+
+    Returns
+    -------
+    doctest_output : str
+        Output of the doctests.
+
+    Raises
+    ------
+    RuntimeError
+        If raise_on_error=True and the doctests fail.
+    """
+    doctest_output_io = io.StringIO()
+    with contextlib.redirect_stdout(doctest_output_io):
+        doctest.run_docstring_examples(
+            f=f,
+            globs=globals(),
+            verbose=verbose,
+            name=name,
+            compileflags=compileflags,
+            optionflags=optionflags,
+        )
+    doctest_output = doctest_output_io.getvalue()
+
+    if name is None:
+        name = f.__name__ if hasattr(f, "__name__") else "NoName"
+
+    if raise_on_error and len(doctest_output) > 0:
+        raise RuntimeError(
+            f"Docstring examples failed doctests "
+            f"for {name}, doctest output: {doctest_output}"
+        )
+    return doctest_output