- renamed ConstrainedSession as CheckedSession

- renamed ConstrainedArray as CheckedArray
- renamed test_constrained_session.py as test_checked_session.py
- renamed constrained.py as checked.py

Author: alixdamman

README.rst

@@ -133,7 +133,7 @@ Miscellaneous
 ~~~~~~~~~~~~~
 
 - `pydantic <https://github.com/samuelcolvin/pydantic>`__:
-  required to use `ConstrainedSession`.
+  required to use `CheckedSession`.
 
 .. _start-documentation:
 

doc/source/api.rst

@@ -820,21 +820,21 @@ Load/Save
    Session.to_hdf
    Session.to_pickle
 
-ConstrainedArray
-================
+CheckedArray
+============
 
 .. autosummary::
    :toctree: _generated/
 
-   ConstrainedArray
+   CheckedArray
 
-ConstrainedSession
-==================
+CheckedSession
+==============
 
 .. autosummary::
    :toctree: _generated/
 
-   ConstrainedSession
+   CheckedSession
 
 Parameters
 ==========

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.constrained import ConstrainedArray, ConstrainedSession, Parameters
+from larray.core.checked import CheckedArray, CheckedSession, Parameters
 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
-    'ConstrainedArray', 'ConstrainedSession', 'Parameters',
+    'CheckedArray', 'CheckedSession', 'Parameters',
     # constants
     'nan', 'inf', 'pi', 'e', 'euler_gamma',
     # metadata

larray/core/constrained.py renamed to larray/core/checked.py

@@ -28,7 +28,7 @@ class NotLoaded:
 
     # the implementation of the class below is inspired by the 'ConstrainedBytes' class
     # from the types.py module of the 'pydantic' library
-    class ConstrainedArrayImpl(Array):
+    class CheckedArrayImpl(Array):
         expected_axes: AxisCollection
         dtype: np.dtype = np.dtype(float)
 
@@ -73,10 +73,10 @@ def validate(cls, value, field: ModelField):
     # the implementation of the function below is inspired by the 'conbytes' function
     # from the types.py module of the 'pydantic' library
 
-    def ConstrainedArray(axes: AxisCollection, dtype: np.dtype = float) -> Type[Array]:
+    def CheckedArray(axes: AxisCollection, dtype: np.dtype = float) -> Type[Array]:
         # XXX: for a very weird reason I don't know, I have to put the fake import below
         #      to get autocompletion from PyCharm
-        from larray.core.constrained import ConstrainedArrayImpl
+        from larray.core.checked import CheckedArrayImpl
         """
         Represents a constrained array.
         Its axes are assumed to be "frozen", meaning they are constant all along the execution of the program.
@@ -98,13 +98,13 @@ def ConstrainedArray(axes: AxisCollection, dtype: np.dtype = float) -> Type[Arra
             axes = AxisCollection(axes)
         _dtype = np.dtype(dtype)
 
-        class ConstrainedArrayValue(ConstrainedArrayImpl):
+        class CheckedArrayValue(CheckedArrayImpl):
             expected_axes = axes
             dtype = _dtype
 
-        return ConstrainedArrayValue
+        return CheckedArrayValue
 
-    class AbstractConstrainedSession:
+    class AbstractCheckedSession:
         pass
 
     # Simplified version of the ModelMetaclass class from pydantic:
@@ -125,7 +125,7 @@ def __new__(mcs, name, bases, namespace, **kwargs):
             validators: Dict[str, List[Validator]] = {}
 
             for base in reversed(bases):
-                if issubclass(base, AbstractConstrainedSession) and base != AbstractConstrainedSession:
+                if issubclass(base, AbstractCheckedSession) and base != AbstractCheckedSession:
                     config = inherit_config(base.__config__, config)
                     fields.update(deepcopy(base.__fields__))
                     validators = inherit_validators(base.__validators__, validators)
@@ -147,7 +147,7 @@ def __new__(mcs, name, bases, namespace, **kwargs):
             # extract and build fields
             class_vars = set()
             if (namespace.get('__module__'), namespace.get('__qualname__')) != \
-                    ('larray.core.constrained', 'ConstrainedSession'):
+                    ('larray.core.checked', 'CheckedSession'):
                 untouched_types = UNTOUCHED_TYPES + config.keep_untouched
 
                 # annotation only fields need to come first in fields
@@ -190,12 +190,12 @@ def __new__(mcs, name, bases, namespace, **kwargs):
             }
             return super().__new__(mcs, name, bases, new_namespace, **kwargs)
 
-    class ConstrainedSession(Session, AbstractConstrainedSession, metaclass=ModelMetaclass):
+    class CheckedSession(Session, AbstractCheckedSession, metaclass=ModelMetaclass):
         """
         This class is intended to be inherited by user defined classes in which the variables of a model are declared.
         Each declared variable is constrained by a type defined explicitly or deduced from the given default value
         (see examples below).
-        All classes inheriting from `ConstrainedSession` will have access to all methods of the
+        All classes inheriting from `CheckedSession` will have access to all methods of the
         :py:class:`Session` class.
 
         The special :py:funct:`ConstantAxesArray` type represents an Array object with constant axes.
@@ -207,7 +207,7 @@ class ConstrainedSession(Session, AbstractConstrainedSession, metaclass=ModelMet
         to enter after only a few characters have been typed).
 
         As for normal Session objects, it is still possible to add undeclared variables to instances of
-        classes inheriting from `ConstrainedSession` but this must be done with caution.
+        classes inheriting from `CheckedSession` but this must be done with caution.
 
         Parameters
         ----------
@@ -223,8 +223,8 @@ class ConstrainedSession(Session, AbstractConstrainedSession, metaclass=ModelMet
 
         Warnings
         --------
-        The :py:method:`ConstrainedSession.filter`, :py:method:`ConstrainedSession.compact`
-        and :py:method:`ConstrainedSession.apply` methods return a simple Session object.
+        The :py:method:`CheckedSession.filter`, :py:method:`CheckedSession.compact`
+        and :py:method:`CheckedSession.apply` methods return a simple Session object.
         The type of the declared variables (and the value for the declared constants) will
         no longer be checked.
 
@@ -246,7 +246,7 @@ class ConstrainedSession(Session, AbstractConstrainedSession, metaclass=ModelMet
 
         Content of file 'model.py'
 
-        >>> class ModelVariables(ConstrainedSession):
+        >>> class ModelVariables(CheckedSession):
         ...     # --- declare variables with defined types ---
         ...     # Their values will be defined at runtime but must match the specified type.
         ...     variant_name: str
@@ -260,10 +260,10 @@ class ConstrainedSession(Session, AbstractConstrainedSession, metaclass=ModelMet
         ...     # --- declare constrained arrays ---
         ...     # the constrained arrays have axes assumed to be "frozen", meaning they are
         ...     # constant all along the execution of the program.
-        ...     mortality_rate: ConstrainedArray((AGE, GENDER))
+        ...     mortality_rate: CheckedArray((AGE, GENDER))
         ...     # for constrained arrays, the default value can be given as a scalar.
         ...     # A dtype can be also optionally specified (defaults to float).
-        ...     deaths: ConstrainedArray((AGE, GENDER, TIME), dtype=int) = 0
+        ...     deaths: CheckedArray((AGE, GENDER, TIME), dtype=int) = 0
 
         >>> variant_name = 'variant_1'
         >>> # instantiation --> create an instance of the ModelVariables class
@@ -455,9 +455,9 @@ def dict(self, exclude: Set[str] = None):
                     del d[name]
             return d
 
-    class Parameters(ConstrainedSession):
+    class Parameters(CheckedSession):
         """
-        Same as py:class:`ConstrainedSession` but declared variables cannot be modified after initialization.
+        Same as py:class:`CheckedSession` but declared variables cannot be modified after initialization.
 
         Parameters
         ----------
@@ -473,7 +473,7 @@ class Parameters(ConstrainedSession):
 
         See Also
         --------
-        ConstrainedSession
+        CheckedSession
 
         Examples
         --------
@@ -513,12 +513,12 @@ class Config:
             allow_mutation = False
 
 else:
-    def ConstrainedArray(axes: AxisCollection, dtype: np.dtype = float) -> Type[Array]:
-        raise NotImplementedError("ConstrainedArray cannot be used because pydantic is not installed")
+    def CheckedArray(axes: AxisCollection, dtype: np.dtype = float) -> Type[Array]:
+        raise NotImplementedError("CheckedArray cannot be used because pydantic is not installed")
 
-    class ConstrainedSession(object):
+    class CheckedSession(object):
         def __init__(self, *args, **kwargs):
-            raise NotImplementedError("ConstrainedSession class cannot be instantiated "
+            raise NotImplementedError("CheckedSession class cannot be instantiated "
                                       "because pydantic is not installed")
 
     class Parameters(object):