param 2.1.1rc2__tar.gz → 2.2.0a1__tar.gz

{param-2.1.1rc2 → param-2.2.0a1}/.gitignore

@@ -19,7 +19,7 @@ builtdocs/
 jupyter_execute/
 doc/Reference_Manual/
 doc/user_guide/data.pickle
-doc/user_guide/output.csv
+doc/user_guide/output.*
 doc/reference/generated
 
 # Unit test / Coverage report
@@ -32,3 +32,7 @@ param/_version.py
 # asv benchmark
 benchmarks/.asv
 benchmarks/param
+
+# pixi
+.pixi
+pixi.lock

{param-2.1.1rc2 → param-2.2.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: param
-Version: 2.1.1rc2
+Version: 2.2.0a1
 Summary: Make your Python code clearer and more reliable by declaring Parameters.
 Project-URL: Homepage, https://param.holoviz.org/
 Project-URL: Tracker, https://github.com/holoviz/param/issues
@@ -23,18 +23,16 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.8
 Provides-Extra: all
 Requires-Dist: aiohttp; extra == 'all'
 Requires-Dist: cloudpickle; extra == 'all'
-Requires-Dist: coverage[toml]; extra == 'all'
-Requires-Dist: flake8; extra == 'all'
 Requires-Dist: gmpy; extra == 'all'
 Requires-Dist: ipython; extra == 'all'
 Requires-Dist: jsonschema; extra == 'all'
-Requires-Dist: nbsite==0.8.4; extra == 'all'
 Requires-Dist: nbval; extra == 'all'
 Requires-Dist: nest-asyncio; extra == 'all'
 Requires-Dist: numpy; extra == 'all'
@@ -42,29 +40,17 @@ Requires-Dist: odfpy; extra == 'all'
 Requires-Dist: openpyxl; extra == 'all'
 Requires-Dist: pandas; extra == 'all'
 Requires-Dist: panel; extra == 'all'
-Requires-Dist: pre-commit; extra == 'all'
 Requires-Dist: pyarrow; extra == 'all'
 Requires-Dist: pytest; extra == 'all'
 Requires-Dist: pytest-asyncio; extra == 'all'
 Requires-Dist: pytest-xdist; extra == 'all'
-Requires-Dist: sphinx-remove-toctrees; extra == 'all'
 Requires-Dist: tables; extra == 'all'
 Requires-Dist: xlrd; extra == 'all'
-Provides-Extra: doc
-Requires-Dist: aiohttp; extra == 'doc'
-Requires-Dist: nbsite==0.8.4; extra == 'doc'
-Requires-Dist: pandas; extra == 'doc'
-Requires-Dist: panel; extra == 'doc'
-Requires-Dist: sphinx-remove-toctrees; extra == 'doc'
 Provides-Extra: examples
 Requires-Dist: aiohttp; extra == 'examples'
 Requires-Dist: pandas; extra == 'examples'
 Requires-Dist: panel; extra == 'examples'
-Provides-Extra: lint
-Requires-Dist: flake8; extra == 'lint'
-Requires-Dist: pre-commit; extra == 'lint'
 Provides-Extra: tests
-Requires-Dist: coverage[toml]; extra == 'tests'
 Requires-Dist: pytest; extra == 'tests'
 Requires-Dist: pytest-asyncio; extra == 'tests'
 Provides-Extra: tests-deser
@@ -84,7 +70,6 @@ Requires-Dist: pytest-xdist; extra == 'tests-examples'
 Provides-Extra: tests-full
 Requires-Dist: aiohttp; extra == 'tests-full'
 Requires-Dist: cloudpickle; extra == 'tests-full'
-Requires-Dist: coverage[toml]; extra == 'tests-full'
 Requires-Dist: gmpy; extra == 'tests-full'
 Requires-Dist: ipython; extra == 'tests-full'
 Requires-Dist: jsonschema; extra == 'tests-full'

{param-2.1.1rc2 → param-2.2.0a1}/numbergen/__init__.py

@@ -1,6 +1,4 @@
-"""
-Callable objects that generate numbers according to different distributions.
-"""
+"""Callable objects that generate numbers according to different distributions."""
 
 import random
 import operator
@@ -14,7 +12,7 @@ from math import e,pi
 import param
 
 
-from param import __version__  # noqa: API import
+from param import __version__
 
 class TimeAware(param.Parameterized):
     """
@@ -135,7 +133,7 @@ operator_symbols = {
 }
 
 def pprint(x, *args, **kwargs):
-    "Pretty-print the provided item, translating operators to their symbols"
+    """Pretty-print the provided item, translating operators to their symbols"""
     return x.pprint(*args, **kwargs) if hasattr(x,'pprint') else operator_symbols.get(x, repr(x))
 
 
@@ -214,6 +212,7 @@ class Hash:
     for __call__ must be specified in the constructor and must stay
     constant across calls.
     """
+
     def __init__(self, name, input_count):
         self.name = name
         self.input_count = input_count
@@ -224,7 +223,6 @@ class Hash:
 
     def _rational(self, val):
         """Convert the given value to a rational, if necessary."""
-
         I32 = 4294967296 # Maximum 32 bit unsigned int (i.e. 'I') value
         if isinstance(val, int):
             numer, denom = val, 1
@@ -241,9 +239,7 @@ class Hash:
 
 
     def __getstate__(self):
-        """
-        Avoid Hashlib.md5 TypeError in deepcopy (hashlib issue)
-        """
+        """Avoid Hashlib.md5 TypeError in deepcopy (hashlib issue)"""
         d = self.__dict__.copy()
         d.pop('_digest')
         d.pop('_hash_struct')
@@ -374,9 +370,7 @@ class TimeAwareRandomState(TimeAware):
 
 
     def _verify_constrained_hash(self):
-        """
-        Warn if the object name is not explicitly set.
-        """
+        """Warn if the object name is not explicitly set."""
         changed_params = self.param.values(onlychanged=True)
         if self.time_dependent and ('name' not in changed_params):
             self.param.log(param.WARNING, "Default object name used to set the seed: "
@@ -575,9 +569,7 @@ class VonMisesRandom(RandomDistribution):
 
 
 class ScaledTime(NumberGenerator, TimeDependent):
-    """
-    The current time multiplied by some conversion factor.
-    """
+    """The current time multiplied by some conversion factor."""
 
     factor = param.Number(default=1.0, doc="""
        The factor to be multiplied by the current time value.""")
@@ -763,5 +755,5 @@ class BoundedNumber(NumberGenerator):
         else: return val
 
 
-_public = list({_k for _k,_v in locals().items() if isinstance(_v,type) and issubclass(_v,NumberGenerator)})
-__all__ = _public
+_public = {_k for _k,_v in locals().items() if isinstance(_v,type) and issubclass(_v,NumberGenerator)}
+__all__ = ["__version__", *_public]

{param-2.1.1rc2 → param-2.2.0a1}/param/_utils.py

@@ -1,22 +1,30 @@
+from __future__ import annotations
+
 import asyncio
 import collections
 import contextvars
 import datetime as dt
-import inspect
 import functools
+import inspect
 import numbers
 import os
 import re
 import sys
 import traceback
 import warnings
-
-from collections import defaultdict, OrderedDict
+from collections import OrderedDict, abc, defaultdict
 from contextlib import contextmanager
 from numbers import Real
 from textwrap import dedent
 from threading import get_ident
-from collections import abc
+from typing import TYPE_CHECKING, Callable, TypeVar
+
+if TYPE_CHECKING:
+    from typing_extensions import Concatenate, ParamSpec
+
+    P = ParamSpec("P")
+    R = TypeVar("R")
+    CallableT = TypeVar("CallableT", bound=Callable)
 
 DEFAULT_SIGNATURE = inspect.Signature([
     inspect.Parameter('self', inspect.Parameter.POSITIONAL_OR_KEYWORD),
@@ -29,7 +37,8 @@ class ParamWarning(Warning):
     """Base Param Warning"""
 
 class ParamPendingDeprecationWarning(ParamWarning, PendingDeprecationWarning):
-    """Param PendingDeprecationWarning
+    """
+    Param PendingDeprecationWarning
 
     This warning type is useful when the warning is not meant to be displayed
     to REPL/notebooks users, as DeprecationWarning are displayed when triggered
@@ -38,22 +47,22 @@ class ParamPendingDeprecationWarning(ParamWarning, PendingDeprecationWarning):
 
 
 class ParamDeprecationWarning(ParamWarning, DeprecationWarning):
-    """Param DeprecationWarning
+    """
+    Param DeprecationWarning
 
     Ignored by default except when triggered by code in __main__
     """
 
 
 class ParamFutureWarning(ParamWarning, FutureWarning):
-    """Param FutureWarning
+    """
+    Param FutureWarning
 
     Always displayed.
     """
 
 class Skip(Exception):
-    """
-    Exception that allows skipping an update when resolving a reference.
-    """
+    """Exception that allows skipping an update when resolving a reference."""
 
 def _deprecated(extra_msg="", warning_cat=ParamDeprecationWarning):
     def decorator(func):
@@ -72,7 +81,8 @@ def _deprecated(extra_msg="", warning_cat=ParamDeprecationWarning):
 
 
 def _deprecate_positional_args(func):
-    """Internal decorator for methods that issues warnings for positional arguments
+    """
+    Internal decorator for methods that issues warnings for positional arguments
     Using the keyword-only argument syntax in pep 3102, arguments after the
     ``*`` will issue a warning when passed as a positional argument.
     Adapted from scikit-learn
@@ -98,7 +108,7 @@ def _deprecate_positional_args(func):
                 f"Passing '{extra_args}' as positional argument(s) to 'param.{name}' "
                 "has been deprecated since Param 2.0.0 and will raise an error in a future version, "
                 "please pass them as keyword arguments.",
-                ParamDeprecationWarning,
+                ParamFutureWarning,
                 stacklevel=2,
             )
 
@@ -114,7 +124,7 @@ def _deprecate_positional_args(func):
 
 # Copy of Python 3.2 reprlib's recursive_repr but allowing extra arguments
 def _recursive_repr(fillvalue='...'):
-    'Decorator to make a repr function return fillvalue for a recursive call'
+    """Decorator to make a repr function return fillvalue for a recursive call"""
 
     def decorating_function(user_function):
         repr_running = set()
@@ -192,22 +202,11 @@ def _validate_error_prefix(parameter, attribute=None):
 
 def _is_mutable_container(value):
     """True for mutable containers, which typically need special handling when being copied"""
-    return issubclass(type(value), MUTABLE_TYPES)
-
-
-def _dict_update(dictionary, **kwargs):
-    """
-    Small utility to update a copy of a dict with the provided keyword args.
-    """
-    d = dictionary.copy()
-    d.update(kwargs)
-    return d
+    return isinstance(value, MUTABLE_TYPES)
 
 
 def full_groupby(l, key=lambda x: x):
-    """
-    Groupby implementation which does not require a prior sort
-    """
+    """Groupby implementation which does not require a prior sort"""
     d = defaultdict(list)
     for item in l:
         d[key(item)].append(item)
@@ -215,9 +214,7 @@ def full_groupby(l, key=lambda x: x):
 
 
 def iscoroutinefunction(function):
-    """
-    Whether the function is an asynchronous generator or a coroutine.
-    """
+    """Whether the function is an asynchronous generator or a coroutine."""
     # Partial unwrapping not required starting from Python 3.11.0
     # See https://github.com/holoviz/param/pull/894#issuecomment-1867084447
     while isinstance(function, functools.partial):
@@ -228,9 +225,7 @@ def iscoroutinefunction(function):
     )
 
 async def _to_thread(func, /, *args, **kwargs):
-    """
-    Polyfill for asyncio.to_thread in Python < 3.9
-    """
+    """Polyfill for asyncio.to_thread in Python < 3.9"""
     loop = asyncio.get_running_loop()
     ctx = contextvars.copy_context()
     func_call = functools.partial(ctx.run, func, *args, **kwargs)
@@ -274,6 +269,7 @@ def flatten(line):
     Returns
     -------
     flattened : generator
+
     """
     for element in line:
         if any(isinstance(element, tp) for tp in (list, tuple, dict)):
@@ -282,12 +278,12 @@ def flatten(line):
             yield element
 
 
-def accept_arguments(f):
-    """
-    Decorator for decorators that accept arguments
-    """
+def accept_arguments(
+    f: Callable[Concatenate[CallableT, P], R]
+) -> Callable[P, Callable[[CallableT], R]]:
+    """Decorator for decorators that accept arguments"""
     @functools.wraps(f)
-    def _f(*args, **kwargs):
+    def _f(*args: P.args, **kwargs: P.kwargs) -> Callable[[CallableT], R]:
         return lambda actual_f: f(actual_f, *args, **kwargs)
     return _f
 
@@ -305,7 +301,7 @@ def _produce_value(value_obj):
 
 
 # PARAM3_DEPRECATION
-@_deprecated()
+@_deprecated(warning_cat=ParamFutureWarning)
 def produce_value(value_obj):
     """
     A helper function that produces an actual parameter from a stored
@@ -318,7 +314,7 @@ def produce_value(value_obj):
 
 
 # PARAM3_DEPRECATION
-@_deprecated()
+@_deprecated(warning_cat=ParamFutureWarning)
 def as_unicode(obj):
     """
     Safely casts any object to unicode including regular string
@@ -330,7 +326,7 @@ def as_unicode(obj):
 
 
 # PARAM3_DEPRECATION
-@_deprecated()
+@_deprecated(warning_cat=ParamFutureWarning)
 def is_ordered_dict(d):
     """
     Predicate checking for ordered dictionaries. OrderedDict is always
@@ -361,7 +357,7 @@ def _hashable(x):
 
 
 # PARAM3_DEPRECATION
-@_deprecated()
+@_deprecated(warning_cat=ParamFutureWarning)
 def hashable(x):
     """
     Return a hashable version of the given object x, with lists and
@@ -410,7 +406,7 @@ def _named_objs(objlist, namesdict=None):
 
 
 # PARAM3_DEPRECATION
-@_deprecated()
+@_deprecated(warning_cat=ParamFutureWarning)
 def named_objs(objlist, namesdict=None):
     """
     Given a list of objects, returns a dictionary mapping from
@@ -548,7 +544,7 @@ def _abbreviate_paths(pathspec,named_paths):
 
 
 # PARAM3_DEPRECATION
-@_deprecated()
+@_deprecated(warning_cat=ParamFutureWarning)
 def abbreviate_paths(pathspec,named_paths):
     """
     Given a dict of (pathname,path) pairs, removes any prefix shared by all pathnames.
@@ -571,7 +567,8 @@ def _to_datetime(x):
 
 @contextmanager
 def exceptions_summarized():
-    """Useful utility for writing docs that need to show expected errors.
+    """
+    Useful utility for writing docs that need to show expected errors.
     Shows exception only, concisely, without a traceback.
     """
     try:
@@ -602,3 +599,28 @@ def async_executor(func):
         task.add_done_callback(_running_tasks.discard)
     else:
         event_loop.run_until_complete(func())
+
+class _GeneratorIsMeta(type):
+    def __instancecheck__(cls, inst):
+        return isinstance(inst, tuple(cls.types()))
+
+    def __subclasscheck__(cls, sub):
+        return issubclass(sub, tuple(cls.types()))
+
+    def __iter__(cls):
+        yield from cls.types()
+
+class _GeneratorIs(metaclass=_GeneratorIsMeta):
+    @classmethod
+    def __iter__(cls):
+        yield from cls.types()
+
+def gen_types(gen_func):
+    """
+    Decorator which takes a generator function which yields difference types
+    make it so it can be called with isinstance and issubclass.
+    """
+    if not inspect.isgeneratorfunction(gen_func):
+        msg = "gen_types decorator can only be applied to generator"
+        raise TypeError(msg)
+    return type(gen_func.__name__, (_GeneratorIs,), {"types": staticmethod(gen_func)})

{param-2.1.1rc2 → param-2.2.0a1}/param/_version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '2.1.1rc2'
-__version_tuple__ = version_tuple = (2, 1, 1)
+__version__ = version = '2.2.0a1'
+__version_tuple__ = version_tuple = (2, 2, 0)

{param-2.1.1rc2 → param-2.2.0a1}/param/depends.py

@@ -1,17 +1,48 @@
+from __future__ import annotations
+
 import inspect
 
 from collections import defaultdict
 from functools import wraps
+from typing import TYPE_CHECKING, TypeVar, Callable, Protocol, TypedDict, overload
 
 from .parameterized import (
     Parameter, Parameterized, ParameterizedMetaclass, transform_reference,
 )
 from ._utils import accept_arguments, iscoroutinefunction
 
+if TYPE_CHECKING:
+    CallableT = TypeVar("CallableT", bound=Callable)
+    Dependency = Parameter | str
+
+    class DependencyInfo(TypedDict):
+        dependencies: tuple[Dependency, ...]
+        kw: dict[str, Dependency]
+        watch: bool
+        on_init: bool
+
+    class DependsFunc(Protocol[CallableT]):
+        _dinfo: DependencyInfo
+        __call__: CallableT
+
+@overload
+def depends(
+    *dependencies: str, watch: bool = ..., on_init: bool = ...
+) -> Callable[[CallableT], DependsFunc[CallableT]]:
+    ...
+
+@overload
+def depends(
+    *dependencies: Parameter, watch: bool = ..., on_init: bool = ..., **kw: Parameter
+) -> Callable[[CallableT], DependsFunc[CallableT]]:
+    ...
 
 @accept_arguments
-def depends(func, *dependencies, watch=False, on_init=False, **kw):
-    """Annotates a function or Parameterized method to express its dependencies.
+def depends(
+    func: CallableT, /, *dependencies: Dependency, watch: bool = False, on_init: bool = False, **kw: Parameter
+) -> Callable[[CallableT], DependsFunc[CallableT]]:
+    """
+    Annotates a function or Parameterized method to express its dependencies.
 
     The specified dependencies can be either be Parameter instances or if a
     method is supplied they can be defined as strings referring to Parameters
@@ -27,6 +58,7 @@ def depends(func, *dependencies, watch=False, on_init=False, **kw):
     on_init : bool, optional
         Whether to invoke the function/method when the instance is created,
         by default False
+
     """
     dependencies, kw = (
         tuple(transform_reference(arg) for arg in dependencies),
@@ -117,6 +149,6 @@ def depends(func, *dependencies, watch=False, on_init=False, **kw):
     _dinfo.update({'dependencies': dependencies,
                    'kw': kw, 'watch': watch, 'on_init': on_init})
 
-    _depends._dinfo = _dinfo
+    _depends._dinfo = _dinfo  # type: ignore[attr-defined]
 
     return _depends

{param-2.1.1rc2 → param-2.2.0a1}/param/ipython.py

@@ -61,7 +61,6 @@ class ParamPager:
         and the dictionary of parameter values. If include_super is
         True, parameters are also collected from the super classes.
         """
-
         params = dict(obj.param.objects('existing'))
         if isinstance(obj,type):
             changed = []
@@ -86,12 +85,11 @@ class ParamPager:
         docstrings in a clean format (alternating red and blue for
         readability).
         """
-
         (params, val_dict, changed) = info
         contents = []
         displayed_params = []
         for name in self.sort_by_precedence(params):
-            if only_changed and not (name in changed):
+            if only_changed and name not in changed:
                 continue
             displayed_params.append((name, params[name]))
 
@@ -147,7 +145,6 @@ class ParamPager:
         Collect the information about parameters needed to build a
         properly formatted table and then tabulate it.
         """
-
         info_list, bounds_dict = [], {}
         (params, val_dict, changed) = info
         col_widths = {k:0 for k in order}
@@ -155,7 +152,7 @@ class ParamPager:
         ordering = self.sort_by_precedence(params)
         for name in ordering:
             p = params[name]
-            if only_changed and not (name in changed):
+            if only_changed and name not in changed:
                 continue
 
             constant = 'C' if p.constant else 'V'
@@ -209,7 +206,6 @@ class ParamPager:
         order:      The order of the table columns
         bound_dict: Dictionary of appropriately formatted bounds
         """
-
         contents, tail = [], []
         column_set = {k for _, row in info_list for k in row}
         columns = [col for col in order if col in column_set]
@@ -316,6 +312,7 @@ def load_ipython_extension(ip, verbose=True):
         Implements the %params line magic used to inspect the parameters
         of a parameterized class or object.
         """
+
         def __init__(self, *args, **kwargs):
             super().__init__(*args, **kwargs)
             self.param_pager = ParamPager()
@@ -353,9 +350,7 @@ def load_ipython_extension(ip, verbose=True):
 
 
 class IPythonDisplay:
-    """
-    Reactive display handler that updates the output.
-    """
+    """Reactive display handler that updates the output."""
 
     enabled = True