feat: make arr a subclass of list (#211)

BREAKING: Renames `.count()` to `.len()` to avoid conflicts with Python `list` while maintaining backwards compatability.

.ruff.toml

@@ -11,7 +11,6 @@ select = [
     "COM",
     "D417",
     "E",
-    "ERA",
     "F",
     "I",
     "ICN",

integator.toml

@@ -0,0 +1,11 @@
+[integator]
+fail_fast = false
+push_on_success = true
+source_dir = "/Users/mabe/Git/iterpy"
+skip_if_no_diff_against_trunk = false
+trunk = "main"
+
+[[integator.commands]]
+name = "Test"
+cmd = "make docker_ci"
+max_staleness_seconds = 1

iterpy/arr.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from itertools import islice
-from typing import TYPE_CHECKING, Generic, Sequence, TypeVar, overload
+from typing import TYPE_CHECKING, Generic, Sequence, SupportsIndex, TypeVar, overload
 
 if TYPE_CHECKING:
     from collections.abc import Callable, Iterable, Iterator
@@ -12,7 +12,7 @@
 S = TypeVar("S")
 
 
-class Arr(Generic[T]):
+class Arr(Generic[T], list[T]):
     def __init__(self, iterable: Iterable[T]) -> None:
         self._iter = list(iterable)
         self._current_index: int = 0
@@ -36,11 +36,11 @@ def __next__(self) -> T:
         return item
 
     @overload
-    def __getitem__(self, index: int) -> T: ...
+    def __getitem__(self, index: SupportsIndex) -> T: ...
     @overload
     def __getitem__(self, index: slice) -> Arr[T]: ...
 
-    def __getitem__(self, index: int | slice) -> T | Arr[T]:
+    def __getitem__(self, index: SupportsIndex | slice) -> T | Arr[T]:
         if isinstance(index, int) and index >= 0:
             try:
                 return next(islice(self._iter, index, index + 1))
@@ -63,8 +63,8 @@ def __eq__(self, other: object) -> bool:
     def reduce(self, func: Callable[[T, T], T]) -> T:
         return self.lazy().reduce(func)
 
-    def count(self) -> int:
-        return self.lazy().count()
+    def len(self) -> int:
+        return self.lazy().len()
 
     ### Output
     def to_list(self) -> list[T]:
@@ -138,43 +138,43 @@ def flatten(self: Arr[Iterable[S]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[Iterable[S] | S]) -> Arr[S]: ...
 
-    # Iterator[S]   # noqa: ERA001
+    # Iterator[S]
     @overload
     def flatten(self: Arr[Iterator[S]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[Iterator[S] | S]) -> Arr[S]: ...
 
-    # tuple[S, ...]   # noqa: ERA001
+    # tuple[S, ...]
     @overload
     def flatten(self: Arr[tuple[S, ...]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[tuple[S, ...] | S]) -> Arr[S]: ...
 
-    # Sequence[S]   # noqa: ERA001
+    # Sequence[S]
     @overload
     def flatten(self: Arr[Sequence[S]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[Sequence[S] | S]) -> Arr[S]: ...
 
-    # list[S]   # noqa: ERA001
+    # list[S]
     @overload
     def flatten(self: Arr[list[S]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[list[S] | S]) -> Arr[S]: ...
 
-    # set[S]   # noqa: ERA001
+    # set[S]
     @overload
     def flatten(self: Arr[set[S]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[set[S] | S]) -> Arr[S]: ...
 
-    # frozenset[S]   # noqa: ERA001
+    # frozenset[S]
     @overload
     def flatten(self: Arr[frozenset[S]]) -> Arr[S]: ...
     @overload
     def flatten(self: Arr[frozenset[S] | S]) -> Arr[S]: ...
 
-    # Arr[S]   # noqa: ERA001
+    # Arr[S]
     @overload
     def flatten(self: Arr[Arr[S]]) -> Arr[S]: ...
     @overload

iterpy/iter.py

@@ -62,7 +62,7 @@ def __eq__(self, other: object) -> bool:
     def reduce(self, func: Callable[[T, T], T]) -> T:
         return reduce(func, self._iterator)
 
-    def count(self) -> int:
+    def len(self) -> int:
         return sum(1 for _ in self._iterator)
 
     ### Output
@@ -157,43 +157,43 @@ def flatten(self: Iter[Iterable[S]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[Iterable[S] | S]) -> Iter[S]: ...
 
-    # Iterator[S]   # noqa: ERA001
+    # Iterator[S]
     @overload
     def flatten(self: Iter[Iterator[S]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[Iterator[S] | S]) -> Iter[S]: ...
 
-    # tuple[S, ...]   # noqa: ERA001
+    # tuple[S, ...]
     @overload
     def flatten(self: Iter[tuple[S, ...]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[tuple[S, ...] | S]) -> Iter[S]: ...
 
-    # Sequence[S]   # noqa: ERA001
+    # Sequence[S]
     @overload
     def flatten(self: Iter[Sequence[S]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[Sequence[S] | S]) -> Iter[S]: ...
 
-    # list[S]   # noqa: ERA001
+    # list[S]
     @overload
     def flatten(self: Iter[list[S]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[list[S] | S]) -> Iter[S]: ...
 
-    # set[S]   # noqa: ERA001
+    # set[S]
     @overload
     def flatten(self: Iter[set[S]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[set[S] | S]) -> Iter[S]: ...
 
-    # frozenset[S]   # noqa: ERA001
+    # frozenset[S]
     @overload
     def flatten(self: Iter[frozenset[S]]) -> Iter[S]: ...
     @overload
     def flatten(self: Iter[frozenset[S] | S]) -> Iter[S]: ...
 
-    # Iter[S]   # noqa: ERA001
+    # Iter[S]
     @overload
     def flatten(self: Iter[Iter[S]]) -> Iter[S]: ...
     @overload

iterpy/test_arr.py

@@ -53,10 +53,20 @@ def test_reduce():
 
 def test_count():
     iterator = Arr([1, 2])
-    result: int = iterator.count()
+    result: int = iterator.len()
     assert result == 2
 
 
+def func(listicle: list[str]) -> list[str]:
+    return listicle
+
+
+def test_mul():
+    iterator = Arr(["val"])
+    result: list[str] = func(iterator)
+    assert result[0] == "val"
+
+
 def test_grouped_filter():
     iterator = Arr([1, 2, 3, 4])
 
@@ -189,7 +199,7 @@ def test_flatten_str(self):
 
     def test_flatten_includes_primitives(self):
         test_input: list[str | list[int] | None] = ["first", [2], None]
-        result: Arr[int | str | None] = Arr(test_input).flatten() # type: ignore # TODO: Would love to see a fix for this
+        result: Arr[int | str | None] = Arr(test_input).flatten()  # type: ignore # TODO: Would love to see a fix for this
         assert result.to_list() == ["first", 2, None]
 
     def test_flatten_removes_empty_iterators(self):

iterpy/test_iter.py

@@ -53,7 +53,7 @@ def test_reduce():
 
 def test_count():
     iterator = Iter([1, 2])
-    result: int = iterator.count()
+    result: int = iterator.len()
     assert result == 2
 
 
@@ -188,7 +188,7 @@ def test_flatten_str(self):
 
     def test_flatten_includes_primitives(self):
         test_input: list[str | list[int] | None] = ["first", [2], None]
-        result: Iter[int | str | None] = Iter(test_input).flatten() # type: ignore # TODO: Would love to see a fix for this
+        result: Iter[int | str | None] = Iter(test_input).flatten()  # type: ignore # TODO: Would love to see a fix for this
         assert result.to_list() == ["first", 2, None]
 
     def test_flatten_removes_empty_iterators(self):

pyrightconfig.json

@@ -1,8 +1,12 @@
 {
     "exclude": [
-        ".*venv*"
+        "**/node_modules",
+        "**/__pycache__",
+        "**/.*",
+        "build"
     ],
-    "pythonPlatform": "Darwin",
-    "reportMissingTypeStubs": false,
-    "typeCheckingMode": "strict"
+    "typeCheckingMode": "off",
+    "strict": [
+        "**/*.py"
+    ]
 }