param 2.2.1rc2__tar.gz → 2.3.0a1__tar.gz

{param-2.2.1rc2 → param-2.3.0a1}/.gitignore

@@ -20,7 +20,7 @@ jupyter_execute/
 doc/Reference_Manual/
 doc/user_guide/data.pickle
 doc/user_guide/output.*
-doc/reference/generated
+doc/reference/param/generated
 
 # Unit test / Coverage report
 .coverage

{param-2.2.1rc2 → param-2.3.0a1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: param
-Version: 2.2.1rc2
+Version: 2.3.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
@@ -18,18 +18,18 @@ Classifier: License :: OSI Approved :: BSD License
 Classifier: Natural Language :: English
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-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: Programming Language :: Python :: 3.14
 Classifier: Topic :: Scientific/Engineering
 Classifier: Topic :: Software Development :: Libraries
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Provides-Extra: all
 Requires-Dist: aiohttp; extra == 'all'
 Requires-Dist: cloudpickle; extra == 'all'
-Requires-Dist: gmpy; extra == 'all'
+Requires-Dist: gmpy2; extra == 'all'
 Requires-Dist: ipython; extra == 'all'
 Requires-Dist: jsonschema; extra == 'all'
 Requires-Dist: nbval; extra == 'all'
@@ -42,6 +42,7 @@ Requires-Dist: panel; extra == 'all'
 Requires-Dist: pyarrow; extra == 'all'
 Requires-Dist: pytest; extra == 'all'
 Requires-Dist: pytest-asyncio; extra == 'all'
+Requires-Dist: pytest-cov; extra == 'all'
 Requires-Dist: pytest-xdist; extra == 'all'
 Requires-Dist: tables; extra == 'all'
 Requires-Dist: xlrd; extra == 'all'
@@ -52,6 +53,7 @@ Requires-Dist: panel; extra == 'examples'
 Provides-Extra: tests
 Requires-Dist: pytest; extra == 'tests'
 Requires-Dist: pytest-asyncio; extra == 'tests'
+Requires-Dist: pytest-cov; extra == 'tests'
 Provides-Extra: tests-deser
 Requires-Dist: odfpy; extra == 'tests-deser'
 Requires-Dist: openpyxl; extra == 'tests-deser'
@@ -69,7 +71,7 @@ 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: gmpy; extra == 'tests-full'
+Requires-Dist: gmpy2; extra == 'tests-full'
 Requires-Dist: ipython; extra == 'tests-full'
 Requires-Dist: jsonschema; extra == 'tests-full'
 Requires-Dist: nbval; extra == 'tests-full'
@@ -82,9 +84,16 @@ Requires-Dist: panel; extra == 'tests-full'
 Requires-Dist: pyarrow; extra == 'tests-full'
 Requires-Dist: pytest; extra == 'tests-full'
 Requires-Dist: pytest-asyncio; extra == 'tests-full'
+Requires-Dist: pytest-cov; extra == 'tests-full'
 Requires-Dist: pytest-xdist; extra == 'tests-full'
 Requires-Dist: tables; extra == 'tests-full'
 Requires-Dist: xlrd; extra == 'tests-full'
+Provides-Extra: tests-pypy
+Requires-Dist: cloudpickle; extra == 'tests-pypy'
+Requires-Dist: ipython; extra == 'tests-pypy'
+Requires-Dist: jsonschema; extra == 'tests-pypy'
+Requires-Dist: nest-asyncio; extra == 'tests-pypy'
+Requires-Dist: numpy; extra == 'tests-pypy'
 Description-Content-Type: text/markdown
 
 <img src="https://raw.githubusercontent.com/holoviz/param/main/doc/_static/logo_horizontal.png" width=250>

{param-2.2.1rc2 → param-2.3.0a1}/numbergen/__init__.py

@@ -133,24 +133,35 @@ 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))
 
 
 class BinaryOperator(NumberGenerator):
-    """Applies any binary operator to NumberGenerators or numbers to yield a NumberGenerator."""
+    """
+    Applies any binary operator to NumberGenerators or numbers to yield a NumberGenerator.
 
-    def __init__(self,lhs,rhs,operator,reverse=False,**args):
-        """
-        Accepts two NumberGenerator operands, an operator, and
-        optional arguments to be provided to the operator when calling
-        it on the two operands.
-        """
-        # Note that it's currently not possible to set
-        # parameters in the superclass when creating an instance,
-        # because **args is used by this class itself.
-        super().__init__()
+    Parameters
+    ----------
+    lhs: NumberGenerator or Number
+        The left-hand side operand, which can be a NumberGenerator or a number.
+    rhs: NumberGenerator or Number
+        The right-hand side operand, which can be a NumberGenerator or a number.
+    operator :  callable
+        The binary operator to apply to the operands.
+    reverse : bool, optional
+        If `True`, swaps the left and right operands. Defaults to `False`.
+    **args:
+        Optional keyword arguments to pass to the operator when it is called.
+
+    Notes
+    -----
+    It is currently not possible to set parameters in the superclass during
+    initialization because `**args` is used by this class itself.
+    """
 
+    def __init__(self,lhs, rhs, operator, reverse=False, **args):
+        super().__init__()
         if reverse:
             self.lhs=rhs
             self.rhs=lhs
@@ -171,17 +182,25 @@ class BinaryOperator(NumberGenerator):
 
 
 class UnaryOperator(NumberGenerator):
-    """Applies any unary operator to a NumberGenerator to yield another NumberGenerator."""
+    """
+    Applies any unary operator to a NumberGenerator to yield another NumberGenerator.
 
-    def __init__(self,operand,operator,**args):
-        """
-        Accepts a NumberGenerator operand, an operator, and
-        optional arguments to be provided to the operator when calling
-        it on the operand.
-        """
-        # Note that it's currently not possible to set
-        # parameters in the superclass when creating an instance,
-        # because **args is used by this class itself.
+    Parameters
+    ----------
+    operand : NumberGenerator
+        The NumberGenerator to which the operator is applied.
+    operator : callable
+        The unary operator to apply to the operand.
+    **args:
+        Optional keyword arguments to pass to the operator when it is called.
+
+    Notes
+    -----
+    It is currently not possible to set parameters in the superclass during
+    initialization because `**args` is used by this class itself.
+    """
+
+    def __init__(self, operand, operator, **args):
         super().__init__()
 
         self.operand=operand
@@ -228,7 +247,11 @@ class Hash:
             numer, denom = val, 1
         elif isinstance(val, fractions.Fraction):
             numer, denom = val.numerator, val.denominator
+        elif hasattr(val, 'numerator') and hasattr(val, 'denominator'):
+            # gmpy2 mpq objects have these attributes
+            numer, denom = val.numerator, val.denominator
         elif hasattr(val, 'numer'):
+            # I think this branch supports gmpy (i.e. not gmpy2)
             (numer, denom) = (int(val.numer()), int(val.denom()))
         else:
             param.main.param.log(param.WARNING, "Casting type '%s' to Fraction.fraction"
@@ -237,15 +260,13 @@ class Hash:
             numer, denom = frac.numerator, frac.denominator
         return numer % I32, denom % I32
 
-
     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')
         return d
 
-
     def __setstate__(self, d):
         self._digest = hashlib.md5()
         name, input_count = d['name'], d['input_count']
@@ -253,14 +274,13 @@ class Hash:
         self._hash_struct = struct.Struct( "!" +" ".join(["I"] * (input_count * 2)))
         self.__dict__.update(d)
 
-
     def __call__(self, *vals):
         """
         Given integer or rational inputs, generate a cross-platform,
         architecture-independent 32-bit integer hash.
         """
         # Convert inputs to (numer, denom) pairs with integers
-        # becoming (int, 1) pairs to match gmpy.mpqs for int values.
+        # becoming (int, 1) pairs to match gmpy2.mpqs for int values.
         pairs = [self._rational(val) for val in vals]
         # Unpack pairs and fill struct with ints to update md5 hash
         ints = [el for pair in pairs for el in pair]
@@ -330,7 +350,9 @@ class TimeAwareRandomState(TimeAware):
 
     def _initialize_random_state(self, seed=None, shared=True, name=None):
         """
-        Initialization method to be called in the constructor of
+        Initialize the random state correctly.
+
+        Method to be called in the constructor of
         subclasses to initialize the random state correctly.
 
         If seed is None, there is no control over the random stream
@@ -427,7 +449,7 @@ class RandomDistribution(NumberGenerator, TimeAwareRandomState):
 
     __abstract = True
 
-    def __init__(self,**params):
+    def __init__(self, **params):
         """
         Initialize a new Random() instance and store the supplied
         positional and keyword arguments.

{param-2.2.1rc2 → param-2.3.0a1}/param/__init__.py

@@ -1,24 +1,65 @@
+
+"""
+Param: A declarative framework for managing parameters and reactive programming in Python.
+
+Param is a lightweight library for defining and managing user-modifiable parameters,
+designed to simplify Python programs and enhance their readability, maintainability,
+and robustness. In addition Param provides the `rx` framework for reactive programming.
+
+Param is well-suited for use in scientific computing, data analysis tools,
+graphical user interfaces (GUIs), and any Python application where well-defined,
+validated parameters are needed.
+
+References
+----------
+For detailed documentation, see https://param.holoviz.org/.
+
+Examples
+--------
+Here is an example of using `param.Parameterized` to define a class with validated parameters:
+
+>>> import param
+>>> class MyClass(param.Parameterized):
+...     my_number = param.Number(default=1, bounds=(0, 10))
+...     my_list = param.List(default=[1, 2, 3], item_type=int)
+
+>>> obj = MyClass()
+>>> obj.my_number = 5  # Valid
+>>> obj.my_number = 15  # Raises ValueError: must be in range (0, 10)
+
+Here is an example of using `param.rx` to define a reactive expression:
+
+>>> import param
+>>> rx_value = param.rx([1,2,3])
+>>> rx_value.rx.len()
+3
+
+Lets update the reactive value and check its length:
+
+>>> rx_value.rx.value = [1,2,3,4]
+>>> rx_value.rx.len()
+4
+"""
 import os
 
-from . import version  # noqa: api import
-from .depends import depends  # noqa: api import
-from .parameterized import (  # noqa: api import
+from . import version
+from .depends import depends
+from .parameterized import (
     Parameterized, Parameter, Skip, String, ParameterizedFunction,
-    ParamOverrides, Undefined, get_logger
+    ParamOverrides, Undefined, get_logger, ParameterizedABC,
 )
-from .parameterized import (batch_watch, output, script_repr, # noqa: api import
+from .parameterized import (output, script_repr,
                             discard_events, edit_constant)
-from .parameterized import shared_parameters  # noqa: api import
-from .parameterized import logging_level   # noqa: api import
-from .parameterized import DEBUG, VERBOSE, INFO, WARNING, ERROR, CRITICAL  # noqa: api import
-from .parameters import (  # noqa: api import
+from .parameterized import shared_parameters
+from .parameterized import logging_level
+from .parameterized import DEBUG, VERBOSE, INFO, WARNING, ERROR, CRITICAL
+from .parameters import (
     guess_param_types,
     param_union,
     parameterized_class,
     guess_bounds,
     get_soft_bounds,
     resolve_path,
-    normalize_path,
     Time,
     Infinity,
     Dynamic,
@@ -58,16 +99,10 @@ from .parameters import (  # noqa: api import
     CalendarDateRange,
     Event,
 )
-from .reactive import bind, rx # noqa: api import
-from ._utils import (  # noqa: api import
-    produce_value,
-    as_unicode,
-    is_ordered_dict,
-    hashable,
-    named_objs,
+from .reactive import bind, rx
+from ._utils import (
     descendents,
     concrete_descendents,
-    abbreviate_paths,
     exceptions_summarized,
     _is_number,
 )
@@ -155,6 +190,7 @@ __all__ = (
     'ParamOverrides',
     'Parameter',
     'Parameterized',
+    'ParameterizedABC',
     'ParameterizedFunction',
     'Path',
     'Range',
@@ -171,9 +207,6 @@ __all__ = (
     'XYCoordinates',
     '__version__',
     '_is_number',
-    'abbreviate_paths',
-    'as_unicode',
-    'batch_watch',
     'bind',
     'concrete_descendents',
     'depends',
@@ -185,16 +218,11 @@ __all__ = (
     'get_soft_bounds',
     'guess_bounds',
     'guess_param_types',
-    'hashable',
-    'is_ordered_dict',
     'logging_level',
     'main',
-    'named_objs',
-    'normalize_path',
     'output',
     'param_union',
     'parameterized_class',
-    'produce_value',
     'random_seed',
     'resolve_path',
     'rx',