datahold 4.0.0.dev26__tar.gz → 4.0.0.dev28__tar.gz

{datahold-4.0.0.dev26 → datahold-4.0.0.dev28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datahold
-Version: 4.0.0.dev26
+Version: 4.0.0.dev28
 Summary: This project wraps common mutable datastructures for inheritance with modification.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT

{datahold-4.0.0.dev26 → datahold-4.0.0.dev28}/pyproject.toml

@@ -31,7 +31,7 @@ license-files = [
 name = "datahold"
 readme = "README.rst"
 requires-python = ">=3.11"
-version = "4.0.0.dev26"
+version = "4.0.0.dev28"
 
 [project.urls]
 Download = "https://pypi.org/project/datahold/#files"

{datahold-4.0.0.dev26 → datahold-4.0.0.dev28}/src/datahold/__init__.py

@@ -9,6 +9,7 @@ __all__: list[str] = [
     "FrozenDictSlot",
     "FrozenListLike",
     "FrozenListSlot",
+    "FrozenObjectSlot",
     "FrozenSetLike",
     "FrozenSetSlot",
     "ListLike",
@@ -18,16 +19,20 @@ __all__: list[str] = [
     "MutableListLike",
     "MutableListSlot",
     "MutableMapping",
+    "MutableObject",
+    "MutableObjectLike",
     "MutableSequence",
     "MutableSet",
     "MutableSetLike",
     "MutableSetSlot",
+    "Object",
+    "ObjectSlot",
     "Sequence",
     "Set",
     "SetLike",
 ]
 
-from abc import abstractmethod
+from abc import ABCMeta, abstractmethod
 from collections import abc
 from contextlib import contextmanager
 from types import NotImplementedType, TracebackType
@@ -164,15 +169,82 @@ class MutableSequence_Mutable[Item](Protocol):
 
 ### TYPE ALIASES ###
 
+type Dict[Key, Value] = dict[Key | str, Optional[Value]]
 
 type DictInit[Key, Value] = (
     SupportsKeysAndGetitem[Key | str, Optional[Value]]
     | abc.Iterable[tuple[Key | str, Optional[Value]]]
 )
 
+type FrozenDict[Key, Value] = frozendict[Key | str, Optional[Value]]
+
 type Slice[Index] = slice[Optional[Index], Optional[Index], Optional[Index]]
 
 
+### OBJECT ###
+class Object[Frozen](metaclass=ABCMeta):
+    """Provide abc for custom object."""
+
+    __slots__ = ()
+
+    @abstractmethod
+    @setdoc.basic
+    def __frozen__(self: Self, /) -> Frozen: ...
+
+
+class MutableObject[Frozen, Mutable](Object[Frozen]):
+    """Provide abc for custom mutable object."""
+
+    __slots__ = ()
+
+    @abstractmethod
+    @setdoc.basic
+    def __mutate__(self: Self, /) -> ContextManager[Mutable]: ...
+
+
+### OBJECT-LIKE ###
+
+
+class MutableObjectLike[Frozen, Mutable](
+    MutableObject[Frozen, Mutable],
+):
+    """Provide abc for custom mutable object-like."""
+
+    __slots__ = ()
+
+    @abstractmethod
+    @setdoc.basic
+    def __init__(self: Self, other: Self, /) -> None: ...
+    @setdoc.basic
+    def copy(self: Self, /) -> Self:
+        return type(self)(self)
+
+
+### OBJECT-HOLD ###
+
+
+class ObjectSlot[Frozen](
+    Object[Frozen],
+):
+    """Provide slotted abc for custom object-like."""
+
+    __slots__ = ("_slot",)
+    _slot: Frozen
+
+
+class FrozenObjectSlot[Frozen](
+    ObjectSlot[Frozen],
+):
+    """Provide slotted abc for custom frozen object-like."""
+
+    __slots__ = ()
+    _slot: Frozen
+
+    @setdoc.basic
+    def __frozen__(self: Self, /) -> Frozen:
+        return self._slot
+
+
 ### COLLECTION ###
 
 
@@ -180,11 +252,10 @@ class Collection[Item](
     abc.Sized,
     abc.Iterable[Item],
     abc.Container[object],
+    Object[Collection_Frozen[Item]],
 ):
     """Provide abc for custom collection."""
 
-    type __Frozen__[Item_] = Collection_Frozen[Item_]
-
     @setdoc.basic
     def __contains__(self: Self, other: object, /) -> bool:
         try:
@@ -192,10 +263,6 @@ class Collection[Item](
         except TypeError:
             return other in (x for x in self)  # type: ignore[operator]
 
-    @abstractmethod
-    @setdoc.basic
-    def __frozen__(self: Self, /) -> Collection_Frozen[Item]: ...
-
     @setdoc.basic
     def __iter__(self: Self, /) -> abc.Iterator[Item]:
         return iter(self.__frozen__())
@@ -214,15 +281,15 @@ class Set[Item: abc.Hashable](Collection[Item], abc.Set[Item]):
     __slots__ = ()
 
 
-class MutableSet[Item: abc.Hashable](Set[Item], abc.MutableSet[Item]):
+class MutableSet[Item: abc.Hashable](
+    Set[Item],
+    abc.MutableSet[Item],
+    MutableObject[Collection_Frozen[Item], MutableSet_Mutable[Item]],
+):
     """Provide abc for custom mutable set."""
 
     __slots__ = ()
-    type __Mutable__[Item_] = MutableSet_Mutable[Item_]
 
-    @abstractmethod
-    @setdoc.basic
-    def __mutate__(self: Self) -> ContextManager[MutableSet_Mutable[Item]]: ...
     @setdoc.basic
     def add(self: Self, item: Item, /) -> None:
         with self.__mutate__() as mutable:
@@ -241,11 +308,10 @@ class SetLike[Item: abc.Hashable](Set[Item]):
     """Provide abc for custom set-like."""
 
     __slots__ = ()
-    type __Frozen__[Item_] = frozenset[Item_]
 
     @abstractmethod
     @setdoc.basic
-    def __frozen__(self: Self, /) -> __Frozen__[Item]: ...
+    def __frozen__(self: Self, /) -> frozenset[Item]: ...
     @abstractmethod
     @setdoc.basic
     def __init__(self: Self, data: abc.Iterable[Item] = (), /) -> None: ...
@@ -260,12 +326,12 @@ class SetLike[Item: abc.Hashable](Set[Item]):
         return type(self)(self.__frozen__().intersection(*others))
 
     @setdoc.basic
-    def issubset(self: Self, other: abc.Iterable[abc.Hashable], /) -> Self:
-        return type(self)(self.__frozen__().issubset(other))  # type: ignore
+    def issubset(self: Self, other: abc.Iterable[abc.Hashable], /) -> bool:
+        return self.__frozen__().issubset(other)
 
     @setdoc.basic
-    def issuperset(self: Self, other: abc.Iterable[abc.Hashable], /) -> Self:
-        return type(self)(self.__frozen__().issuperset(other))  # type: ignore
+    def issuperset(self: Self, other: abc.Iterable[abc.Hashable], /) -> bool:
+        return self.__frozen__().issuperset(other)
 
     @setdoc.basic
     def symmetric_difference(self: Self, other: abc.Iterable[Item], /) -> Self:
@@ -273,7 +339,7 @@ class SetLike[Item: abc.Hashable](Set[Item]):
 
     @setdoc.basic
     def union(self: Self, /, *others: abc.Iterable[Item]) -> Self:
-        return type(self)(self.__frozen__().union(others))  # type: ignore
+        return type(self)(self.__frozen__().union(*others))
 
 
 class FrozenSetLike[Item: abc.Hashable](SetLike[Item], abc.Hashable):
@@ -286,14 +352,17 @@ class FrozenSetLike[Item: abc.Hashable](SetLike[Item], abc.Hashable):
         return hash(self.__frozen__())
 
 
-class MutableSetLike[Item: abc.Hashable](SetLike[Item], MutableSet[Item]):
+class MutableSetLike[Item: abc.Hashable](
+    SetLike[Item],
+    MutableObjectLike[frozenset[Item], set[Item]],
+    MutableSet[Item],
+):
     """Provide abc for custom mutable set-like."""
 
     __slots__ = ()
-    type __Mutable__[Item_] = set[Item_]
 
     @setdoc.basic
-    def __frozen__(self: Self, /) -> MutableSetLike.__Frozen__[Item]:
+    def __frozen__(self: Self, /) -> frozenset[Item]:
         with self.__mutate__() as mutable:
             return frozenset(mutable)
 
@@ -302,9 +371,6 @@ class MutableSetLike[Item: abc.Hashable](SetLike[Item], MutableSet[Item]):
         with self.__mutate__() as mutable:
             mutable.update(data)
 
-    @abstractmethod
-    @setdoc.basic
-    def __mutate__(self: Self) -> ContextManager[__Mutable__[Item]]: ...
     @setdoc.basic
     def difference_update(
         self: Self, /, *others: abc.Iterable[abc.Hashable]
@@ -335,36 +401,34 @@ class MutableSetLike[Item: abc.Hashable](SetLike[Item], MutableSet[Item]):
 ### SET-SLOT ###
 
 
-class FrozenSetSlot[Item](FrozenSetLike[Item]):
+class FrozenSetSlot[Item](
+    FrozenObjectSlot[frozenset[Item]],
+    FrozenSetLike[Item],
+):
     """Provide slotted frozen set-like."""
 
-    __slots__ = ("_slot",)
-
-    _slot: FrozenSetSlot.__Frozen__[Item]
-
-    @setdoc.basic
-    def __frozen__(self: Self, /) -> FrozenSetSlot.__Frozen__[Item]:
-        return self._slot
+    __slots__ = ()
 
     @setdoc.basic
     def __init__(self: Self, data: abc.Iterable[Item] = (), /) -> None:
         self._slot = frozenset(data)
 
 
-class MutableSetSlot[Item](MutableSetLike[Item]):
+class MutableSetSlot[Item](
+    MutableSetLike[Item],
+    ObjectSlot[frozenset[Item]],
+):
     """Provide slotted mutable set-like."""
 
-    __slots__ = ("_slot",)
-
-    _slot: FrozenSetSlot.__Frozen__[Item]
+    __slots__ = ()
 
     @contextmanager
     @setdoc.basic
     def __mutate__(
         self: Self,
         /,
-    ) -> abc.Generator[MutableSetSlot.__Mutable__[Item], None, None]:
-        slot: MutableSetSlot.__Mutable__[Item]
+    ) -> abc.Generator[set[Item], None, None]:
+        slot: set[Item]
         slot = set(getattr(self, "_slot", ()))
         yield slot
         self._slot = frozenset(slot)
@@ -381,11 +445,9 @@ class Mapping[Key: abc.Hashable, Value](
 
     __slots__ = ()
 
-    type __Frozen__[Key_, Value_] = Mapping_Frozen[Key_, Value_]
-
     @abstractmethod
     @setdoc.basic
-    def __frozen__(self: Self, /) -> __Frozen__[Key, Value]: ...
+    def __frozen__(self: Self, /) -> Mapping_Frozen[Key, Value]: ...
     @setdoc.basic
     def __getitem__(self: Self, key: abc.Hashable, /) -> Value:
         return self.__frozen__()[key]
@@ -394,21 +456,17 @@ class Mapping[Key: abc.Hashable, Value](
 class MutableMapping[Key: abc.Hashable, Value](
     Mapping[Key, Value],
     abc.MutableMapping[Key | str, Optional[Value]],
+    MutableObject[FrozenDict[Key, Value], Dict[Key, Value]],
 ):
     """Provide abc for custom mutable mapping."""
 
     __slots__ = ()
 
-    type __Mutable__[Key_, Value_] = MutableMapping_Mutable[Key_, Value_]
-
     @setdoc.basic
     def __delitem__(self: Self, key: Key | str, /) -> None:
         with self.__mutate__() as mutable:
             del mutable[key]
 
-    @abstractmethod
-    @setdoc.basic
-    def __mutate__(self: Self) -> ContextManager[__Mutable__[Key, Value]]: ...
     @setdoc.basic
     def __setitem__(
         self: Self, key: Key | str, value: Optional[Value], /
@@ -426,11 +484,12 @@ class DictLike[Key: abc.Hashable, Value](
     """Provide abc for custom dict-like."""
 
     __slots__ = ()
-    type __Frozen__[Key_, Value_] = frozendict[Key_ | str, Optional[Value_]]
 
     @abstractmethod
     @setdoc.basic
-    def __frozen__(self: Self, /) -> __Frozen__[Key, Value]: ...  # type: ignore[override]
+    def __frozen__(self: Self, /) -> FrozenDict[Key, Value]:  # type: ignore[override]
+        ...
+
     @abstractmethod
     @setdoc.basic
     def __init__(
@@ -445,13 +504,13 @@ class DictLike[Key: abc.Hashable, Value](
         other: DictInit[Key_, Value_],
         /,
     ) -> DictLike[Key | Key_, Value | Value_]:
-        data: DictLike.__Frozen__[Key_, Value_]
+        data: FrozenDict[Key, Value]
         try:
             data = frozendict(other)  # type: ignore[arg-type]
         except TypeError:
             return NotImplemented
         return type(self)(  # type: ignore[return-value]
-            self.__frozen__() | data  # type: ignore[operator]
+            self.__frozen__() | data
         )
 
     @classmethod
@@ -480,20 +539,18 @@ class FrozenDictLike[Key: abc.Hashable, Value](
 
 class MutableDictLike[Key: abc.Hashable, Value](
     DictLike[Key, Value],
+    MutableObjectLike[FrozenDict[Key, Value], Dict[Key, Value]],
     MutableMapping[Key, Value],
 ):
     """Provide abc for custom mutable dict-like."""
 
     __slots__ = ()
-    type __Mutable__[Key_: abc.Hashable, Value_] = dict[
-        Key_ | str, Optional[Value_]
-    ]
 
     @setdoc.basic
     def __frozen__(  # type: ignore[override]
         self: Self,
         /,
-    ) -> MutableDictLike.__Frozen__[Key, Value]:
+    ) -> FrozenDict[Key, Value]:
         with self.__mutate__() as mutable:
             return frozendict(mutable)
 
@@ -516,32 +573,25 @@ class MutableDictLike[Key: abc.Hashable, Value](
             mutable |= other
         return self
 
-    @abstractmethod
-    @setdoc.basic
-    def __mutate__(
-        self: Self, /
-    ) -> ContextManager[__Mutable__[Key, Value]]: ...
     @setdoc.basic
-    def copy(self: Self, /) -> Self:
-        return type(self)(self)
+    def popitem(self: Self, /) -> tuple[Key | str, Optional[Value]]:
+        # for most dict d
+        # dict.popitem(d) and collections.abc.MutableMapping.popitem(d)
+        # behave differently
+        with self.__mutate__() as mutable:
+            return mutable.popitem()
 
 
 ### DICT-SLOT ###
 
 
-class FrozenDictSlot[Key: abc.Hashable, Value](
+class FrozenDictSlot[Key: abc.Hashable, Value](  # type: ignore[misc]
+    FrozenObjectSlot[FrozenDict[Key, Value]],
     FrozenDictLike[Key, Value],
 ):
     """Provide slotted frozen dict-like."""
 
-    __slots__ = ("_slot",)
-    _slot: FrozenDictSlot.__Frozen__[Key, Value]
-
-    @setdoc.basic
-    def __frozen__(  # type: ignore[override]
-        self: Self,
-    ) -> FrozenDictSlot.__Frozen__[Key, Value]:
-        return self._slot
+    __slots__ = ()
 
     @setdoc.basic
     def __init__(
@@ -555,19 +605,19 @@ class FrozenDictSlot[Key: abc.Hashable, Value](
 
 class MutableDictSlot[Key: abc.Hashable, Value](
     MutableDictLike[Key, Value],
+    ObjectSlot[FrozenDict[Key, Value]],
 ):
     """Provide slotted mutable dict-like."""
 
-    __slots__ = ("_slot",)
-    _slot: FrozenDictSlot.__Frozen__[Key, Value]
+    __slots__ = ()
 
     @contextmanager
     @setdoc.basic
     def __mutate__(
         self: Self,
         /,
-    ) -> abc.Generator[MutableDictSlot.__Mutable__[Key, Value], None, None]:
-        slot: MutableDictSlot.__Mutable__[Key, Value]
+    ) -> abc.Generator[Dict[Key, Value], None, None]:
+        slot: Dict[Key, Value]
         slot = dict(getattr(self, "_slot", ()))
         yield slot
         self._slot = frozendict(slot)
@@ -580,11 +630,10 @@ class Sequence[Item](Collection[Item], abc.Sequence[Item]):
     """Provide abc for customized sequence."""
 
     __slots__ = ()
-    type __Frozen__[Item_] = Sequence_Frozen[Item_]
 
     @abstractmethod
     @setdoc.basic
-    def __frozen__(self: Self, /) -> __Frozen__[Item]: ...
+    def __frozen__(self: Self, /) -> Sequence_Frozen[Item]: ...
     @overload
     @setdoc.basic
     def __getitem__(self: Self, key: int, /) -> Item: ...
@@ -598,11 +647,14 @@ class Sequence[Item](Collection[Item], abc.Sequence[Item]):
         return self.__frozen__()[key]
 
 
-class MutableSequence[Item](Sequence[Item], abc.MutableSequence[Item]):
+class MutableSequence[Item](
+    Sequence[Item],
+    abc.MutableSequence[Item],
+    MutableObject[Sequence_Frozen[Item], MutableSequence_Mutable[Item]],
+):
     """Provide abc for custom mutable sequence."""
 
     __slots__ = ()
-    type __Mutable__[Item_] = MutableSequence_Mutable[Item_]
 
     @overload
     @setdoc.basic
@@ -630,10 +682,6 @@ class MutableSequence[Item](Sequence[Item], abc.MutableSequence[Item]):
         with self.__mutate__() as mutable:
             return mutable[key]
 
-    @abstractmethod
-    @setdoc.basic
-    def __mutate__(self: Self, /) -> ContextManager[__Mutable__[Item]]: ...
-
     @overload
     @setdoc.basic
     def __setitem__(self: Self, key: int, value: Item, /) -> None: ...
@@ -664,9 +712,6 @@ class ListLike[Item](Sequence[Item]):
 
     __slots__ = ()
 
-    type __Frozen__[Item_] = tuple[Item_, ...]
-    # Frozen has to be tuple to allow covariance
-
     @setdoc.basic
     def __add__[Item_](
         self: Self, other: ListLike[Item_], /
@@ -685,7 +730,9 @@ class ListLike[Item](Sequence[Item]):
 
     @abstractmethod
     @setdoc.basic
-    def __frozen__(self: Self, /) -> __Frozen__[Item]: ...
+    def __frozen__(self: Self, /) -> tuple[Item, ...]:
+        # __frozen__ has to be tuple to allow covariance
+        ...
 
     @setdoc.basic
     def __ge__(self: Self, other: ListLike[Any], /) -> bool:
@@ -758,17 +805,19 @@ class FrozenListLike[Item](ListLike[Item], abc.Hashable):
     __slots__ = ()
 
     @setdoc.basic
-    def __hash__(self: Self) -> int:
+    def __hash__(self: Self, /) -> int:
         return hash(self.__frozen__())
 
 
-class MutableListLike[Item](ListLike[Item], MutableSequence[Item]):
+class MutableListLike[Item](
+    ListLike[Item],
+    MutableObjectLike[tuple[Item, ...], list[Item]],
+    MutableSequence[Item],
+):
     """Provide abc for custom mutable list-like."""
 
     __slots__ = ()
 
-    type __Mutable__[Item_] = list[Item_]
-
     @overload
     @setdoc.basic
     def __delitem__(self: Self, key: SupportsIndex, /) -> None: ...
@@ -783,7 +832,7 @@ class MutableListLike[Item](ListLike[Item], MutableSequence[Item]):
             del mutable[key]
 
     @setdoc.basic
-    def __frozen__(self: Self) -> MutableListLike.__Frozen__[Item]:
+    def __frozen__(self: Self) -> tuple[Item, ...]:
         with self.__mutate__() as mutable:
             return tuple(mutable)
 
@@ -798,10 +847,6 @@ class MutableListLike[Item](ListLike[Item], MutableSequence[Item]):
         with self.__mutate__() as mutable:
             mutable.extend(data)
 
-    @abstractmethod
-    @setdoc.basic
-    def __mutate__(self: Self, /) -> ContextManager[__Mutable__[Item]]: ...
-
     @overload
     @setdoc.basic
     def __setitem__(
@@ -822,10 +867,6 @@ class MutableListLike[Item](ListLike[Item], MutableSequence[Item]):
         with self.__mutate__() as mutable:
             mutable[key] = value  # type: ignore
 
-    @setdoc.basic
-    def copy(self: Self) -> Self:
-        return type(self)(self)
-
     @setdoc.basic
     def insert(self: Self, index: SupportsIndex, item: Item, /) -> None:
         with self.__mutate__() as mutable:
@@ -844,26 +885,26 @@ class MutableListLike[Item](ListLike[Item], MutableSequence[Item]):
 ### LIST-SLOT ###
 
 
-class FrozenListSlot[Item](FrozenListLike[Item]):
+class FrozenListSlot[Item](
+    FrozenObjectSlot[tuple[Item, ...]],
+    FrozenListLike[Item],
+):
     """Provide slotted frozen list-like."""
 
-    __slots__ = ("_slot",)
-    _slot: FrozenListSlot.__Frozen__[Item]
-
-    @setdoc.basic
-    def __frozen__(self: Self) -> FrozenListSlot.__Frozen__[Item]:
-        return self._slot
+    __slots__ = ()
 
     @setdoc.basic
     def __init__(self: Self, data: abc.Iterable[Item] = (), /) -> None:
         self._slot = tuple(data)
 
 
-class MutableListSlot[Item](MutableListLike[Item]):
+class MutableListSlot[Item](
+    MutableListLike[Item],
+    ObjectSlot[tuple[Item, ...]],
+):
     """Provide slotted mutable list-like."""
 
-    __slots__ = ("_slot",)
-    _slot: MutableListSlot.__Frozen__[Item]
+    __slots__ = ()
 
     @contextmanager
     @setdoc.basic

{datahold-4.0.0.dev26 → datahold-4.0.0.dev28}/src/datahold.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: datahold
-Version: 4.0.0.dev26
+Version: 4.0.0.dev28
 Summary: This project wraps common mutable datastructures for inheritance with modification.
 Author-email: Johannes <johannes.programming@gmail.com>
 License-Expression: MIT

{datahold-4.0.0.dev26 → datahold-4.0.0.dev28}/src/datahold.egg-info/SOURCES.txt

@@ -20,15 +20,17 @@ src/datahold.egg-info/dependency_links.txt
 src/datahold.egg-info/requires.txt
 src/datahold.egg-info/top_level.txt
 tests/test_FrozenListSlot.py
+tests/test_FrozenSetSlot.py
 tests/test_MutableDictSlot.py
 tests/test_MutableListSlot.py
+tests/test_MutableSetSlot.py
 tests/test_abstractmethods.py
 tests/test_all.py
 tests/test_attributes.py
 tests/test_docs.py
 tests/test_generic.py
-tests/test_internal_comparison.py
 tests/test_issubclass.py
+tests/test_metaclass.py
 tests/test_name.py
 tests/test_nested.py
 tests/test_sorted.py