inline-snapshot-numpy 0.1.0__py3-none-any.whl

inline_snapshot_numpy/__init__.py

@@ -0,0 +1,105 @@
+from functools import wraps
+from typing import Optional
+
+import numpy
+import numpy.testing
+from inline_snapshot import snapshot, snapshot_arg
+from inline_snapshot._snapshot.generic_value import GenericValue
+from inline_snapshot.plugin import ImportFrom, customize
+
+__version__ = "0.1.0"
+
+__all__ = (
+    "assert_allclose",
+    "assert_array_almost_equal",
+    "assert_array_almost_equal_nulp",
+    "assert_array_equal",
+    "assert_array_max_ulp",
+    "setup",
+    "snapshot",
+)
+
+
+class Array:
+    # Make NumPy defer ndarray comparisons to this wrapper.
+    __array_priority__ = float("inf")
+
+    def __init__(self, value, compare):
+        self.value = value
+        self.compare = compare
+
+    def __eq__(self, other):
+        if isinstance(other, GenericValue):
+            return NotImplemented
+        if isinstance(other, Array):
+            other = other.value
+        return self.compare(self.value, other)
+
+
+@customize
+def customize_array(value, builder):
+    if not isinstance(value, Array):
+        return None
+
+    array = numpy.asarray(value.value)
+    values = array.tolist()
+
+    try:
+        inferred_dtype = numpy.asarray(values).dtype
+    except (TypeError, ValueError):  # pragma: no cover - defensive for object arrays
+        inferred_dtype = None
+
+    kwargs = {}
+    if inferred_dtype != array.dtype:
+        kwargs["dtype"] = (
+            array.dtype.descr if array.dtype.names is not None else array.dtype.str
+        )
+
+    array_function = builder.create_code(
+        "array", imports=[ImportFrom("numpy", "array")]
+    )
+    return builder.create_call(array_function, [values], kwargs)
+
+
+def _make_assert_equal(assert_equal):
+    @wraps(assert_equal)
+    def result(actual, desired=..., *args, **kwargs):
+        error: Optional[Exception] = None
+
+        def compare(left, right):
+            nonlocal error
+            try:
+                assert_equal(left, right, *args, **kwargs)
+            except Exception as exception:
+                error = exception
+                return False
+            return True
+
+        if not isinstance(desired, GenericValue):
+            desired = Array(desired, compare)
+        desired = snapshot_arg(desired)
+
+        if not (Array(actual, compare) == desired):
+            assert error is not None
+            raise error
+
+    return result
+
+
+assert_allclose = _make_assert_equal(numpy.testing.assert_allclose)
+assert_array_almost_equal = _make_assert_equal(numpy.testing.assert_array_almost_equal)
+assert_array_almost_equal_nulp = _make_assert_equal(
+    numpy.testing.assert_array_almost_equal_nulp
+)
+assert_array_equal = _make_assert_equal(numpy.testing.assert_array_equal)
+assert_array_max_ulp = _make_assert_equal(numpy.testing.assert_array_max_ulp)
+
+
+def setup():
+    """Make NumPy's testing helpers accept inline snapshots."""
+
+    numpy.testing.assert_allclose = assert_allclose
+    numpy.testing.assert_array_almost_equal = assert_array_almost_equal
+    numpy.testing.assert_array_almost_equal_nulp = assert_array_almost_equal_nulp
+    numpy.testing.assert_array_equal = assert_array_equal
+    numpy.testing.assert_array_max_ulp = assert_array_max_ulp

inline_snapshot_numpy-0.1.0.dist-info/METADATA

@@ -0,0 +1,86 @@
+Metadata-Version: 2.5
+Name: inline-snapshot-numpy
+Version: 0.1.0
+Summary: NumPy integration for inline-snapshot
+Project-URL: Documentation, https://github.com/15r10nk/inline-snapshot-numpy#readme
+Project-URL: Issues, https://github.com/15r10nk/inline-snapshot-numpy/issues
+Project-URL: Source, https://github.com/15r10nk/inline-snapshot-numpy
+Author-email: Frank Hoffmann <15r10nk@polarbit.de>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.9
+Requires-Dist: inline-snapshot>=0.36.1
+Requires-Dist: numpy>=1.20; python_version < '3.15'
+Requires-Dist: numpy>=2.5.4; python_version >= '3.15'
+Description-Content-Type: text/markdown
+
+# inline-snapshot-numpy
+
+[NumPy](https://numpy.org/) integration for
+[inline-snapshot](https://github.com/15r10nk/inline-snapshot).
+
+## Installation
+
+```bash
+pip install inline-snapshot-numpy
+```
+
+## Usage
+
+The package provides snapshot-aware versions of NumPy's array assertions:
+
+```python
+from inline_snapshot_numpy import assert_array_equal
+from numpy import array
+
+
+def test_array():
+    actual = array([[1, 2], [3, 4]])
+    assert_array_equal(actual)
+```
+
+Create the missing snapshot with:
+
+```bash
+pytest --inline-snapshot=create
+```
+
+The test will become:
+
+```python
+def test_array():
+    actual = array([[1, 2], [3, 4]])
+    assert_array_equal(actual, desired=array([[1, 2], [3, 4]]))
+```
+
+The following helpers are available: `assert_array_equal`, `assert_allclose`,
+`assert_array_almost_equal`, `assert_array_almost_equal_nulp`,
+and `assert_array_max_ulp`.
+
+The expected array is managed through `snapshot_arg()`, so no explicit
+`snapshot()` call or import is needed. You can still pass an explicit
+`snapshot(...)` for compatibility.
+
+Alternatively, call `setup()` from `conftest.py` to patch the corresponding
+functions in `numpy.testing`:
+
+```python
+from inline_snapshot_numpy import setup
+
+setup()
+```
+
+## License
+
+Distributed under the terms of the MIT license.

inline_snapshot_numpy-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+inline_snapshot_numpy/__init__.py,sha256=VKdxiDRuJLdvMW9ZWXGTP4RWQCMzmc3_u0zNQCIn384,3135
+inline_snapshot_numpy-0.1.0.dist-info/METADATA,sha256=WxJJmEyScHi3tJltDmvR_TTrQgESRPYi51UbG1OCOt0,2509
+inline_snapshot_numpy-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+inline_snapshot_numpy-0.1.0.dist-info/entry_points.txt,sha256=RWkqXB3hqUqPE5k8-DGmJgi1YALEDy-kGqgOnkBMkEQ,48
+inline_snapshot_numpy-0.1.0.dist-info/licenses/LICENSE,sha256=zWVpwX42Okr-pdIa0l5cGUv5kQx1tpfTvaF06kZfVgY,1081
+inline_snapshot_numpy-0.1.0.dist-info/RECORD,,

inline_snapshot_numpy-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

inline_snapshot_numpy-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[inline_snapshot]
+numpy = inline_snapshot_numpy

inline_snapshot_numpy-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Frank Hoffmann
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.