pelutils 3.8.4__tar.gz → 3.8.5__tar.gz

{pelutils-3.8.4 → pelutils-3.8.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pelutils
-Version: 3.8.4
+Version: 3.8.5
 Summary: The Swiss army knife of Python projects.
 Home-page: https://github.com/peleiden/pelutils
 Download-URL: https://pypi.org/project/pelutils/
@@ -275,7 +275,7 @@ log2.configure("path/to/save/log2.log")
 
 A few different numpy types are defined for the convenience of not having to remember what data types your arrays are - and also to satisfy your nasty type checkers.
 ```py
-from pelutils.types import AnyArray, FloatArray, IntArray
+from pelutils.types import AnyArray, BoolArray, ComplexArray, FloatArray, IntArray
 
 
 def function_which_takes_np_types(

{pelutils-3.8.4 → pelutils-3.8.5}/README.md

@@ -250,7 +250,7 @@ log2.configure("path/to/save/log2.log")
 
 A few different numpy types are defined for the convenience of not having to remember what data types your arrays are - and also to satisfy your nasty type checkers.
 ```py
-from pelutils.types import AnyArray, FloatArray, IntArray
+from pelutils.types import AnyArray, BoolArray, ComplexArray, FloatArray, IntArray
 
 
 def function_which_takes_np_types(

{pelutils-3.8.4 → pelutils-3.8.5}/pelutils/__init__.py

@@ -24,7 +24,6 @@ import numpy as np
 import psutil
 
 try:
-    # torch is only to be installed if pelutils[ds] has been installed
     import torch
 
     _has_torch = True

{pelutils-3.8.4 → pelutils-3.8.5}/pelutils/__version__.py

@@ -1,2 +1,2 @@
 # Do not put anything else in this file
-__version__ = "3.8.4"
+__version__ = "3.8.5"

{pelutils-3.8.4 → pelutils-3.8.5}/pelutils/datastorage2/_pretty_json.py

@@ -9,6 +9,13 @@ import json
 import pickle
 from typing import Any
 
+try:
+    import torch
+
+    _has_torch = True
+except ModuleNotFoundError:
+    _has_torch = False
+
 # Sentinel prefix so consumers can detect pickled blobs.
 _PICKLE_PREFIX = "__pickled_b64__"
 
@@ -45,6 +52,10 @@ def _get_qualified_type_name(obj: object) -> str:
 
 def _pickle_encode(value: object) -> str:
     """Pickle *value*, base64-encode the bytes, and return a prefixed string."""
+    if _has_torch and isinstance(value, torch.Tensor):  # pyright: ignore[reportPossiblyUnboundVariable]
+        # If a view of torch Tensor is given, the whole tensor is pickled, not just the view
+        # Therefore, it is cloned first to ensure that only the view itself is pickled
+        value = value.clone()
     raw = pickle.dumps(value, protocol=pickle.HIGHEST_PROTOCOL)
     encoded = base64.b64encode(raw).decode("ascii")
     return f"{_PICKLE_PREFIX}:{_get_qualified_type_name(value)}:{encoded}"

{pelutils-3.8.4 → pelutils-3.8.5}/pelutils/types.py

@@ -5,5 +5,7 @@ import numpy.typing as npt
 
 # Common numpy types
 AnyArray = npt.NDArray[Any]  # pyright: ignore[reportExplicitAny]
+BoolArray = npt.NDArray[np.bool_]
+ComplexArray = npt.NDArray[np.complexfloating[Any]]  # pyright: ignore[reportExplicitAny, reportInvalidTypeArguments]
 FloatArray = npt.NDArray[np.floating[Any]]  # pyright: ignore[reportExplicitAny]
 IntArray = npt.NDArray[np.integer[Any]]  # pyright: ignore[reportExplicitAny]

{pelutils-3.8.4 → pelutils-3.8.5}/pelutils.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pelutils
-Version: 3.8.4
+Version: 3.8.5
 Summary: The Swiss army knife of Python projects.
 Home-page: https://github.com/peleiden/pelutils
 Download-URL: https://pypi.org/project/pelutils/
@@ -275,7 +275,7 @@ log2.configure("path/to/save/log2.log")
 
 A few different numpy types are defined for the convenience of not having to remember what data types your arrays are - and also to satisfy your nasty type checkers.
 ```py
-from pelutils.types import AnyArray, FloatArray, IntArray
+from pelutils.types import AnyArray, BoolArray, ComplexArray, FloatArray, IntArray
 
 
 def function_which_takes_np_types(

{pelutils-3.8.4 → pelutils-3.8.5}/tests/test_types.py

@@ -1,14 +1,16 @@
 import numpy as np
 
-from pelutils.types import AnyArray, FloatArray, IntArray
+from pelutils import AnyArray, BoolArray, ComplexArray, FloatArray, IntArray
 
 
 def function_which_takes_np_types(
     any_array: AnyArray,
+    bool_array: BoolArray,
+    complex_array: ComplexArray,
     float_array: FloatArray,
     int_array: IntArray,
-) -> FloatArray:
-    return any_array + float_array + int_array
+) -> ComplexArray:
+    return any_array + bool_array + complex_array + float_array + int_array
 
 
 def test_types():
@@ -17,6 +19,8 @@ def test_types():
     Just make sure that using the types doesn't break anything silly like function declarations.
     """
     any_array = np.arange(5, dtype=np.float16)
+    bool_array = np.arange(5).astype(bool)
+    complex_array = 1j * np.arange(5)
     float_array = np.arange(5, dtype=np.float32)
     int_array = np.arange(5)
-    function_which_takes_np_types(any_array, float_array, int_array)
+    function_which_takes_np_types(any_array, bool_array, complex_array, float_array, int_array)