import sys

import pytest

import numpy as np
from numpy.testing import assert_array_equal


def new_and_old_dlpack():

    class OldDLPack(np.ndarray):
        # Support only the "old" version
        def __dlpack__(self, stream=None):
            return super().__dlpack__(stream=None)

    return [np.arange(5), np.arange(5).view(OldDLPack)]


class TestDLPack:
    @pytest.mark.parametrize("max_version", [(0, 0), None, (1, 0), (100, 3)])
    def test_dunder_dlpack_refcount(self, max_version):
        x = np.arange(5)
        y = x.__dlpack__(max_version=max_version)
        startcount = sys.getrefcount(x)
        del y
        assert startcount - sys.getrefcount(x) == 1

    def test_dunder_dlpack_stream(self):
        x = np.arange(5)
        x.__dlpack__(stream=None)

        with pytest.raises(
                ValueError, match="NumPy only supports stream=None."):
            x.__dlpack__(stream=1)

    def test_dunder_dlpack_copy(self):
        # Checks the argument parsing of __dlpack__ explicitly.
        # Honoring the flag is tested in the from_dlpack round-tripping test.
        x = np.arange(5)
        x.__dlpack__(copy=True)
        x.__dlpack__(copy=None)
        x.__dlpack__(copy=False)

        with pytest.raises(ValueError):
            # NOTE: The copy converter should be stricter, but not just here.
            x.__dlpack__(copy=np.array([1, 2, 3]))

    def test_strides_not_multiple_of_itemsize(self):
        dt = np.dtype([('int', np.int32), ('char', np.int8)])
        y = np.zeros((5,), dtype=dt)
        z = y['int']

        with pytest.raises(BufferError):
            np.from_dlpack(z)

    @pytest.mark.parametrize("arr", new_and_old_dlpack())
    def test_from_dlpack_refcount(self, arr):
        arr = arr.copy()
        y = np.from_dlpack(arr)
        startcount = sys.getrefcount(arr)
        del y
        assert startcount - sys.getrefcount(arr) == 1

    @pytest.mark.parametrize("dtype", [
        np.bool,
        np.int8, np.int16, np.int32, np.int64,
        np.uint8, np.uint16, np.uint32, np.uint64,
        np.float16, np.float32, np.float64,
        np.complex64, np.complex128
    ])
    @pytest.mark.parametrize("arr", new_and_old_dlpack())
    def test_dtype_passthrough(self, arr, dtype):
        x = arr.astype(dtype)
        y = np.from_dlpack(x)

        assert y.dtype == x.dtype
        assert_array_equal(x, y)

    def test_invalid_dtype(self):
        x = np.asarray(np.datetime64('2021-05-27'))

        with pytest.raises(BufferError):
            np.from_dlpack(x)

    def test_invalid_byte_swapping(self):
        dt = np.dtype('=i8').newbyteorder()
        x = np.arange(5, dtype=dt)

        with pytest.raises(BufferError):
            np.from_dlpack(x)

    def test_non_contiguous(self):
        x = np.arange(25).reshape((5, 5))

        y1 = x[0]
        assert_array_equal(y1, np.from_dlpack(y1))

        y2 = x[:, 0]
        assert_array_equal(y2, np.from_dlpack(y2))

        y3 = x[1, :]
        assert_array_equal(y3, np.from_dlpack(y3))

        y4 = x[1]
        assert_array_equal(y4, np.from_dlpack(y4))

        y5 = np.diagonal(x).copy()
        assert_array_equal(y5, np.from_dlpack(y5))

    @pytest.mark.parametrize("ndim", range(33))
    def test_higher_dims(self, ndim):
        shape = (1,) * ndim
        x = np.zeros(shape, dtype=np.float64)

        assert shape == np.from_dlpack(x).shape

    def test_dlpack_device(self):
        x = np.arange(5)
        assert x.__dlpack_device__() == (1, 0)
        y = np.from_dlpack(x)
        assert y.__dlpack_device__() == (1, 0)
        z = y[::2]
        assert z.__dlpack_device__() == (1, 0)

    def dlpack_deleter_exception(self, max_version):
        x = np.arange(5)
        _ = x.__dlpack__(max_version=max_version)
        raise RuntimeError

    @pytest.mark.parametrize("max_version", [None, (1, 0)])
    def test_dlpack_destructor_exception(self, max_version):
        with pytest.raises(RuntimeError):
            self.dlpack_deleter_exception(max_version=max_version)

    def test_readonly(self):
        x = np.arange(5)
        x.flags.writeable = False
        # Raises without max_version
        with pytest.raises(BufferError):
            x.__dlpack__()

        # But works fine if we try with version
        y = np.from_dlpack(x)
        assert not y.flags.writeable

    def test_writeable(self):
        x_new, x_old = new_and_old_dlpack()

        # new dlpacks respect writeability
        y = np.from_dlpack(x_new)
        assert y.flags.writeable

        # old dlpacks are not writeable for backwards compatibility
        y = np.from_dlpack(x_old)
        assert not y.flags.writeable

    def test_ndim0(self):
        x = np.array(1.0)
        y = np.from_dlpack(x)
        assert_array_equal(x, y)

    def test_size1dims_arrays(self):
        x = np.ndarray(dtype='f8', shape=(10, 5, 1), strides=(8, 80, 4),
                       buffer=np.ones(1000, dtype=np.uint8), order='F')
        y = np.from_dlpack(x)
        assert_array_equal(x, y)

    def test_copy(self):
        x = np.arange(5)

        y = np.from_dlpack(x)
        assert np.may_share_memory(x, y)
        y = np.from_dlpack(x, copy=False)
        assert np.may_share_memory(x, y)
        y = np.from_dlpack(x, copy=True)
        assert not np.may_share_memory(x, y)

    def test_device(self):
        x = np.arange(5)
        # requesting (1, 0), i.e. CPU device works in both calls:
        x.__dlpack__(dl_device=(1, 0))
        np.from_dlpack(x, device="cpu")
        np.from_dlpack(x, device=None)

        with pytest.raises(BufferError):
            x.__dlpack__(dl_device=(10, 0))
        with pytest.raises(ValueError):
            np.from_dlpack(x, device="gpu")


class TestRegisterDlpackDtype:
    @pytest.fixture(scope="class", autouse=True)
    @staticmethod
    def dlpack_registry_clear():
        prev = np._core._multiarray_umath._dlpack_registry_replace({}, {})
        yield
        np._core._multiarray_umath._dlpack_registry_replace(*prev)

    @pytest.mark.parametrize("key,dtype", [
        ((2,), np.dtype("f4")),
        ((2, 2, 2), np.dtype(np.float16)),
        (None, np.dtype(np.float16)),
        ((4, 16), "S2"),  # not a dtype instance
    ])
    def test_register_bad_dlpack_tuple(self, key, dtype):
        with pytest.raises(TypeError):
            np.dtypes.register_dlpack_dtype(key, dtype)

    @pytest.mark.parametrize("key,dtype", [
        ((-1, 16), np.dtype(np.float16)),
        ((256, 16), np.dtype(np.float16)),
        ((4, 15), np.dtype(np.float16)),
        ((4, 256), np.dtype("V256")),
        ((4, 15), np.dtype(np.float32)),
    ])
    def test_register_bad_code_or_bits(self, key, dtype):
        with pytest.raises(ValueError, match="(0..255|must match the dtype)"):
            np.dtypes.register_dlpack_dtype(key, dtype)

    def test_register_idempotent(self):
        dt = np.dtype(np.float16)
        np.dtypes.register_dlpack_dtype((4, 16), dt)
        np.dtypes.register_dlpack_dtype((4, 16), dt)

    def test_roundtrip(self, dtype=np.dtype("S1")):  # noqa: B008
        # Register "S1" as kDLFloat8_e3m4 == 7
        # (use of kwarg ensure singleton in free-threading)
        np.dtypes.register_dlpack_dtype((7, 8), dtype)
        x = np.array([1.0, 2.0], dtype="S1")
        y = np.from_dlpack(x)
        assert y.dtype == "S1"
        assert_array_equal(x, y)

    def test_register_conflict(self):
        np.dtypes.register_dlpack_dtype((4, 16), np.dtype(np.float16))
        with pytest.raises(ValueError, match="already exported"):
            np.dtypes.register_dlpack_dtype((5, 16), np.dtype(np.float16))

        a = np.array(["12", "23"])
        with pytest.raises(BufferError):
            np.from_dlpack(a)  # dtype not yet registered

        with pytest.raises(ValueError, match="already maps"):
            np.dtypes.register_dlpack_dtype((4, 16), np.dtype("S2"))

        # But... accept that this now does get exported (but won't roundtrip)
        arr = np.from_dlpack(np.array(["12", "23"], dtype="S2"))
        assert arr.dtype == np.float16

    @pytest.mark.thread_unsafe(reason="dlpack registry is thread-unsafe")
    def test_buffererror_bad_dtype(self, dtype=np.dtype("S3")):  # noqa: B008
        # Register S3 as a nonsensical dtype
        np.dtypes.register_dlpack_dtype((123, 24), dtype)
        # Delete from import but not from export.
        imp, exp = np._core._multiarray_umath._dlpack_registry_replace({}, {})
        imp.pop((123, 24))
        np._core._multiarray_umath._dlpack_registry_replace(imp, exp)

        arr = np.array(["1", "2"], dtype=dtype)
        arr.__dlpack__()  # passes
        with pytest.raises(BufferError):
            np.from_dlpack(arr)  # doesn't round-trip