ZnSlice v0.1.1 (#2)

* add `LazySequence.from_obj` and update project

* add CI

* poetry update

* update coverage config

* test __repr__

Author: PythonFZ

.github/workflows/pytest.yaml

@@ -0,0 +1,36 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-python-with-github-actions
+
+name: pytest
+
+on:
+  push:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.10"
+      - name: Install Poetry
+        uses: abatilo/actions-poetry@v2
+        with:
+          poetry-version: 1.3.2
+      - name: Install package
+        run: |
+          poetry install --no-interaction
+      - name: Pytest
+        run: |
+          poetry run coverage run -m pytest
+          poetry run coverage lcov
+      - name: Coveralls
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: coverage.lcov

README.md

@@ -1,3 +1,5 @@
+[![PyPI version](https://badge.fury.io/py/znslice.svg)](https://badge.fury.io/py/znslice)
+[![Coverage Status](https://coveralls.io/repos/github/zincware/ZnSlice/badge.svg?branch=main)](https://coveralls.io/github/zincware/ZnSlice?branch=main)
 # ZnSlice
 
 A lightweight library  (without external dependencies) for:
@@ -14,6 +16,15 @@ pip install znslice
 # Usage
 
 ## Advanced Slicing and Cache
+Convert List to `znslice.LazySequence` to allow advanced slicing.
+```python
+import znslice
+
+lst = znslice.LazySequence.from_obj([1, 2, 3], indices=[0, 2])
+print(lst[[0, 1]].tolist())  # [1, 3]
+```
+
+
 ```python
 import znslice
 import collections.abc

poetry.lock

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ZnSlice"
-version = "0.1.0"
+version = "0.1.1"
 description = "Cache, advanced slicing and lazy loading for __getitem__"
 license = "Apache-2.0"
 authors = ["zincwarecode <[email protected]>"]
@@ -25,3 +25,18 @@ coverage = "^7.0.5"
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.coverage.run]
+relative_files = true
+branch = true
+# omit the tests themselves
+omit = ["*/tests/*", "*/tmp/*", "*/interface/*"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "raise AssertionError",
+    "raise NotImplementedError",
+    "if 0:",
+    "if __name__ == .__main__.:"
+]
+ignore_errors = true

pyproject.toml

@@ -0,0 +1,63 @@
+import pytest
+
+import znslice
+
+
+def test_LazySequenceInit():
+    lst = znslice.LazySequence.from_obj([1, 2, 3])
+    assert lst._obj == [[1, 2, 3]]
+    assert lst._indices == [[0, 1, 2]]
+    assert lst[:].tolist() == [1, 2, 3]
+    assert lst[0] == 1
+    assert lst[[0, 2]].tolist() == [1, 3]
+    assert len(lst) == 3
+
+
+def test_LazySequence_empty_Init():
+    lst = znslice.LazySequence.from_obj([])
+    assert len(lst) == 0
+    lst += znslice.LazySequence.from_obj([1, 2, 3])
+    assert len(lst) == 3
+    assert lst[:].tolist() == [1, 2, 3]
+
+
+def test_LazySequence_indices():
+    lst = znslice.LazySequence.from_obj([1, 2, 3], indices=[0, 2])
+    assert len(lst) == 2
+    assert lst[:].tolist() == [1, 3]
+    assert lst[0] == 1
+    assert lst[[0, 1]].tolist() == [1, 3]
+    assert lst[1] == 3
+
+    lst += znslice.LazySequence.from_obj([4, 5, 6], indices=[1, 2])
+    assert len(lst) == 4
+    assert lst[:].tolist() == [1, 3, 5, 6]
+    assert lst[0] == 1
+    assert lst[[0, 2]].tolist() == [1, 5]
+
+
+def test_add_LazySequence_list():
+    lst = znslice.LazySequence.from_obj([1, 2, 3], indices=[0, 2])
+    lst += [4, 5, 6]
+
+    assert len(lst) == 5
+    assert lst[:] == [1, 3, 4, 5, 6]
+    assert isinstance(lst, list)
+
+
+def test_from_LazySequence():
+    lst = znslice.LazySequence.from_obj(list(range(10)), indices=[0, 2, 4, 6, 8])
+    lst2 = znslice.LazySequence.from_obj(lst, indices=[0, 2, 4])
+    assert lst2[:].tolist() == [0, 4, 8]
+    assert lst2[0] == 0
+    assert lst[[0, 2]].tolist() == [0, 4]
+
+
+def test_from_LazySequence_err():
+    with pytest.raises(TypeError):
+        znslice.LazySequence.from_obj("Lorem Ipsum")
+
+
+def test_LazySequence_repr():
+    lst = znslice.LazySequence.from_obj([1, 2, 3], indices=[0, 2])
+    assert repr(lst) == "LazySequence([[1, 2, 3]], [[0, 2]])"

tests/test_LazySequence.py

@@ -5,6 +5,11 @@
 import znslice
 
 
+def test_version():
+    """Test 'ZnTrack' version."""
+    assert znslice.__version__ == "0.1.1"
+
+
 class CacheList(collections.abc.Sequence):
     def __init__(self, data):
         self.data = data
@@ -266,7 +271,7 @@ def test_LazyCacheList_addition_sliced():
 def test_LazyCacheList_addition_error():
     lst = LazyCacheList(list(range(10)))
     with pytest.raises(TypeError):
-        lst[:] + [1, 2, 3]
+        lst[:] + (1, 2, 3)
 
 
 def test_LazyCacheListLazySingle():
@@ -276,6 +281,7 @@ def test_LazyCacheListLazySingle():
     assert len(lstc) == 10
     assert len(lstc._obj) == 2
     assert len(lstc._indices) == 2
+    assert lstc._indices == [[0, 2, 4, 6, 8], [0, 2, 4, 6, 8]]
     assert lstc[:].tolist() == list(range(0, 20, 2))
     assert lstc[::2].tolist() == [0, 4, 8, 12, 16]
     assert lstc[[9]].tolist() == [18]
@@ -285,3 +291,14 @@ def test_LazyCacheListLazySingle():
     assert list(lstc)[8].tolist() == [16]
     with pytest.raises(IndexError):
         _ = lstc[10]
+
+
+def test_iter_LazyCacheList():
+    lst = LazyCacheList(list(range(10)))
+    for i, v in enumerate(lst):
+        assert i == v
+
+
+def test_add_lists():
+    lst = LazyCacheList(list(range(10)))[:]
+    assert lst + [1, 2, 3] == list(range(10)) + [1, 2, 3]