multicollections 0.2.1__tar.gz → 0.3.0__tar.gz

{multicollections-0.2.1 → multicollections-0.3.0}/.github/workflows/ci.yml

@@ -33,9 +33,9 @@ jobs:
       uses: actions/setup-python@v5
       with:
         python-version-file: pyproject.toml
-    - name: Check types with ty
+    - name: Check types with mypy
       run: |
-        uv run ty check
+        uv run mypy
 
   test:
     runs-on: ubuntu-22.04

{multicollections-0.2.1 → multicollections-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: multicollections
-Version: 0.2.1
+Version: 0.3.0
 Summary: Fully generic MultiDict class
 Project-URL: Homepage, https://github.com/gerlero/multicollections
 Project-URL: Repository, https://github.com/gerlero/multicollections
@@ -36,8 +36,8 @@ A fully generic [`MultiDict`](https://multicollections.readthedocs.io/en/latest/
 [![Documentation](https://img.shields.io/readthedocs/multicollections)](https://multicollections.readthedocs.io/)
 [![CI](https://github.com/gerlero/multicollections/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/multicollections/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/gh/gerlero/multicollections/branch/main/graph/badge.svg)](https://codecov.io/gh/gerlero/multicollections)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Publish](https://github.com/gerlero/multicollections/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/gerlero/multicollections/actions/workflows/pypi-publish.yml)
 [![PyPI](https://img.shields.io/pypi/v/multicollections)](https://pypi.org/project/multicollections/)

{multicollections-0.2.1 → multicollections-0.3.0}/README.md

@@ -5,8 +5,8 @@ A fully generic [`MultiDict`](https://multicollections.readthedocs.io/en/latest/
 [![Documentation](https://img.shields.io/readthedocs/multicollections)](https://multicollections.readthedocs.io/)
 [![CI](https://github.com/gerlero/multicollections/actions/workflows/ci.yml/badge.svg)](https://github.com/gerlero/multicollections/actions/workflows/ci.yml)
 [![Codecov](https://codecov.io/gh/gerlero/multicollections/branch/main/graph/badge.svg)](https://codecov.io/gh/gerlero/multicollections)
+[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
-[![ty](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json)](https://github.com/astral-sh/ty)
 [![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
 [![Publish](https://github.com/gerlero/multicollections/actions/workflows/pypi-publish.yml/badge.svg)](https://github.com/gerlero/multicollections/actions/workflows/pypi-publish.yml)
 [![PyPI](https://img.shields.io/pypi/v/multicollections)](https://pypi.org/project/multicollections/)

{multicollections-0.2.1 → multicollections-0.3.0}/multicollections/__init__.py

@@ -45,10 +45,10 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         if isinstance(iterable, Mapping):
             self._items.extend((key, value) for key, value in iterable.items())
         else:
-            self._items.extend((key, value) for key, value in iterable)
+            self._items.extend((key, value) for key, value in iterable)  # type: ignore[misc]
 
         # Add kwargs items
-        self._items.extend((key, value) for key, value in kwargs.items())
+        self._items.extend((key, value) for key, value in kwargs.items())  # type: ignore[misc]
 
         # Build indices in one pass for better performance
         if self._items:
@@ -84,7 +84,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
             if len(indices) > 1:
                 # Remove duplicates efficiently by marking items as None and filtering
                 for idx in indices[1:]:
-                    self._items[idx] = None
+                    self._items[idx] = None  # type: ignore[call-overload]
 
                 # Filter out None items and rebuild indices
                 self._items = [item for item in self._items if item is not None]
@@ -122,7 +122,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         value = self._items[first_index][1]
 
         # Mark the first item for removal
-        self._items[first_index] = None
+        self._items[first_index] = None  # type: ignore[call-overload]
 
         # Filter out None items and rebuild indices
         self._items = [item for item in self._items if item is not None]
@@ -142,7 +142,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         # Mark items for removal
         indices_to_remove = self._key_indices[key]
         for idx in indices_to_remove:
-            self._items[idx] = None
+            self._items[idx] = None  # type: ignore[call-overload]
 
         # Filter out None items and rebuild indices
         self._items = [item for item in self._items if item is not None]
@@ -173,7 +173,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         existing_keys: set[_K],
     ) -> tuple[dict[_K, list[_V]], list[tuple[_K, _V]]]:
         """Separate items into updates and additions."""
-        updates_by_key = {}  # key -> list of values to replace with
+        updates_by_key: dict[_K, list[_V]] = {}  # key -> list of values to replace with
         additions = []  # list of (key, value) for new keys
 
         for key, value in all_items:
@@ -195,7 +195,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
 
         # Mark items for removal
         for idx in items_to_remove:
-            self._items[idx] = None
+            self._items[idx] = None  # type: ignore[call-overload]
 
         # Filter out None items
         self._items = [item for item in self._items if item is not None]
@@ -206,7 +206,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
                 self._items.append((key, value))
 
     @override
-    def update(
+    def update(  # type: ignore[override]
         self,
         other: Mapping[_K, _V] | Iterable[Sequence[_K | _V]] = (),
         **kwargs: _V,
@@ -218,7 +218,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         """
         # Collect all items first
         items = other.items() if isinstance(other, Mapping) else other
-        items = itertools.chain(items, kwargs.items())
+        items = itertools.chain(items, kwargs.items())  # type: ignore[arg-type]
         all_items = list(items)
 
         if not all_items:
@@ -228,7 +228,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         existing_keys = set(self._key_indices.keys())
 
         # Separate items into updates and additions
-        updates_by_key, additions = self._collect_update_items(all_items, existing_keys)
+        updates_by_key, additions = self._collect_update_items(all_items, existing_keys)  # type: ignore[arg-type]
 
         # Process updates efficiently
         if updates_by_key:
@@ -258,7 +258,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
 
         # Collect all items and filter out existing keys
         items = other.items() if isinstance(other, Mapping) else other
-        items = itertools.chain(items, kwargs.items())
+        items = itertools.chain(items, kwargs.items())  # type: ignore[arg-type]
         new_items = [(key, value) for key, value in items if key not in existing_keys]
 
         if not new_items:
@@ -266,13 +266,13 @@ class MultiDict(MutableMultiMapping[_K, _V]):
 
         # Add all items to the list at once
         start_index = len(self._items)
-        self._items.extend(new_items)
+        self._items.extend(new_items)  # type: ignore[arg-type]
 
         # Update indices incrementally for better performance
         for i, (key, _) in enumerate(new_items, start_index):
             if key not in self._key_indices:
-                self._key_indices[key] = []
-            self._key_indices[key].append(i)
+                self._key_indices[key] = []  # type: ignore[index]
+            self._key_indices[key].append(i)  # type: ignore[index]
 
     @override
     def extend(
@@ -287,7 +287,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         """
         # Collect all new items first
         items = other.items() if isinstance(other, Mapping) else other
-        items = itertools.chain(items, kwargs.items())
+        items = itertools.chain(items, kwargs.items())  # type: ignore[arg-type]
         new_items = list(items)
 
         if not new_items:
@@ -295,13 +295,13 @@ class MultiDict(MutableMultiMapping[_K, _V]):
 
         # Add all items to the list at once
         start_index = len(self._items)
-        self._items.extend(new_items)
+        self._items.extend(new_items)  # type: ignore[arg-type]
 
         # Update indices incrementally for better performance
         for i, (key, _) in enumerate(new_items, start_index):
             if key not in self._key_indices:
-                self._key_indices[key] = []
-            self._key_indices[key].append(i)
+                self._key_indices[key] = []  # type: ignore[index]
+            self._key_indices[key].append(i)  # type: ignore[index]
 
     def copy(self) -> MultiDict[_K, _V]:
         """Return a shallow copy of the MultiDict."""
@@ -310,6 +310,7 @@ class MultiDict(MutableMultiMapping[_K, _V]):
         new_md._key_indices = {k: v.copy() for k, v in self._key_indices.items()}  # noqa: SLF001
         return new_md
 
+    @override
     def __repr__(self) -> str:
         """Return a string representation of the MultiDict."""
         return f"{self.__class__.__name__}({list(self._items)!r})"

{multicollections-0.2.1 → multicollections-0.3.0}/multicollections/_util.py

@@ -14,3 +14,6 @@ else:
         def override(func: Callable) -> Callable:
             """Fallback override decorator that does nothing."""
             return func
+
+
+__all__ = ["override"]

{multicollections-0.2.1 → multicollections-0.3.0}/multicollections/abc.py

@@ -8,7 +8,7 @@ import itertools
 import sys
 from abc import abstractmethod
 from collections import defaultdict
-from typing import TYPE_CHECKING, Generic, TypeVar, overload
+from typing import TYPE_CHECKING, Generic, Tuple, TypeVar, overload
 
 if sys.version_info >= (3, 9):
     from collections.abc import (
@@ -17,9 +17,9 @@ if sys.version_info >= (3, 9):
         Iterable,
         Iterator,
         Mapping,
-        MappingView,
         MutableMapping,
         Sequence,
+        Sized,
     )
 else:
     from typing import (
@@ -28,14 +28,15 @@ else:
         Iterable,
         Iterator,
         Mapping,
-        MappingView,
         MutableMapping,
         Sequence,
+        Sized,
     )
 
-if TYPE_CHECKING:  # pragma: no cover
+if TYPE_CHECKING:
     from typing import Protocol
 
+
 from ._util import override
 
 _K = TypeVar("_K")
@@ -44,21 +45,25 @@ _D = TypeVar("_D")
 _Self = TypeVar("_Self")
 
 
-class MultiMappingView(MappingView, Collection):
+class MultiMappingView(Generic[_K, _V], Sized):
     """Base class for MultiMapping views."""
 
-    @override
     def __init__(self, mapping: MultiMapping[_K, _V]) -> None:
         """Initialize the view with the given mapping."""
-        super().__init__(mapping)
+        self._mapping = mapping
+
+    @override
+    def __len__(self) -> int:
+        """Return the number of elements in the multi-mapping."""
+        return len(self._mapping)
 
 
-class KeysView(MultiMappingView):
+class KeysView(MultiMappingView[_K, _V], Collection[_K]):
     """View for the keys in a MultiMapping."""
 
     @override
     def __contains__(self, key: object) -> bool:
-        """Check if the key is in the mapping."""
+        """Check if the key is in the multi-mapping."""
         return key in self._mapping
 
     @override
@@ -67,18 +72,18 @@ class KeysView(MultiMappingView):
         return iter(self._mapping)
 
 
-class ItemsView(MultiMappingView):
+class ItemsView(MultiMappingView[_K, _V], Collection[Tuple[_K, _V]]):
     """View for the items (key-value pairs) in a MultiMapping."""
 
     @override
     def __contains__(self, item: object) -> bool:
-        """Check if the item is in the mapping."""
+        """Check if the item is in the multi-mapping."""
         try:
-            key, value = item  # ty: ignore[not-iterable]
+            key, value = item  # type: ignore[misc]
         except TypeError:
             return False
         try:
-            return value in self._mapping.getall(key)
+            return value in self._mapping.getall(key)  # type: ignore[has-type]
         except KeyError:
             return False
 
@@ -87,17 +92,22 @@ class ItemsView(MultiMappingView):
         """Return an iterator over the items (key-value pairs)."""
         counts: defaultdict[_K, int] = defaultdict(int)
         for k in self._mapping:
-            yield (k, self._mapping.getall(k)[counts[k]])
+            yield (
+                k,
+                next(
+                    itertools.islice(self._mapping.getall(k), counts[k], counts[k] + 1)
+                ),
+            )
             counts[k] += 1
 
 
-class ValuesView(MultiMappingView):
+class ValuesView(MultiMappingView[_K, _V], Collection[_V]):
     """View for the values in a MultiMapping."""
 
     @override
     def __contains__(self, value: object) -> bool:
         """Check if the value is in the mapping."""
-        return value in iter(self)
+        return any(v == value for v in self)
 
     @override
     def __iter__(self) -> Iterator[_V]:
@@ -112,27 +122,30 @@ class _NoDefault:
 _NO_DEFAULT = _NoDefault()
 
 if TYPE_CHECKING:  # pragma: no cover
+    _Self_co = TypeVar("_Self_co", covariant=True)
+    _K_contra = TypeVar("_K_contra", contravariant=True)
+    _V_co = TypeVar("_V_co", covariant=True)
 
-    class _CallableWithDefault(Protocol[_Self, _K, _V, _D]):
+    class _CallableWithDefault(Protocol[_Self_co, _K_contra, _V_co]):
         @overload
-        def __call__(self: _Self, key: _K) -> _V: ...
+        def __call__(self: _Self_co, key: _K_contra) -> _V_co: ...
 
         @overload
-        def __call__(self: _Self, key: _K, default: _D) -> _V | _D: ...
+        def __call__(self: _Self_co, key: _K_contra, default: _D) -> _V_co | _D: ...
 
 
 def with_default(
     meth: Callable[[_Self, _K], _V],
-) -> _CallableWithDefault[_Self, _K, _V, _D]:
+) -> _CallableWithDefault[_Self, _K, _V]:
     """Add a default value argument to a method that can raise a `KeyError`."""
 
     @overload
-    def wrapper(self: _Self, key: _K) -> _V: ...  # pragma: no cover
+    def wrapper(self: _Self, key: _K) -> _V: ...
 
     @overload
-    def wrapper(self: _Self, key: _K, default: _D) -> _V | _D: ...  # pragma: no cover
+    def wrapper(self: _Self, key: _K, default: _D) -> _V | _D: ...
 
-    @functools.wraps(meth)
+    @functools.wraps(meth)  # type: ignore[misc]
     def wrapper(
         self: _Self, key: _K, default: _D | _NoDefault = _NO_DEFAULT
     ) -> _V | _D:
@@ -141,12 +154,12 @@ def with_default(
         except KeyError:
             if default is _NO_DEFAULT:
                 raise
-            return default  # ty: ignore [invalid-return-type]
+            return default  # type: ignore[return-value]
 
-    return wrapper
+    return wrapper  # type: ignore[return-value]
 
 
-class MultiMapping(Mapping[_K, _V], Generic[_K, _V]):
+class MultiMapping(Mapping[_K, _V]):
     """Abstract base class for multi-mapping collections.
 
     A multi-mapping is a mapping that can hold multiple values for the same key.
@@ -155,7 +168,7 @@ class MultiMapping(Mapping[_K, _V], Generic[_K, _V]):
 
     @abstractmethod
     @with_default
-    def getall(self, key: _K) -> list[_V]:
+    def getall(self, key: _K) -> Collection[_V]:
         """Get all values for a key.
 
         Raises a `KeyError` if the key is not found and no default is provided.
@@ -163,6 +176,7 @@ class MultiMapping(Mapping[_K, _V], Generic[_K, _V]):
         raise NotImplementedError  # pragma: no cover
 
     @abstractmethod
+    @override
     def __iter__(self) -> Iterator[_K]:
         """Return an iterator over the keys.
 
@@ -171,6 +185,7 @@ class MultiMapping(Mapping[_K, _V], Generic[_K, _V]):
         raise NotImplementedError  # pragma: no cover
 
     @abstractmethod
+    @override
     def __len__(self) -> int:
         """Return the total number of items (key-value pairs)."""
         raise NotImplementedError  # pragma: no cover
@@ -181,7 +196,11 @@ class MultiMapping(Mapping[_K, _V], Generic[_K, _V]):
 
         Raises a `KeyError` if the key is not found and no default is provided.
         """
-        return self.getall(key)[0]
+        try:
+            return next(iter(self.getall(key)))
+        except StopIteration as e:  # pragma: no cover
+            msg = "MultiMapping.getall returned an empty collection"
+            raise RuntimeError(msg) from e
 
     @override
     def __getitem__(self, key: _K) -> _V:
@@ -192,17 +211,17 @@ class MultiMapping(Mapping[_K, _V], Generic[_K, _V]):
         return self.getone(key)
 
     @override
-    def keys(self) -> KeysView[_K]:
+    def keys(self) -> KeysView[_K, _V]:  # type: ignore[override]
         """Return a view of the keys in the MultiMapping."""
         return KeysView(self)
 
     @override
-    def items(self) -> ItemsView[_K, _V]:
+    def items(self) -> ItemsView[_K, _V]:  # type: ignore[override]
         """Return a view of the items (key-value pairs) in the MultiMapping."""
         return ItemsView(self)
 
     @override
-    def values(self) -> ValuesView[_V]:
+    def values(self) -> ValuesView[_K, _V]:  # type: ignore[override]
         """Return a view of the values in the MultiMapping."""
         return ValuesView(self)
 
@@ -214,6 +233,7 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
     """
 
     @abstractmethod
+    @override
     def __setitem__(self, key: _K, value: _V) -> None:
         """Set the value for a key.
 
@@ -239,8 +259,8 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
         raise NotImplementedError  # pragma: no cover
 
     @with_default
-    def popall(self, key: _K) -> list[_V]:
-        """Remove and return all values for a key as a list.
+    def popall(self, key: _K) -> Collection[_V]:
+        """Remove and return all values for a key.
 
         Raises a `KeyError` if the key is not found and no default is provided.
         """
@@ -251,10 +271,12 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
         return ret
 
     @with_default
+    @override
     def pop(self, key: _K) -> _V:
         """Same as `popone`."""
         return self.popone(key)
 
+    @override
     def popitem(self) -> tuple[_K, _V]:
         """Remove and return a (key, value) pair."""
         key = next(iter(self))
@@ -275,7 +297,6 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
         for key in set(self.keys()):
             self.popall(key)
 
-    @override
     def extend(
         self,
         other: Mapping[_K, _V] | Iterable[Sequence[_K | _V]] = (),
@@ -283,11 +304,10 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
     ) -> None:
         """Extend the multi-mapping with items from another object."""
         items = other.items() if isinstance(other, Mapping) else other
-        items = itertools.chain(items, kwargs.items())
+        items = itertools.chain(items, kwargs.items())  # type: ignore[arg-type]
         for key, value in items:
-            self.add(key, value)
+            self.add(key, value)  # type: ignore[arg-type]
 
-    @override
     def merge(
         self,
         other: Mapping[_K, _V] | Iterable[Sequence[_K | _V]] = (),
@@ -299,13 +319,13 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
         """
         existing_keys = set(self.keys())
         items = other.items() if isinstance(other, Mapping) else other
-        items = itertools.chain(items, kwargs.items())
+        items = itertools.chain(items, kwargs.items())  # type: ignore[arg-type]
         for key, value in items:
             if key not in existing_keys:
-                self.add(key, value)
+                self.add(key, value)  # type: ignore[arg-type]
 
     @override
-    def update(
+    def update(  # type: ignore[override]
         self,
         other: Mapping[_K, _V] | Iterable[Sequence[_K | _V]] = (),
         **kwargs: _V,
@@ -316,10 +336,10 @@ class MutableMultiMapping(MultiMapping[_K, _V], MutableMapping[_K, _V]):
         """
         existing_keys = set(self.keys())
         items = other.items() if isinstance(other, Mapping) else other
-        items = itertools.chain(items, kwargs.items())
+        items = itertools.chain(items, kwargs.items())  # type: ignore[arg-type]
         for key, value in items:
             if key in existing_keys:
-                self[key] = value
-                existing_keys.remove(key)
+                self[key] = value  # type: ignore[index, assignment]
+                existing_keys.remove(key)  # type: ignore[arg-type]
             else:
-                self.add(key, value)
+                self.add(key, value)  # type: ignore[arg-type]

{multicollections-0.2.1 → multicollections-0.3.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "multicollections"
-version = "0.2.1"
+version = "0.3.0"
 authors = [
     { name = "Gabriel S. Gerlero", email = "ggerlero@cimec.unl.edu.ar" },
 ]
@@ -32,7 +32,7 @@ requires-python = ">=3.7"
 [dependency-groups]
 lint = ["ruff"]
 typing = [
-    "ty; python_version>='3.8'",
+    "mypy>=1.4.1,<2",
     "typing_extensions >= 4.4.0; python_version<'3.12'"
 ]
 test = [
@@ -61,8 +61,13 @@ Homepage = "https://github.com/gerlero/multicollections"
 Repository = "https://github.com/gerlero/multicollections"
 Documentation = "https://multicollections.readthedocs.io"
 
-[tool.uv.build-backend]
-module-root = "."
+[tool.mypy]
+packages = [
+    "multicollections",
+    "tests",
+]
+strict = true
+enable_error_code = "explicit-override"
 
 [tool.ruff.lint]
 extend-select = ["ALL"]

{multicollections-0.2.1 → multicollections-0.3.0}/tests/minimalimpl.py

@@ -35,9 +35,9 @@ class ListMultiDict(MutableMultiMapping[_K, _V]):
                 self._items.append((key, value))
         else:
             for key, value in iterable:
-                self._items.append((key, value))
+                self._items.append((key, value))  # type: ignore[arg-type]
         for key, value in kwargs.items():
-            self._items.append((key, value))
+            self._items.append((key, value))  # type: ignore[arg-type]
 
     @override
     @with_default