[Enhancement] squeeze first axis of row arrays/structs

Author: balbasty

spm/__wrapper__.py

@@ -1,5 +1,6 @@
 import warnings
 import numpy as np
+from functools import partial
 from collections.abc import (
     MutableSequence, MutableMapping, KeysView, ValuesView, ItemsView
 )
@@ -222,7 +223,7 @@ class MatlabType(object):
     """Generic type for objects that have an exact matlab equivalent."""
 
     @classmethod
-    def from_any(cls, other):
+    def from_any(cls, other, **kwargs):
         """
         Convert python/matlab objects to `MatlabType` objects
         (`Cell`, `Struct`, `Array`, `MatlabClass`).
@@ -234,6 +235,9 @@ def from_any(cls, other):
         # - we do not convert to types that can be passed directly to
         #   the matlab runtime;
         # - instead, we convert to python types that mimic matlab types.
+        _from_any = partial(cls.from_any, **kwargs)
+        _from_runtime = kwargs.pop("_from_runtime", False)
+
         if isinstance(other, MatlabType):
             if isinstance(other, AnyDelayedArray):
                 other._error_is_not_finalized()
@@ -278,15 +282,25 @@ def from_any(cls, other):
                     raise ValueError("Don't know what to do with type", type__)
 
             else:
+                other = type(other)(
+                    zip(other.keys(),
+                        map(_from_any, other.values()))
+                )
                 return Struct.from_any(other)
 
         if isinstance(other, (list, tuple, set)):
             # nested tuples are cells of cells, not cell arrays
-            return Cell.from_any(other)
+            if _from_runtime:
+                return Cell._from_runtime(other)
+            else:
+                return Cell.from_any(other)
 
         if isinstance(other, (np.ndarray, int, float, complex, bool)):
             # [array of] numbers -> Array
-            return Array.from_any(other)
+            if _from_runtime:
+                return Array._from_runtime(other)
+            else:
+                return Array.from_any(other)
 
         if isinstance(other, str):
             return other
@@ -305,17 +319,20 @@ def from_any(cls, other):
             return MatlabFunction.from_any(other)
 
         if type(other) in _matlab_array_types():
-            dtype = _matlab_array_types()[type(other)]
-            return Array.from_any(other, dtype=dtype)
+            return Array._from_runtime(other)
 
         if hasattr(other, "__iter__"):
             # Iterable -> let's try to make it a cell
-            return cls.from_any(list(other))
+            return cls.from_any(list(other), _from_runtime=_from_runtime)
 
         raise TypeError(
             f"Cannot convert {type(other)} into a matlab object."
         )
 
+    @classmethod
+    def _from_runtime(cls, obj):
+        return cls.from_any(obj, _from_runtime=True)
+
     @classmethod
     def _to_runtime(cls, obj):
         """
@@ -1157,7 +1174,10 @@ def _as_runtime(self) -> np.ndarray:
 
     @classmethod
     def _from_runtime(cls, other) -> "Array":
-        return cls.from_any(other)
+        other = np.asarray(other)
+        if len(other.shape) == 2 and other.shape[0] == 1:
+            other = other.squeeze(0)
+        return np.ndarray.view(other, cls)
 
     @classmethod
     def from_shape(cls, shape=tuple(), **kwargs) -> "Array":
@@ -1855,9 +1875,19 @@ def _as_runtime(self) -> dict:
 
     @classmethod
     def _from_runtime(cls, objdict: dict) -> "Cell":
+        if isinstance(objdict, (list, tuple, set)):
+            shape = [len(objdict)]
+            objdict = dict(type__='cell', size__=shape, data__=objdict)
+
         if objdict['type__'] != 'cell':
             raise TypeError('objdict is not a cell')
+
         size = np.array(objdict['size__'], dtype=np.uint64).ravel()
+        if len(size) == 2 and size[0] == 1:
+            # NOTE: should not be needed for Cell, as this should
+            # have been taken care of by MPython, but I am keeping it
+            # here for symmetry with Array and Struct.
+            size = size[1:]
         data = np.fromiter(objdict['data__'], dtype=object)
         data = data.reshape(size[::-1]).transpose()
         try:
@@ -1874,7 +1904,7 @@ def _from_runtime(cls, objdict: dict) -> "Cell":
                    op_flags=['readwrite', 'no_broadcast'])
         with np.nditer(data, **opt) as iter:
             for elem in iter:
-                elem[()] = MatlabType.from_any(elem.item())
+                elem[()] = MatlabType._from_runtime(elem.item())
 
         return obj
 
@@ -2485,6 +2515,11 @@ def _from_runtime(cls, objdict: dict) -> "Struct":
         if objdict['type__'] != 'structarray':
             raise TypeError('objdict is not a structarray')
         size = np.array(objdict['size__'], dtype=np.uint64).ravel()
+        if len(size) == 2 and size[0] == 1:
+            # NOTE: should not be needed for Cell, as this should
+            # have been taken care of by MPython, but I am keeping it
+            # here for symmetry with Array and Struct.
+            size = size[1:]
         data = np.array(objdict['data__'], dtype=object)
         data = data.reshape(size)
         try:
@@ -2495,7 +2530,17 @@ def _from_runtime(cls, objdict: dict) -> "Struct":
                 f'  data={data}\n'
                 f'  objdict={objdict}'
             )
-        return MatlabType.from_any(obj)
+
+        # recurse
+        opt = dict(flags=['refs_ok', 'zerosize_ok'],
+                   op_flags=['readonly', 'no_broadcast'])
+        with np.nditer(data, **opt) as iter:
+            for elem in iter:
+                item = elem.item()
+                for key, val in item.items():
+                    item[key] = MatlabType._from_runtime(val)
+
+        return obj
 
     @classmethod
     def from_shape(cls, shape=tuple(), **kwargs) -> "Struct":

tests/test_array.py

@@ -44,7 +44,7 @@ def test_array_instantiate_shape_2d_col(self):
         self.assertEqual(a.shape, (3, 1))
         self.assertEqual(a.dtype, np.float64)
         self.assertTrue((a == 0).all())
-    
+
     def test_array_instantiate_shape_2d(self):
         a = Array(2, 3, 4, 5)
 
@@ -91,9 +91,9 @@ def test_array_from_matlab_2d_row(self):
             self.fail('2D row array to Matlab failed.')
 
         self.assertIsInstance(a, Array)
-        self.assertEqual(a.shape, (1, 3))
+        self.assertEqual(a.shape, (3,))
         self.assertEqual(a.dtype, np.float64)
-        self.assertEqual(a.tolist(), [[1, 2, 3]])
+        self.assertEqual(a.tolist(), [1, 2, 3])
 
     def test_array_from_matlab_2d_col(self):
         try:
@@ -116,20 +116,20 @@ def test_array_from_matlab_array2d(self):
         self.assertEqual(a.shape, (2, 3))
         self.assertEqual(a.dtype, np.float64)
         self.assertEqual(a.tolist(), [[1, 2, 3], [4, 5, 6]])
-    
+
     def test_array_to_matlab_empty(self):
         # Construct an empty array
         a = Array()
-        
+
         # Get properties in Matlab
-        try: 
+        try:
             size = Runtime.call('size', a)
             type = Runtime.call('class', a)
         except Exception:
             self.fail('Empty array to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 1]])
+        self.assertEqual(size.tolist(), [1, 1])
         self.assertEqual(type, 'double')
 
     def test_array_to_matlab_empty_1d(self):
@@ -144,7 +144,7 @@ def test_array_to_matlab_empty_1d(self):
             self.fail('1D shape array to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 3]])
+        self.assertEqual(size.tolist(), [1, 3])
         self.assertEqual(type, 'double')
 
     def test_array_to_matlab_empty_2d_row(self):
@@ -159,7 +159,7 @@ def test_array_to_matlab_empty_2d_row(self):
             self.fail('1D row array to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 3]])
+        self.assertEqual(size.tolist(), [1, 3])
         self.assertEqual(type, 'double')
 
     def test_array_to_matlab_empty_2d_col(self):
@@ -174,7 +174,7 @@ def test_array_to_matlab_empty_2d_col(self):
             self.fail('1D col array to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[3, 1]])
+        self.assertEqual(size.tolist(), [3, 1])
         self.assertEqual(type, 'double')
 
     def test_array_to_matlab_empty_2d(self):
@@ -189,9 +189,9 @@ def test_array_to_matlab_empty_2d(self):
             self.fail('2D array to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[3, 2]])
+        self.assertEqual(size.tolist(), [3, 2])
         self.assertEqual(type, 'double')
-    
+
     def test_array_to_matlab_empty_nd(self):
         # Construct a 2x3x4x5 array
         a = Array(2, 3, 4, 5)
@@ -204,7 +204,7 @@ def test_array_to_matlab_empty_nd(self):
             self.fail('N-D array to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[2, 3, 4, 5]])
+        self.assertEqual(size.tolist(), [2, 3, 4, 5])
         self.assertEqual(type, 'double')
 
     def test_array_append_1d(self):
@@ -258,9 +258,8 @@ def test_array_indexing_1d(self):
         self.assertEqual(a.tolist(), [2])
 
     def test_array_roundtrip_1d(self):
-        a = Array.from_any([1, 2, 3])
         identity = Runtime.call('eval',  '@(x) x')
-        a = Array.from_any([[1, 2, 3]])
+        a = Array.from_any([1, 2, 3])
         d = identity(a)
         self.assertListEqual(a.tolist(), d.tolist())
 

tests/test_cell.py

@@ -108,7 +108,7 @@ def test_cell_to_matlab_empty(self):
             self.fail('Empty cell to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 0]])
+        self.assertEqual(size.tolist(), [1, 0])
         self.assertEqual(type, 'cell')
 
     def test_cell_to_matlab_empty_1d(self):
@@ -123,7 +123,7 @@ def test_cell_to_matlab_empty_1d(self):
             self.fail('1D shape cell to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 3]])
+        self.assertEqual(size.tolist(), [1, 3])
         self.assertEqual(type, 'cell')
 
     def test_cell_to_matlab_empty_2d_row(self):
@@ -138,7 +138,7 @@ def test_cell_to_matlab_empty_2d_row(self):
             self.fail('1D row cell to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 3]])
+        self.assertEqual(size.tolist(), [1, 3])
         self.assertEqual(type, 'cell')
 
     def test_cell_to_matlab_empty_2d_col(self):
@@ -153,7 +153,7 @@ def test_cell_to_matlab_empty_2d_col(self):
             self.fail('1D col cell to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[3, 1]])
+        self.assertEqual(size.tolist(), [3, 1])
         self.assertEqual(type, 'cell')
 
     def test_cell_to_matlab_empty_2d(self):
@@ -168,7 +168,7 @@ def test_cell_to_matlab_empty_2d(self):
             self.fail('2D cell to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[3, 2]])
+        self.assertEqual(size.tolist(), [3, 2])
         self.assertEqual(type, 'cell')
 
     def test_cell_to_matlab_empty_nd(self):
@@ -183,7 +183,7 @@ def test_cell_to_matlab_empty_nd(self):
             self.fail('N-D cell to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[2, 3, 4, 5]])
+        self.assertEqual(size.tolist(), [2, 3, 4, 5])
         self.assertEqual(type, 'cell')
 
     def test_cell_as_struct(self):

tests/test_struct.py

@@ -172,7 +172,7 @@ def test_struct_from_matlab_with_array(self):
         # Check Runtime conversion
         self.assertIsInstance(s_matlab, Struct)
         self.assertIsInstance(s_matlab.field1, Array)
-        self.assertListEqual(s_matlab.field1.tolist(), [[1, 2, 3]])
+        self.assertListEqual(s_matlab.field1.tolist(), [1, 2, 3])
         self.assertEqual(s_matlab.field2, 2)
         self.assertListEqual(list(s_matlab.keys()), ["field1", "field2"])
         self.assertListEqual(list(s_matlab.values()), [s_matlab.field1, 2])
@@ -215,7 +215,7 @@ def test_struct_to_matlab_empty(self):
             self.fail('Empty struct to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 1]])
+        self.assertEqual(size.tolist(), [1, 1])
         self.assertEqual(type, 'struct')
         self.assertListEqual(fieldnames.tolist(), [])
 
@@ -232,7 +232,7 @@ def test_struct_to_matlab_empty_1d(self):
             self.fail('1D shape struct to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 3]])
+        self.assertEqual(size.tolist(), [1, 3])
         self.assertEqual(type, 'struct')
         self.assertListEqual(fieldnames.tolist(), [])
 
@@ -249,7 +249,7 @@ def test_struct_to_matlab_empty_2d_row(self):
             self.fail('1D row struct to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[1, 3]])
+        self.assertEqual(size.tolist(), [1, 3])
         self.assertEqual(type, 'struct')
         self.assertListEqual(fieldnames.tolist(), [])
 
@@ -266,7 +266,7 @@ def test_struct_to_matlab_empty_2d_col(self):
             self.fail('1D col struct to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[3, 1]])
+        self.assertEqual(size.tolist(), [3, 1])
         self.assertEqual(type, 'struct')
         self.assertListEqual(fieldnames.tolist(), [])
 
@@ -283,7 +283,7 @@ def test_struct_to_matlab_empty_2d(self):
             self.fail('2D struct to Matlab failed.')
 
         # Check properties in Matlab
-        self.assertEqual(size.tolist(), [[3, 2]])
+        self.assertEqual(size.tolist(), [3, 2])
         self.assertEqual(type, 'struct')
         self.assertListEqual(fieldnames.tolist(), [])