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

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

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

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

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

@@ -1,6 +1,6 @@
 [project]
 name = "scikit-base"
-version = "1.0.2"
+version = "1.1.1"
 description = "Base classes for sklearn-like parametric objects"
 authors = [
     {name = "sktime developers", email = "sktime.toolbox@gmail.com"},
@@ -144,15 +144,11 @@ exclude_dirs = ["*/tests/*", "*/testing/*"]
 zip-safe = true
 
 [tool.setuptools.package-data]
-sktime = [
+skbase = [
     "*.csv",
     "*.csv.gz",
-    "*.arff",
-    "*.arff.gz",
     "*.txt",
-    "*.ts",
-    "*.tsv",
 ]
 
 [tool.setuptools.packages.find]
-exclude = ["tests", "tests.*"]
+include = ["skbase", "skbase.*"]

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

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

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

@@ -2,7 +2,6 @@ LICENSE
 README.md
 pyproject.toml
 setup.cfg
-docs/source/conf.py
 scikit_base.egg-info/PKG-INFO
 scikit_base.egg-info/SOURCES.txt
 scikit_base.egg-info/dependency_links.txt
@@ -30,6 +29,8 @@ skbase/lookup/tests/__init__.py
 skbase/lookup/tests/test_lookup.py
 skbase/testing/__init__.py
 skbase/testing/test_all_objects.py
+skbase/testing/tests/__init__.py
+skbase/testing/tests/test_quicktester.py
 skbase/testing/utils/__init__.py
 skbase/testing/utils/_conditional_fixtures.py
 skbase/testing/utils/inspect.py

scikit_base-1.1.1/scikit_base.egg-info/top_level.txt

@@ -0,0 +1 @@
+skbase

{scikit_base-1.0.2 → scikit_base-1.1.1}/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.2"
+__version__: str = "1.1.1"

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

@@ -58,6 +58,7 @@ import re
 import warnings
 from collections import defaultdict
 from copy import deepcopy
+from functools import lru_cache
 from inspect import isclass
 from typing import List
 
@@ -214,6 +215,7 @@ class BaseObject(_FlagManager):
         return None
 
     @classmethod
+    @lru_cache(maxsize=None)
     def _get_init_signature(cls):
         """Get class init signature.
 

{scikit_base-1.0.2 → scikit_base-1.1.1}/skbase/base/_tagmanager.py

@@ -9,11 +9,30 @@ __all__ = ["_FlagManager"]
 
 import inspect
 from copy import deepcopy
+from functools import lru_cache
 
 
 class _FlagManager:
     """Mixin class for flag and configuration settings management."""
 
+    @staticmethod
+    @lru_cache(maxsize=None)
+    def _collect_class_flags_cached(cls, flag_attr_name):
+        """Walk the MRO once per (cls, flag_attr_name) and cache the result.
+
+        Returns the dict directly; callers are responsible for copying it
+        before handing it out or mutating it, since this is a shared cached
+        object.
+        """
+        collected_flags = {}
+        for parent_class in reversed(inspect.getmro(cls)):
+            if parent_class is object:
+                continue
+            if flag_attr_name in parent_class.__dict__:
+                more_flags = parent_class.__dict__[flag_attr_name]
+                collected_flags.update(more_flags)
+        return collected_flags
+
     @classmethod
     def _get_class_flags(cls, flag_attr_name="_flags"):
         """Get class flags from estimator class and all its parent classes.
@@ -30,19 +49,10 @@ class _FlagManager:
             class attribute via nested inheritance. NOT overridden by dynamic
             flags set by set_flags or clone_flags.
         """
-        collected_flags = {}
-
-        # To ensure flags from Mixins placed after BaseObject in the MRO are not
-        # dropped, iterate over the full MRO and skip only the `object` sentinel.
-        for parent_class in reversed(inspect.getmro(cls)):
-            if parent_class is object:
-                continue
-            if flag_attr_name in parent_class.__dict__:
-                # Check own __dict__ to avoid MRO-inherited duplicates
-                more_flags = parent_class.__dict__[flag_attr_name]
-                collected_flags.update(more_flags)
-
-        return deepcopy(collected_flags)
+        cached = cls._collect_class_flags_cached(cls, flag_attr_name)
+        # shallow copy: cheap, and safe because tag values are immutable
+        # (they are primitives types bool, etc.)
+        return dict(cached)
 
     @classmethod
     def _get_class_flag(
@@ -101,12 +111,15 @@ class _FlagManager:
             class attribute via nested inheritance and then any overrides
             and new flags from [flag_attr_name]_dynamic object attribute.
         """
-        collected_flags = self._get_class_flags(flag_attr_name=flag_attr_name)
+        # shallow copy of the cached class-level dict
+        collected_flags = dict(
+            self._collect_class_flags_cached(type(self), flag_attr_name)
+        )
 
         if hasattr(self, f"{flag_attr_name}_dynamic"):
             collected_flags.update(getattr(self, f"{flag_attr_name}_dynamic"))
 
-        return deepcopy(collected_flags)
+        return collected_flags
 
     def _get_flag(
         self,

{scikit_base-1.0.2 → scikit_base-1.1.1}/skbase/testing/test_all_objects.py

@@ -342,6 +342,7 @@ class QuickTester:
         """
         from _pytest.outcomes import Skipped
 
+        from skbase.utils.stderr_mute import StderrMute
         from skbase.utils.stdout_mute import StdoutMute
 
         tests_to_run = self._check_none_str_or_list_of_str(
@@ -464,7 +465,10 @@ class QuickTester:
                 print_if_verbose(f"{key}")
 
                 try:
-                    with StdoutMute(active=verbose < 2):
+                    with (
+                        StdoutMute(active=verbose < 2),
+                        StderrMute(active=verbose < 2),
+                    ):
                         test_fun(**deepcopy(args))
                     results[key] = "PASSED"
                     print_if_verbose("PASSED")
@@ -541,7 +545,7 @@ class QuickTester:
                 obj = [obj]
             if not isinstance(obj, list):
                 raise ValueError(msg)
-            if not np.all(isinstance(x, str) for x in obj):
+            if not np.all([isinstance(x, str) for x in obj]):
                 raise ValueError(msg)
         return obj
 
@@ -715,12 +719,12 @@ class TestAllObjects(BaseFixtureGenerator, QuickTester):
             f"found {type(names)}"
         )
 
-        assert np.all(isinstance(est, object_class) for est in objects), (
+        assert np.all([isinstance(est, object_class) for est in objects]), (
             "list elements of first return returned by create_test_instances_and_names "
             "all must be an instance of the class"
         )
 
-        assert np.all(isinstance(name, names) for name in names), (
+        assert np.all([isinstance(name, str) for name in names]), (
             "list elements of second return returned by create_test_instances_and_names"
             " all must be strings"
         )

scikit_base-1.1.1/skbase/testing/tests/__init__.py

@@ -0,0 +1,2 @@
+# -*- coding: utf-8 -*-
+"""Tests for the skbase testing module."""

scikit_base-1.1.1/skbase/testing/tests/test_quicktester.py

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+"""Regression tests for QuickTester input checks and output muting."""
+
+import sys
+from typing import List
+
+import pytest
+
+from skbase.testing import BaseFixtureGenerator, QuickTester
+from skbase.tests.conftest import Parent
+
+__author__: List[str] = ["yash-sangwan"]
+
+
+class _NoisyTester(BaseFixtureGenerator, QuickTester):
+    """Minimal test class that writes to both output streams."""
+
+    def test_writes_to_streams(self, object_class):
+        """Write a marker to stdout and to stderr."""
+        sys.stdout.write("stdout-marker")
+        sys.stderr.write("stderr-marker")
+
+
+@pytest.mark.parametrize("bad", [42, ["a", 5], {"a": 1}])
+def test_check_none_str_or_list_of_str_rejects_invalid(bad):
+    """Invalid input raises; a generator passed to np.all would never raise."""
+    with pytest.raises(ValueError, match="must be None, str, or list of str"):
+        QuickTester._check_none_str_or_list_of_str(bad, var_name="x")
+
+
+@pytest.mark.parametrize(
+    "good, expected", [(None, None), ("a", ["a"]), (["a", "b"], ["a", "b"])]
+)
+def test_check_none_str_or_list_of_str_accepts_valid(good, expected):
+    """Valid input is returned, coerced to list of str."""
+    assert QuickTester._check_none_str_or_list_of_str(good, var_name="x") == expected
+
+
+@pytest.mark.parametrize("verbose, muted", [(0, True), (2, False)])
+def test_run_tests_mutes_stdout_and_stderr(capsys, verbose, muted):
+    """Both streams are muted below verbose=2, and both are shown at verbose=2."""
+    _NoisyTester().run_tests(
+        Parent, tests_to_run="test_writes_to_streams", verbose=verbose
+    )
+    captured = capsys.readouterr()
+    assert ("stdout-marker" not in captured.out) is muted
+    assert ("stderr-marker" not in captured.err) is muted

{scikit_base-1.0.2 → scikit_base-1.1.1}/skbase/utils/dependencies/_import.py

@@ -23,7 +23,6 @@ def _safe_import(import_path, pkg_name=None, condition=True, return_object="Magi
 
     Example: ``clone = _safe_import("sklearn.clone", pkg_name="scikit-learn")``.
 
-
     Parameters
     ----------
     import_path : str

scikit_base-1.0.2/docs/source/conf.py

@@ -1,304 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-# copyright: skbase developers, BSD-3-Clause License (see LICENSE file)
-"""Configure skbase Sphinx documentation."""
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-
-import datetime
-import inspect
-import os
-import sys
-
-import skbase
-
-# -- Path setup --------------------------------------------------------------
-
-# When we build the docs on readthedocs, we build the package and want to
-# use the built files in order for sphinx to be able to properly read the
-# Cython files. Hence, we do not add the source code path to the system path.
-env_rtd = os.environ.get("READTHEDOCS")
-# Check if on Read the docs
-if not env_rtd == "True":
-    print("Not on ReadTheDocs")
-    sys.path.insert(0, os.path.abspath("../.."))
-
-# -- Project information -----------------------------------------------------
-
-current_year = datetime.datetime.now().year
-project = "skbase"
-copyright = f"{current_year} (BSD-3-Clause License)"
-author = "skbase Developers"
-
-
-# The full version, including alpha/beta/rc tags
-release = skbase.__version__
-
-# -- General configuration ---------------------------------------------------
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
-extensions = [
-    "sphinx.ext.autodoc",
-    "sphinx.ext.autosummary",
-    "numpydoc",
-    "sphinx.ext.intersphinx",
-    "sphinx.ext.linkcode",  # link to GitHub source code via linkcode_resolve()
-    "nbsphinx",  # integrates example notebooks
-    "sphinx_gallery.load_style",
-    "myst_parser",
-    "sphinx_panels",
-    "sphinx_issues",
-    "sphinx_design",
-]
-
-myst_enable_extensions = ["colon_fence"]
-
-# -- Internationalization ------------------------------------------------
-# specifying the natural language populates some key tags
-language = "en"
-
-# Use bootstrap CSS from theme.
-panels_add_bootstrap_css = False
-
-# Add any paths that contain templates here, relative to this directory.
-templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-source_suffix = {
-    ".rst": "restructuredtext",
-    ".md": "markdown",
-}
-
-# The main toctree document.
-master_doc = "index"
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
-
-# add_module_names = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
-
-# Members and inherited-members default to showing methods and attributes from
-# a class or those inherited.
-# Member-order orders the documentation in the order of how the members are
-# defined in the source code.
-autodoc_default_options = {
-    "members": True,
-    "inherited-members": True,
-    "member-order": "bysource",
-}
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-add_function_parentheses = False
-
-# Link to GitHub repo for github_issues extension
-issues_github_path = "sktime/skbase"
-
-
-def linkcode_resolve(domain, info):
-    """Return URL to source code corresponding.
-
-    Parameters
-    ----------
-    domain : str
-    info : dict
-
-    Returns
-    -------
-    url : str
-    """
-
-    def find_source():
-        # try to find the file and line number, based on code from numpy:
-        # https://github.com/numpy/numpy/blob/main/doc/source/conf.py#L286
-        obj = sys.modules[info["module"]]
-        for part in info["fullname"].split("."):
-            obj = getattr(obj, part)
-
-        fn = inspect.getsourcefile(obj)
-        fn = os.path.relpath(fn, start=os.path.dirname(skbase.__file__))
-        source, lineno = inspect.getsourcelines(obj)
-        return fn, lineno, lineno + len(source) - 1
-
-    if domain != "py" or not info["module"]:
-        return None
-    try:
-        filename = "skbase/%s#L%d-L%d" % find_source()
-    except Exception:
-        filename = info["module"].replace(".", "/") + ".py"
-    return f"https://github.com/sktime/skbase/blob/{version_match}/{filename}"
-
-
-# -- Options for HTML output -------------------------------------------------
-
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-
-html_theme = "pydata_sphinx_theme"
-
-# Define the json_url for our version switcher.
-json_url = "https://skbase.readthedocs.io/en/latest/_static/switcher.json"
-
-# This uses code from the py-data-sphinx theme's own conf.py
-# Define the version we use for matching in the version switcher.
-version_match = os.environ.get("READTHEDOCS_VERSION")
-
-# If READTHEDOCS_VERSION doesn't exist, we're not on RTD
-# If it is an integer, we're in a PR build and the version isn't correct.
-if not version_match or version_match.isdigit():
-    # For local development, infer the version to match from the package.
-    if "dev" in release or "rc" in release:
-        version_match = "latest"
-        # We want to keep the relative reference if we are in dev mode
-        # but we want the whole url if we are effectively in a released version
-        json_url = "_static/switcher.json"
-    else:
-        version_match = "v" + release
-
-html_theme_options = {
-    "logo": {
-        "text": "skbase",
-        "alt_text": "skbase",
-    },
-    "icon_links": [
-        {
-            "name": "GitHub",
-            "url": "https://github.com/sktime/skbase",
-            "icon": "fab fa-github",
-        },
-        {
-            "name": "Discord",
-            "url": "https://discord.com/invite/54ACzaFsn7",
-            "icon": "fab fa-discord",
-        },
-        {
-            "name": "LinkedIn",
-            "url": "https://www.linkedin.com/company/scikit-time/",
-            "icon": "fab fa-linkedin",
-        },
-        {
-            "name": "PyPI",
-            "url": "https://pypi.org/project/skbase",
-            "icon": "fa-solid fa-box",
-        },
-    ],
-    "icon_links_label": "Quick Links",
-    "show_nav_level": 1,
-    "show_prev_next": False,
-    "use_edit_page_button": False,
-    "navbar_start": ["navbar-logo", "version-switcher"],
-    "navbar_center": ["navbar-nav"],
-    "switcher": {
-        "json_url": json_url,
-        "version_match": version_match,
-    },
-    "header_links_before_dropdown": 6,
-}
-
-html_context = {
-    "github_user": "sktime",
-    "github_repo": "skbase",
-    "github_version": "main",
-    "doc_path": "docs/source/",
-    "default_mode": "light",
-}
-html_sidebars = {"**": ["sidebar-nav-bs.html", "sidebar-ethical-ads.html"]}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ["_static"]
-
-# -- Options for HTMLHelp output ---------------------------------------------
-# Output file base name for HTML help builder.
-htmlhelp_basename = "skbasedoc"
-
-
-# -- Options for LaTeX output ------------------------------------------------
-# latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-# 'papersize': 'letterpaper',
-# The font size ('10pt', '11pt' or '12pt').
-# 'pointsize': '10pt',
-# Additional stuff for the LaTeX preamble.
-# 'preamble': '',
-# Latex figure (float) alignment
-# 'figure_align': 'htbp',
-# }
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (
-        master_doc,
-        "skbase.tex",
-        "skbase Documentation",
-        "skbase developers",
-        "manual",
-    ),
-]
-
-# -- Extension configuration -------------------------------------------------
-
-# -- Options for numpydoc extension ------------------------------------------
-# see http://stackoverflow.com/q/12206334/562769
-numpydoc_show_class_members = True
-# this is needed for some reason...
-# see https://github.com/numpy/numpydoc/issues/69
-numpydoc_class_members_toctree = False
-
-numpydoc_validation_checks = {"all", "GL01", "SA01", "EX01"}
-
-# -- Options for sphinx-copybutton extension----------------------------------
-copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: "
-copybutton_prompt_is_regexp = True
-
-# -- Options for nbsphinx extension ------------------------------------------
-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 button at the top
-current_file = "{{ env.doc2path( env.docname, base=None) }}"
-
-# make sure Binder points to latest stable release, not main
-binder_base = "https://mybinder.org/v2/gh//skbase/"
-binder_url = binder_base + f"{version_match}?filepath={current_file}"
-nbsphinx_prolog = f"""
-.. |binder| image:: https://mybinder.org/badge_logo.svg
-.. _Binder: {binder_url}
-
-|Binder|_
-"""
-
-# add link to original notebook at the bottom
-notebook_url = f"https://github.com/sktime/skbase/tree/{version_match}/{current_file}"
-nbsphinx_epilog = f"""
-----
-
-Generated using nbsphinx_. The Jupyter notebook can be found here_.
-
-.. _here: {notebook_url}
-.. _nbsphinx: https://nbsphinx.readthedocs.io/
-"""
-
-# -- Options for intersphinx extension ---------------------------------------
-
-# Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {
-    "python": ("https://docs.python.org/{.major}".format(sys.version_info), None),
-    "scikit-learn": ("https://scikit-learn.org/stable/", None),
-    "sktime": ("https://www.sktime.net/en/stable/", None),
-}

scikit_base-1.0.2/scikit_base.egg-info/top_level.txt

@@ -1,5 +0,0 @@
-build_tools
-docs
-enhancement_proposals
-skbase
-wheelhouse