xobjects 0.3.1__tar.gz → 0.4.0__tar.gz

{xobjects-0.3.1/xobjects.egg-info → xobjects-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xobjects
-Version: 0.3.1
+Version: 0.4.0
 Summary: In-memory serialization and code generator for CPU and GPU
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xobjects

{xobjects-0.3.1 → xobjects-0.4.0}/tests/test_array.py

@@ -125,6 +125,12 @@ def test_array_allocation():
     assert ss._itemtype == xo.Int64
 
 
+def test_static_array_allocation_with_none():
+    MyArray = xo.Int64[10]
+    ss = MyArray(None)
+    assert ss._itemtype == xo.Int64
+
+
 def test_array_sshape_stype():
     Array1D = xo.Int64[3]
     Array2D = xo.Int64[2, 3]

{xobjects-0.3.1 → xobjects-0.4.0}/tests/test_hybrid_class.py

@@ -310,3 +310,23 @@ def test_move_field_of_nested_fails(classes_for_test_hybrid_class_ref):
 
     with pytest.raises(MemoryError):
         outer.inner.move(_buffer=different_buffer)
+
+
+def test_to_json_defaults():
+    class A(xo.HybridClass):
+        _xofields = {
+            "a": xo.Float64[3],
+            "b": xo.Int64,
+            "c": xo.Field(xo.Int32, default=42),
+            "d": xo.Field(xo.Int32, default_factory=lambda: 7),
+        }
+
+    a = A(c=42)
+    assert a.to_dict() == {"__class__": "A"}
+
+    b = A(a=[1, 2, 3], d=8)
+    b_dict = b.to_dict()
+    assert b_dict.pop("__class__") == "A"
+    assert np.all(b_dict.pop("a") == [1, 2, 3])
+    assert b_dict.pop("d") == 8
+    assert b_dict == {}

{xobjects-0.3.1 → xobjects-0.4.0}/xobjects/__init__.py

@@ -36,4 +36,6 @@ from .linkedarray import BypassLinked
 
 from .general import _print
 
+from .test_helpers import assert_allclose
+
 from ._version import __version__

xobjects-0.4.0/xobjects/_version.py

@@ -0,0 +1 @@
+__version__ = "0.4.0"

{xobjects-0.3.1 → xobjects-0.4.0}/xobjects/array.py

@@ -307,10 +307,14 @@ class Array(metaclass=MetaArray):
             if len(args) == 0:
                 value = None
             elif len(args) == 1:
-                shape = get_shape_from_array(args[0], len(cls._shape))
-                if shape != cls._shape:
-                    raise ValueError(f"shape not valid for {args[0]} ")
-                value = args[0]
+                (arg,) = args
+                if arg is None:
+                    value = None
+                else:
+                    shape = get_shape_from_array(arg, len(cls._shape))
+                    if shape != cls._shape:
+                        raise ValueError(f"shape not valid for {arg} ")
+                    value = arg
             elif len(args) > 1:
                 raise ValueError("too many arguments")
             size = cls._size

{xobjects-0.3.1 → xobjects-0.4.0}/xobjects/context_cpu.py

@@ -146,7 +146,7 @@ class ContextCpu(XContext):
         """
         super().__init__()
         self.omp_num_threads = omp_num_threads
-        if omp_num_threads==0:
+        if omp_num_threads == 0:
             self.allow_prebuilt_kernels = True
 
     def __str__(self):
@@ -517,10 +517,12 @@ class ContextCpu(XContext):
     def cffi_module_for_c_types(c_types, containing_dir="."):
         path = Path(containing_dir)
         for file in path.iterdir():
-            if not file.suffix in ['.so', '.dylib', '.dll']:
+            if not file.suffix in [".so", ".dylib", ".dll"]:
                 continue
-            module_name = file.name.split('.')[0]
-            spec = importlib.util.spec_from_file_location(module_name, str(file))
+            module_name = file.name.split(".")[0]
+            spec = importlib.util.spec_from_file_location(
+                module_name, str(file)
+            )
             module = importlib.util.module_from_spec(spec)
 
             typedefs = module.ffi.list_types()[0]

{xobjects-0.3.1 → xobjects-0.4.0}/xobjects/hybrid_class.py

@@ -40,13 +40,14 @@ class _FieldOfDressed:
         if self.isnplikearray:
             self.__get__(container=container)[:] = value
         elif hasattr(value, "_xobject"):  # value is a dressed xobject
+
             # Copy xobject data from value inside self._xobject
             # (unless same memory area or Ref and same buffer,
             #  in the latter case reference mechanism is used)
             if not (
                 container._xobject._buffer is value._xobject._buffer
-                and getattr(container._xobject, self.name)._offset
-                == value._xobject._offset
+                and (getattr(container._xobject, self.name) is not None and
+                    getattr(container._xobject, self.name)._offset == value._xobject._offset)
             ):
                 setattr(container._xobject, self.name, value._xobject)
 
@@ -198,15 +199,16 @@ class MetaHybridClass(type):
 class HybridClass(metaclass=MetaHybridClass):
     _movable = True
     _overridable = True
+    _force_moveable = False
 
     def move(self, _context=None, _buffer=None, _offset=None):
-        if not self._movable:
+        if not self._movable and not self._force_moveable:
             raise MemoryError(
                 "This object cannot be moved, likely because it "
                 "lives within another. Please, make a copy."
             )
 
-        if self._xobject._has_refs:
+        if self._xobject._has_refs and not self._force_moveable:
             raise MemoryError(
                 "This object cannot be moved, as it contains "
                 "references to other objects."
@@ -285,34 +287,33 @@ class HybridClass(metaclass=MetaHybridClass):
         else:
             obj = self
 
-        for ff in obj._fields:
-            if (
-                hasattr(self, "_skip_in_to_dict")
-                and ff in self._skip_in_to_dict
-            ):
-                continue
+        skip_fields = set(getattr(obj, "_skip_in_to_dict", []))
+        additional_fields = set(getattr(obj, "_store_in_to_dict", []))
+        fields_to_store = (set(obj._fields) - skip_fields) | additional_fields
+
+        defaults = {}
+        for field in obj._XoStruct._fields:
+            try:
+                defaults[field.name] = field.get_default()
+            except (TypeError, ValueError):
+                # The above can fail with different error types
+                # if a field type is dynamic.
+                pass
+
+        for ff in fields_to_store:
             vv = getattr(obj, ff)
             if hasattr(vv, "to_dict"):
                 out[ff] = vv.to_dict()
             elif hasattr(vv, "_to_dict"):
                 out[ff] = vv._to_dict()
-            else:
+            elif np.any(defaults.get(ff) != vv):
+                # Only include those scalar values that are not default.
                 out[ff] = vv
 
-        if hasattr(obj, "_store_in_to_dict"):
-            for nn in obj._store_in_to_dict:
-                ww = getattr(obj, nn)
-                if hasattr(ww, "to_dict"):
-                    out[nn] = ww.to_dict()
-                elif hasattr(ww, "_to_dict"):
-                    out[nn] = ww._to_dict()
-                else:
-                    out[nn] = ww
-
         return out
 
-    @classmethod
-    def from_dict(cls, dct, _context=None, _buffer=None, _offset=None):
+    @staticmethod
+    def _static_from_dict(cls, dct, _context=None, _buffer=None, _offset=None):
         return cls(
             **dct,
             _context=_context,
@@ -321,6 +322,15 @@ class HybridClass(metaclass=MetaHybridClass):
             _kwargs_name_check=False,
         )
 
+    @classmethod
+    def from_dict(cls, dct, _context=None, _buffer=None, _offset=None):
+        return HybridClass._static_from_dict(cls,
+            dct,
+            _context=_context,
+            _buffer=_buffer,
+            _offset=_offset,
+        )
+
     def copy(self, _context=None, _buffer=None, _offset=None):
         if _context is None and _buffer is None:
             _context = self._xobject._buffer.context
@@ -367,7 +377,25 @@ class HybridClass(metaclass=MetaHybridClass):
         return self._xobject.compile_kernels(*args, **kwargs)
 
     def __repr__(self):
-        args = [f"{fname}={getattr(self, fname)}" for fname in self._fields]
+
+        if hasattr(self, "_repr_fields"):
+            fnames = self._repr_fields
+        else:
+            fnames = []
+            if hasattr(self, "_add_to_repr"):
+                fnames += self._add_to_repr
+            fnames += [fname for fname in self._fields]
+            if hasattr(self, "_skip_in_repr"):
+                fnames = [ff for ff in fnames if ff not in self._skip_in_repr]
+
+        args = []
+        for fname in fnames:
+            vv = getattr(self, fname)
+            if isinstance(vv, float):
+                vvrepr = f"{vv:.3g}"
+            else:
+                vvrepr = repr(vv)
+            args.append(f"{fname}={vvrepr}")
         return f'{type(self).__name__}({", ".join(args)})'
 
 

{xobjects-0.3.1 → xobjects-0.4.0}/xobjects/test_helpers.py

@@ -5,6 +5,7 @@
 
 from functools import wraps
 from typing import Callable, Iterable, Union
+from numpy.testing import assert_allclose as np_assert_allclose
 
 import pytest
 
@@ -83,3 +84,10 @@ def requires_context(context_name: str):
         return lambda test_function: test_function
 
     return pytest.mark.skip(f"{context_name} is unavailable on this platform.")
+
+def assert_allclose(a, b, rtol=1e-7, atol=1e-7):
+    if hasattr(a, 'get'):
+        a = a.get()
+    if hasattr(b, 'get'):
+        b = b.get()
+    np_assert_allclose(a, b, rtol=rtol, atol=atol)

{xobjects-0.3.1 → xobjects-0.4.0/xobjects.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: xobjects
-Version: 0.3.1
+Version: 0.4.0
 Summary: In-memory serialization and code generator for CPU and GPU
 Home-page: https://xsuite.readthedocs.io/
 Download-URL: https://pypi.python.org/pypi/xobjects

xobjects-0.3.1/xobjects/_version.py

@@ -1 +0,0 @@
-__version__ = "0.3.1"