vector-structure 1.0.0__tar.gz → 2.0.0__tar.gz

{vector_structure-1.0.0 → vector_structure-2.0.0}/.gitignore

@@ -4,5 +4,6 @@
 __pycache__/
 
 # Distribution / packaging
+dist/
 build/
 *.egg-info/

{vector_structure-1.0.0 → vector_structure-2.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: vector-structure
-Version: 1.0.0
+Version: 2.0.0
 Project-URL: Homepage, https://github.com/warggr/vector-structure
 Project-URL: Issues, https://github.com/warggr/vector-structure/issues
 Author-email: Pierre Ballif <pierre@ballif.eu>
@@ -11,6 +11,9 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.5
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # vector-structure

{vector_structure-1.0.0 → vector_structure-2.0.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "vector-structure"
-version = "1.0.0"
+version = "2.0.0"
 description = ""
 authors = [{ name = "Pierre Ballif", email = "pierre@ballif.eu"}]
 license = "MIT"
-license-files = ["LICENSE"] 
+license-files = ["LICENSE"]
 readme = "README.md"
 requires-python = ">=3.5"
 classifiers = [
@@ -15,6 +15,9 @@ classifiers = [
 keywords = ["vector", "structure", "block", "matrix"]
 dependencies = []
 
+[project.optional-dependencies]
+dev = ["pytest", "ruff"]
+
 [project.urls]
 Homepage = "https://github.com/warggr/vector-structure"
 Issues = "https://github.com/warggr/vector-structure/issues"
@@ -24,8 +27,13 @@ requires = ["hatchling >= 1.26"]
 build-backend = "hatchling.build"
 
 [tool.hatch.build.targets.sdist]
-include = ["/vector_structure/", "/tests"]
+include = ["/vector_structure/"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]
 
 [tool.ruff.lint]
 select = ["B", "A", "I", "D", "E4", "E7", "E9", "F"]
 ignore = ["D203", "D213", "D104", "D100", "D105", "D107"]
+per-file-ignores = { "tests/*" = ["D103"] }

{vector_structure-1.0.0 → vector_structure-2.0.0}/vector_structure/structure.py

@@ -1,33 +1,12 @@
-from typing import Sequence
+from typing import Generic, Sequence, TypeVar
 
+BlockName = TypeVar("BlockName")
 
-class SimpleSlice:
-    """Represents a contiguous range.
 
-    Behaves like a `slice` object.
-    """
-
-    def __init__(self, start: int, stop: int):
-        self.start = start
-        self.stop = stop
-
-    step = 1
-
-    @staticmethod
-    def from_slice(sl: slice) -> "SimpleSlice":
-        """Translate a `slice` into a SimpleSlice."""
-        if sl.step not in (1, None):
-            raise ValueError()
-        return SimpleSlice(sl.start, sl.stop)
-
-    def __len__(self):
-        return self.start - self.stop
-
-
-class VectorStructure:
+class VectorStructure(Generic[BlockName]):
     """Helper class to describe block vectors and block matrices."""
 
-    def __init__(self, sizes: Sequence[tuple[str, int]]):
+    def __init__(self, sizes: Sequence[tuple[BlockName, int]]):
         cuts = {}
         start = 0
         for k, v in sizes:
@@ -36,10 +15,14 @@ class VectorStructure:
         self.size = start
         self.cuts = cuts
 
-    def __getitem__(self, idx: str | Sequence[str] | slice) -> SimpleSlice:
-        if isinstance(idx, str):
-            return self.cuts[idx]
-        elif isinstance(idx, slice):
+    def __getitem__(self, idx: BlockName | tuple[BlockName, ...] | slice) -> slice:
+        """Get the indices for one or multiple blocks.
+
+        Note: when indexing by slice, both the start and the stop are included,
+        i.e. a["a":"c"] = a["a", "b", "c"].
+        This is different from the Python convention, but similar to Pandas.
+        """
+        if isinstance(idx, slice):
             if idx.step is not None:
                 raise ValueError("slice step [start:stop:step] not supported")
             start, stop = None, None
@@ -51,12 +34,12 @@ class VectorStructure:
                 if name == idx.start:
                     start = cut.start
                 if name == idx.stop:
-                    stop = cut.start
+                    stop = cut.stop
                     break
             if start is None or stop is None:
                 raise ValueError(f"{idx.start} or {idx.stop} not found")
-            return SimpleSlice(start, stop)
-        else:
+            return slice(start, stop)
+        elif isinstance(idx, tuple):
             first, *more = idx
             start = self.cuts[first].start
             stop = self.cuts[first].stop
@@ -64,4 +47,6 @@ class VectorStructure:
                 next_cut = self.cuts[idx]
                 assert next_cut.start == stop
                 stop = next_cut.stop
-            return SimpleSlice(start, stop)
+            return slice(start, stop)
+        else:
+            return self.cuts[idx]