renamed class Parameters as CheckedParameters

Author: alixdamman

doc/source/api.rst

@@ -836,13 +836,13 @@ CheckedSession
 
    CheckedSession
 
-Parameters
-==========
+CheckedParameters
+=================
 
 .. autosummary::
    :toctree: _generated/
 
-   Parameters
+   CheckedParameters
 
 .. _api-editor:
 

larray/__init__.py

@@ -8,7 +8,7 @@
                                eye, all, any, sum, prod, cumsum, cumprod, min, max, mean, ptp, var,
                                std, median, percentile, stack, zip_array_values, zip_array_items)
 from larray.core.session import Session, local_arrays, global_arrays, arrays
-from larray.core.checked import CheckedArray, CheckedSession, Parameters
+from larray.core.checked import CheckedArray, CheckedSession, CheckedParameters
 from larray.core.constants import nan, inf, pi, e, euler_gamma
 from larray.core.metadata import Metadata
 from larray.core.ufuncs import wrap_elementwise_array_func, maximum, minimum, where
@@ -57,7 +57,7 @@
     # session
     'Session', 'local_arrays', 'global_arrays', 'arrays',
     # constrained
-    'CheckedArray', 'CheckedSession', 'Parameters',
+    'CheckedArray', 'CheckedSession', 'CheckedParameters',
     # constants
     'nan', 'inf', 'pi', 'e', 'euler_gamma',
     # metadata

larray/core/checked.py

@@ -233,7 +233,7 @@ class CheckedSession(Session, AbstractCheckedSession, metaclass=ModelMetaclass):
 
         See Also
         --------
-        Session, Parameters
+        Session, CheckedParameters
 
         Examples
         --------
@@ -467,7 +467,7 @@ def dict(self, exclude: Set[str] = None):
                     del d[name]
             return d
 
-    class Parameters(CheckedSession):
+    class CheckedParameters(CheckedSession):
         """
         Same as py:class:`CheckedSession` but declared variables cannot be modified after initialization.
 
@@ -493,7 +493,7 @@ class Parameters(CheckedSession):
         Content of file 'parameters.py'
 
         >>> from larray import *
-        >>> class ModelParameters(Parameters):
+        >>> class Parameters(CheckedParameters):
         ...     # --- declare variables with fixed values ---
         ...     # The given values can never be changed
         ...     FIRST_YEAR = 2020
@@ -509,14 +509,14 @@ class Parameters(CheckedSession):
 
         >>> # instantiation --> create an instance of the ModelVariables class
         >>> # all variables declared without value must be set
-        >>> P = ModelParameters(variant_name='variant_1')
+        >>> P = Parameters(variant_name='variant_1')
         >>> # once an instance is create, its variables can be accessed but not modified
         >>> P.variant_name
         'variant_1'
         >>> P.variant_name = 'new_variant'      # doctest: +NORMALIZE_WHITESPACE
         Traceback (most recent call last):
             ...
-        TypeError: Cannot change the value of the variable 'variant_name' since 'ModelParameters'
+        TypeError: Cannot change the value of the variable 'variant_name' since 'Parameters'
         is immutable and does not support item assignment
         """
         class Config:
@@ -533,7 +533,7 @@ def __init__(self, *args, **kwargs):
             raise NotImplementedError("CheckedSession class cannot be instantiated "
                                       "because pydantic is not installed")
 
-    class Parameters(object):
+    class CheckedParameters(object):
         def __init__(self, *args, **kwargs):
-            raise NotImplementedError("Parameters class cannot be instantiated "
+            raise NotImplementedError("CheckedParameters class cannot be instantiated "
                                       "because pydantic is not installed")