add pytest tests

Author: ScottBoyce

tests/__init__.py

@@ -0,0 +1,12 @@
+"""
+NumpyDeque pytest functions for validation.
+"""
+
+# Note: File is necessary for vscode to prevent a "pytest test discovery error for workspace"
+#       If not present then the following error is raised:
+#
+# [error] Subprocess exited unsuccessfully with exit code 2 and signal null on workspace c:\XYZ\XYZ\XYZ\NumpyDeque.
+# [error] Subprocess exited unsuccessfully with exit code 2 and signal null on workspace c:\XYZ\XYZ\XYZ\NumpyDeque. Creating and sending error discovery payload
+# [error] pytest test discovery error for workspace:  c:\XYZ\XYZ\XYZ\NumpyDeque
+#
+# The python test process was terminated before it could exit on its own, the process errored with: Code: 2, Signal: null for workspace c:\XYZ\XYZ\XYZ\NumpyDeque

tests/test_general_methods.py

@@ -0,0 +1,113 @@
+import pytest
+import numpy as np
+from NumpyDeque import NumpyDeque
+
+
+@pytest.fixture
+def empty_deque():
+    return NumpyDeque(maxsize=5)
+
+
+@pytest.fixture
+def filled_deque():
+    return NumpyDeque.array([1, 2, 3, 4, 5], maxsize=5)
+
+
+def test_buffer_shift():
+    array_like = [1, 2, 3, 4, 5]
+    d = NumpyDeque.array(array_like, priority="rightonly", _force_buffer_size=10)
+    assert d._s == 0  # buffer shift index
+    assert len(d) == 5
+    assert d.buffer_size == 10
+    assert d.maxsize == 5
+    for i in range(6, 11):
+        d.put(i)
+    d.put(11)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([7, 8, 9, 10, 11]))
+    for i in range(6):
+        d.putleft(i)  # shift occurs always
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([5, 4, 3, 2, 1]))
+
+    array_like = [1, 2, 3, 4, 5]
+    d = NumpyDeque.array(array_like, priority="right", _force_buffer_size=10)
+    assert d._s == 1  # buffer shift index
+    assert len(d) == 5
+    assert d.buffer_size == 10
+    assert d.maxsize == 5
+    for i in range(6, 10):
+        d.put(i)
+    d.put(10)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([6, 7, 8, 9, 10]))
+    d.putleft(0)
+    d.putleft(1)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([1, 0, 6, 7, 8]))
+
+    d = NumpyDeque.array(array_like, priority="left", _force_buffer_size=10)
+    assert d._s == 3  # buffer shift index
+    assert len(d) == 5
+    assert d.buffer_size == 10
+    assert d.maxsize == 5
+    for i in range(6, 8):
+        d.put(i)  # shift occurs
+    d.put(8)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([4, 5, 6, 7, 8]))
+    for i in range(3):
+        d.putleft(i)
+    d.putleft(3)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([3, 2, 1, 0, 4]))
+
+    d = NumpyDeque.array(array_like, priority="leftonly", _force_buffer_size=10)
+    assert d._s == 5  # buffer shift index
+    assert len(d) == 5
+    assert d.buffer_size == 10
+    assert d.maxsize == 5
+    for i in range(6, 11):
+        d.put(i)  # shift occurs always
+    d.put(11)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([7, 8, 9, 10, 11]))
+    for i in range(5):
+        d.putleft(i)
+    d.putleft(5)  # shift occurs
+    assert d._i == d._s
+    assert np.all(d.deque == np.array([5, 4, 3, 2, 1]))
+
+
+def test_invalid_priority():
+    with pytest.raises(ValueError):
+        NumpyDeque(maxsize=5, priority="invalid")
+
+
+def test_clear(filled_deque):
+    filled_deque.clear()
+    assert len(filled_deque) == 0
+
+
+def test_copy(filled_deque):
+    copied_deque = filled_deque.copy()
+    assert len(copied_deque) == len(filled_deque)
+    assert np.array_equal(copied_deque.deque, filled_deque.deque)
+    assert copied_deque is not filled_deque
+
+
+def test_reverse(filled_deque):
+    filled_deque.reverse()
+    assert np.array_equal(filled_deque.deque, [5, 4, 3, 2, 1])
+
+
+def test_abs():
+    d = NumpyDeque.array([-1, -2, 3, -4, 5], maxsize=5)
+    d.abs()
+    assert np.array_equal(d.deque, [1, 2, 3, 4, 5])
+
+
+def test_sort():
+    d = NumpyDeque.array([3, 1, 4, 2, 5], maxsize=5)
+    d.sort()
+    assert np.array_equal(d.deque, [1, 2, 3, 4, 5])

tests/test_initialization.py

@@ -0,0 +1,249 @@
+from NumpyDeque import NumpyDeque
+import numpy as np
+
+
+def test_initialization_array():
+    array_like = [1, 2, 3, 4, 5]
+    d = NumpyDeque.array(array_like)
+    assert len(d) == 5
+    assert d.maxsize == 5
+    assert np.all(d.deque == np.array(array_like))
+
+    d = NumpyDeque.array(array_like, maxsize=10)
+    assert len(d) == 5
+    assert d.maxsize == 10
+    assert np.all(d.deque == np.array(array_like))
+
+
+def test_empty_initialization():
+    d = NumpyDeque(maxsize=10)
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100)
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+
+def test_fill_initialization():
+    d = NumpyDeque(maxsize=10, fill=1)
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, fill=2)
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 2)
+    assert len(d.deque) == 100
+
+
+def test_int64_initialization():
+    d = NumpyDeque(maxsize=10, dtype=np.int64)
+    assert d.dtype == np.int64
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100, dtype=np.int64)
+    assert d.dtype == np.int64
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=10, fill=1, dtype=np.int64)
+    assert d.dtype == np.int64
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, fill=2, dtype=np.int64)
+    assert d.dtype == np.int64
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 2)
+    assert len(d.deque) == 100
+
+
+def test_float64_initialization():
+    d = NumpyDeque(maxsize=10, dtype=np.float64)
+    assert d.dtype == np.float64
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100, dtype=np.float64)
+    assert d.dtype == np.float64
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=10, fill=1, dtype=np.float64)
+    assert d.dtype == np.float64
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1.0)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, fill=2, dtype=np.float64)
+    assert d.dtype == np.float64
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 2.0)
+    assert len(d.deque) == 100
+
+
+def test_pad_initialization():
+    siz = 10
+    pad = 10
+    d = NumpyDeque(maxsize=siz, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == 0
+    assert d.maxsize == siz
+
+    siz = 100
+    pad = 10
+    d = NumpyDeque(maxsize=siz, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == 0
+    assert d.maxsize == siz
+
+    siz = 10
+    pad = 100
+    d = NumpyDeque(maxsize=siz, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == 0
+    assert d.maxsize == siz
+
+    siz = 100
+    pad = 100
+    d = NumpyDeque(maxsize=siz, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == 0
+    assert d.maxsize == siz
+
+    siz = 10
+    pad = 10
+    d = NumpyDeque(maxsize=siz, fill=1, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == siz
+    assert d.maxsize == siz
+    assert np.all(d.deque == 1)
+
+    siz = 100
+    pad = 10
+    d = NumpyDeque(maxsize=siz, fill=2, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == siz
+    assert d.maxsize == siz
+    assert np.all(d.deque == 2)
+
+    siz = 10
+    pad = 100
+    d = NumpyDeque(maxsize=siz, fill=1, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == siz
+    assert d.maxsize == siz
+    assert np.all(d.deque == 1)
+
+    siz = 100
+    pad = 100
+    d = NumpyDeque(maxsize=siz, fill=2, buffer_padding=pad)
+    assert d.buffer_size >= siz + 2 * pad
+    assert len(d) == siz
+    assert d.maxsize == siz
+    assert np.all(d.deque == 2)
+
+
+def test_priority_initialization():
+    d = NumpyDeque(maxsize=10, priority="right")
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=10, fill=1, priority="right")
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, priority="right")
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100, fill=1, priority="right")
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 100
+
+    d = NumpyDeque(maxsize=10, priority="rightonly")
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=10, fill=1, priority="rightonly")
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, priority="rightonly")
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100, fill=1, priority="rightonly")
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 100
+
+    d = NumpyDeque(maxsize=10, priority="left")
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=10, fill=1, priority="left")
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, priority="left")
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100, fill=1, priority="left")
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 100
+
+    d = NumpyDeque(maxsize=10, priority="leftonly")
+    assert len(d) == 0
+    assert d.maxsize == 10
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=10, fill=1, priority="leftonly")
+    assert len(d) == 10
+    assert d.maxsize == 10
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 10
+
+    d = NumpyDeque(maxsize=100, priority="leftonly")
+    assert len(d) == 0
+    assert d.maxsize == 100
+    assert len(d.deque) == 0
+
+    d = NumpyDeque(maxsize=100, fill=1, priority="leftonly")
+    assert len(d) == 100
+    assert d.maxsize == 100
+    assert np.all(d.deque == 1)
+    assert len(d.deque) == 100