fix larray-project#832 : implemented FrozenSession class

Author: alixdamman

doc/source/api.rst

@@ -790,7 +790,6 @@ Modifying
 
    Session.add
    Session.update
-   Session.get
    Session.apply
    Session.transpose
 
@@ -816,6 +815,74 @@ Load/Save
    Session.to_hdf
    Session.to_pickle
 
+.. _api-frozensession:
+
+FrozenSession
+=============
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession
+
+Exploring
+---------
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession.names
+   FrozenSession.keys
+   FrozenSession.values
+   FrozenSession.items
+   FrozenSession.summary
+
+Copying
+-------
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession.copy
+
+Testing
+-------
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession.element_equals
+   FrozenSession.equals
+
+Selecting
+---------
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession.get
+
+Modifying
+---------
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession.apply
+
+Load/Save
+---------
+
+.. autosummary::
+   :toctree: _generated/
+
+   FrozenSession.load
+   FrozenSession.save
+   FrozenSession.to_csv
+   FrozenSession.to_excel
+   FrozenSession.to_hdf
+   FrozenSession.to_pickle
+
 .. _api-editor:
 
 Editor

larray/__init__.py

@@ -9,7 +9,7 @@
                                full_like, sequence, labels_array, ndtest, asarray, identity, diag,
                                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.session import Session, FrozenSession, local_arrays, global_arrays, arrays
 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
@@ -58,7 +58,7 @@
     'all', 'any', 'sum', 'prod', 'cumsum', 'cumprod', 'min', 'max', 'mean', 'ptp', 'var', 'std',
     'median', 'percentile', 'stack', 'zip_array_values', 'zip_array_items',
     # session
-    'Session', 'local_arrays', 'global_arrays', 'arrays',
+    'Session', 'FrozenSession', 'local_arrays', 'global_arrays', 'arrays',
     # constants
     'nan', 'inf', 'pi', 'e', 'euler_gamma',
     # metadata

larray/core/session.py

@@ -6,6 +6,7 @@
 import re
 import fnmatch
 import warnings
+from copy import copy
 from collections import OrderedDict, Iterable
 
 import numpy as np
@@ -91,7 +92,7 @@ def __init__(self, *args, **kwargs):
 
         if len(args) == 1:
             a0 = args[0]
-            if isinstance(a0, str):
+            if isinstance(a0, basestring):
                 # assume a0 is a filename
                 self.load(a0)
             else:
@@ -1391,6 +1392,94 @@ def display(k, v, is_metadata=False):
         return res
 
 
+# XXX: I wonder if we shouldn't create an AbstractSession instead of defining the _disabled()
+#      private method below.
+#      Auto-completion on any instance of a class that inherits from FrozenSession
+#      should not propose the add(), update(), filter(), transpose() and compact() methods
+class FrozenSession(Session):
+    def __init__(self, *args, **kwargs):
+        meta = kwargs.pop('meta', None)
+
+        if len(args) == 1 and isinstance(args[0], basestring):
+            filepath, args = args[0], args[1:]
+        else:
+            filepath = None
+
+        if args or kwargs:
+            raise ValueError("All items of '{cls}' must be defined in the class declaration."
+                             .format(cls=self.__class__.__name__))
+        if meta:
+            kwargs['meta'] = meta
+
+        if filepath:
+            args = [filepath]
+        else:
+            # feed the kwargs dict with all items declared as class attributes
+            for key, value in vars(self.__class__).items():
+                if not key.startswith('_'):
+                    kwargs[key] = value
+
+        Session.__init__(self, *args, **kwargs)
+
+    def __setitem__(self, key, value):
+        self._check_key_value(key, value)
+
+        # we need to keep the attribute in sync (initially to mask the class attribute)
+        object.__setattr__(self, key, value)
+        self._objects[key] = value
+
+    def __setattr__(self, key, value):
+        if key != 'meta':
+            self._check_key_value(key, value)
+
+        # update the real attribute
+        object.__setattr__(self, key, value)
+        # update self._objects
+        Session.__setattr__(self, key, value)
+
+    def _check_key_value(self, key, value):
+        cls = self.__class__
+        attr_def = getattr(cls, key, None)
+        if attr_def is None:
+            raise ValueError("The '{item}' item has not been found in the '{cls}' class declaration. "
+                             "Adding a new item after creating an instance of the '{cls}' class is not permitted."
+                             .format(item=key, cls=cls.__name__))
+        if type(value) != type(attr_def):
+            raise TypeError("Expected object of type {attr_cls}. Got object of type {value_cls}."
+                            .format(attr_cls=attr_def.__class__.__name__, value_cls=value.__class__.__name__))
+        if isinstance(attr_def, Array):
+            try:
+                attr_def.axes.check_compatible(value.axes)
+            except ValueError as e:
+                msg = str(e).replace("incompatible axes:", "incompatible axes for array '{key}':".format(key=key))
+                raise ValueError(msg)
+
+    def copy(self):
+        instance = self.__class__()
+        for key, value in self.items():
+            instance[key] = copy(value)
+        return instance
+
+    def apply(self, func, *args, **kwargs):
+        kind = kwargs.pop('kind', Array)
+        instance = self.__class__()
+        for key, value in self.items():
+            instance[key] = func(value, *args, **kwargs) if isinstance(value, kind) else value
+        return instance
+
+    def _disabled(self, *args, **kwargs):
+        """This method will not work because adding or removing item and modifying axes of declared arrays
+        is not permitted."""
+        raise ValueError(
+            "Adding or removing item and modifying axes of declared arrays is not permitted.".format(
+                cls=self.__class__.__name__
+            )
+        )
+
+    __delitem__ = __delattr__ = _disabled
+    update = filter = transpose = compact = _disabled
+
+
 def _exclude_private_vars(vars_dict):
     return {k: v for k, v in vars_dict.items() if not k.startswith('_')}
 

larray/tests/test_session.py

@@ -9,7 +9,7 @@
 
 from larray.tests.common import assert_array_nan_equal, inputpath, tmp_path, meta, needs_xlwings
 from larray import (Session, Axis, Array, Group, isnan, zeros_like, ndtest, ones_like, ones, full,
-                    local_arrays, global_arrays, arrays)
+                    local_arrays, global_arrays, arrays, FrozenSession)
 from larray.util.misc import pickle, PY2
 
 
@@ -50,6 +50,27 @@ def session():
                     ('a01', a01), ('ano01', ano01), ('c', c), ('d', d), ('e', e), ('g', g), ('f', f), ('h', h)])
 
 
+class TestFrozenSession(FrozenSession):
+    b = b
+    b024 = b024
+    a = a
+    a2 = a2
+    anonymous = anonymous
+    a01 = a01
+    ano01 = ano01
+    c = c
+    d = d
+    e = e
+    g = g
+    f = f
+    h = h
+
+
+@pytest.fixture()
+def frozensession():
+    return TestFrozenSession()
+
+
 def test_init_session(meta):
     s = Session(b, b024, a, a01, a2=a2, anonymous=anonymous, ano01=ano01, c=c, d=d, e=e, f=f, g=g, h=h)
     assert s.names == ['a', 'a01', 'a2', 'ano01', 'anonymous', 'b', 'b024', 'c', 'd', 'e', 'f', 'g', 'h']
@@ -70,6 +91,30 @@ def test_init_session(meta):
     assert s.meta == meta
 
 
+def test_create_frozensession_instance(meta):
+    fs = TestFrozenSession()
+    assert fs.names == ['a', 'a01', 'a2', 'ano01', 'anonymous', 'b', 'b024', 'c', 'd', 'e', 'f', 'g', 'h']
+
+    # metadata
+    fs = TestFrozenSession(meta=meta)
+    assert fs.meta == meta
+
+    # load from file
+    fs = TestFrozenSession(inputpath('test_session.h5'))
+    assert fs.names == ['a', 'a01', 'a2', 'ano01', 'anonymous', 'b', 'b024', 'e', 'f', 'g', 'h']
+
+    # No new items can be passed to the constructor
+    expected_error_msg = "All items of 'TestFrozenSession' must be defined in the class declaration."
+
+    with pytest.raises(ValueError) as e_args:
+        fs = TestFrozenSession([('i', ndtest((3, 3)))])
+    assert e_args.value.args[0] == expected_error_msg
+
+    with pytest.raises(ValueError) as e_kwargs:
+        fs = TestFrozenSession(i=ndtest((3, 3)))
+    assert e_kwargs.value.args[0] == expected_error_msg
+
+
 def test_getitem(session):
     assert session['a'] is a
     assert session['a2'] is a2