pythonic-fp-gadgets 4.3.1__py3-none-any.whl → 4.5.0__py3-none-any.whl

pythonic_fp/gadgets/__init__.py

@@ -27,7 +27,6 @@ Gadgets
 """
 
 from collections.abc import Iterator
-from inspect import getmro
 
 __all__ = ['first_common_ancestor', 'iterate_over_arguments']
 
@@ -38,27 +37,33 @@ __license__ = 'Apache License 2.0'
 
 def first_common_ancestor(cls1: type, cls2: type) -> type:
     """
-    .. admonition:: Least upper bound
+    .. admonition:: First common ancestor
 
-        Find the least upper bound in the inheritance graph
-        of two classes.
+        Best effort to find the least upper bound in the inheritance
+        graph of two classes.
 
         :param cls1: A class in the inheritance hierarchy.
         :param cls2: A class in the inheritance hierarchy.
-        :returns: First common ancestor based on ``getmro`` order.
-        :raises TypeError: Raised when no common ancestor exists, or when
-                           not caught when raised by ``inspect.getmro``.
+        :returns: First common ancestor in ``cls1.__mro__`` order.
+        :raises TypeError: Defensively raised when no common ancestor
+                           is found.
 
-        .. warning::
+        .. note::
+
+            The function is not symmetric in its arguments. In genuine
+            multiple inheritance graphs, swapping ``cls1`` and ``cls2``
+            can yield a different ancestor. Also, a virtual ancestor
+            registered with an ABC may be a tighter bound than anything
+            in the actual MRO.
 
-            This function can fail with a TypeError. Some error messages
-            seen are
+        .. note::
 
-            - multiple bases have instance lay-out conflict
-            - type 'bool' is not an acceptable base type
+            Since ``object`` terminates all actual MRO's, ``TypeError``
+            is unlikely to ever be thrown, except in the case of some
+            exotic metaclass breaking this assumption. This exception
+            is here mainly to let typing tools know that object ``None``
+            is not a possible return type.
 
-            This happens frequently when the function is given
-            Python builtin types or in multiple inheritance situations.
 
     """
     if issubclass(cls1, cls2):
@@ -66,10 +71,10 @@ def first_common_ancestor(cls1: type, cls2: type) -> type:
     if issubclass(cls2, cls1):
         return cls1
 
-    for common_ancestor in getmro(type('LcaDiamondClass', (cls1, cls2), {})):
-        if issubclass(cls1, common_ancestor) and issubclass(cls2, common_ancestor):
-            return common_ancestor
-    raise TypeError("latest_common_ancestor: no common ancestor found!!!")
+    for ancestor in cls1.__mro__:
+        if issubclass(cls2, ancestor):
+            return ancestor
+    raise TypeError("first_common_ancestor: no common ancestor found!")
 
 
 def iterate_over_arguments[A](*args: A) -> Iterator[A]:

pythonic_fp/gadgets/box.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 
 from collections.abc import Callable, Iterator
-from typing import cast, Final, overload
+from typing import Final, cast, overload
 
 __all__ = ['Box']
 
@@ -105,9 +105,7 @@ class Box[T]:
 
         if self._item is other._item:
             return True
-        if self._item == other._item:
-            return True
-        return False
+        return self._item == other._item
 
     def __repr__(self) -> str:
         """
@@ -199,7 +197,6 @@ class Box[T]:
         else:
             msg = 'Box: Trying to push an item in a non-empty Box'
             raise ValueError(msg)
-        return None
 
     def put(self, item: T) -> None:
         """
@@ -228,7 +225,7 @@ class Box[T]:
         self._item = new_item
         return popped
 
-    def map[U](self, f: Callable[[T], U]) -> 'Box[U]':
+    def map[U](self, f: Callable[[T], U]) -> Box[U]:
         """
         .. admonition:: Map
 
@@ -243,7 +240,7 @@ class Box[T]:
             return Box()
         return Box(f(cast(T, self._item)))
 
-    def bind[U](self, f: Callable[[T], 'Box[U]']) -> 'Box[U]':
+    def bind[U](self, f: Callable[[T], Box[U]]) -> Box[U]:
         """
         .. admonition:: Bind
 

pythonic_fp/gadgets/wrap.py

@@ -12,12 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__all__ = ['Wrap', 'HWrap']
-
-from collections.abc import Callable, Iterator, Hashable
+from collections.abc import Callable, Hashable, Iterator
 
+__all__ = ['Wrap', 'HWrap']
 
-class Wrap[T]():
+class Wrap[T]:
     """
     .. admonition:: Wrap
 
@@ -115,7 +114,7 @@ class Wrap[T]():
         """
         return 'Wrap(' + str(self._item) + ')'
 
-    def map[U](self, f: Callable[[T], U]) -> 'Wrap[U]':
+    def map[U](self, f: Callable[[T], U]) -> Wrap[U]:
         """
         .. admonition:: map
 
@@ -127,7 +126,7 @@ class Wrap[T]():
         """
         return Wrap(f(self._item))
 
-    def bind[U](self, f: Callable[[T], 'Wrap[U]']) -> 'Wrap[U]':
+    def bind[U](self, f: Callable[[T], Wrap[U]]) -> Wrap[U]:
         """
         .. admonition:: bind
 
@@ -148,11 +147,11 @@ class HWrap[T: Hashable](Hashable):
 
         .. tip::
 
-            ``HWrap`` objects are hashable and matchable.
+            ``HWrap`` objects are matchable and hashable.
 
     """
 
-    __slots__ = ('_item', '_hash')
+    __slots__ = ('_hash', '_item')
     __match_args__ = ('_item',)
 
     def __init__(self, item: T) -> None:
@@ -164,7 +163,7 @@ class HWrap[T: Hashable](Hashable):
             :param item: Item to be wrapped.
 
         """
-        self._item, self._hash = item, hash(item)
+        self._item, self._hash = item, hash((item, '_hwrap'))
 
     def __hash__(self) -> int:
         return self._hash
@@ -244,7 +243,7 @@ class HWrap[T: Hashable](Hashable):
         """
         return 'Wrap(' + str(self._item) + ')'
 
-    def map[U](self, f: Callable[[T], U]) -> 'HWrap[U]':
+    def map[U](self, f: Callable[[T], U]) -> HWrap[U]:
         """
         .. admonition:: map
 
@@ -257,7 +256,7 @@ class HWrap[T: Hashable](Hashable):
         """
         return HWrap(f(self._item))
 
-    def bind[U](self, f: Callable[[T], 'HWrap[U]']) -> 'HWrap[U]':
+    def bind[U](self, f: Callable[[T], HWrap[U]]) -> HWrap[U]:
         """
         .. admonition:: bind
 

{pythonic_fp_gadgets-4.3.1.dist-info → pythonic_fp_gadgets-4.5.0.dist-info}/METADATA

@@ -1,8 +1,8 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-gadgets
-Version: 4.3.1
+Version: 4.5.0
 Summary: Gadgets without external Pythonic FP dependencies.
-Keywords: gadgets
+Keywords: gadgets,no-external-dependencies
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
@@ -31,18 +31,19 @@ Part of the
 [pythonic-fp](https://grscheller.github.io/pythonic-fp/)
 PyPI projects.
 
-## Documentation
+## Description
 
+Project Pythonic FP Gadgets contains
+
+- single item box
+- immutable wrapper classes, matchable, hashable and non-hashable versions
+- sentinel values
+- function returning iterator of its arguments
+- function to find the latest common ancestor of two classes
+ 
 Documentation and other links for this project are hosted on
 [GitHub Pages](https://grscheller.github.io/pythonic-fp/projects/gadgets.html).
 
-- Gadgets
-  - single item box
-  - immutable wrapped (hashable) references
-  - function returning iterator of its arguments
-  - function to find the latest common ancestor of two classes
-  - sentinel values
-
 ## Copyright and License
 
 Copyright (c) 2025-2026 Geoffrey R. Scheller. Licensed under the Apache

pythonic_fp_gadgets-4.5.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+pythonic_fp/gadgets/__init__.py,sha256=XcjEjYz5Wi8VcSJ3BEqCWDyZ_6w_Q1m1XyUpFngBRUk,2973
+pythonic_fp/gadgets/box.py,sha256=9BPmCp_pYjNr6si444p0C2n8Tfb1mtQn6IwAi_1oO54,7047
+pythonic_fp/gadgets/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/gadgets/wrap.py,sha256=QUN8ILCsqOqukDHBs9dZJmfwIkfp1E5jAQGLS9qwhi0,6462
+pythonic_fp/gadgets/sentinels/__init__.py,sha256=Xh63-GTwiqqcBqs5OEYBSiLXuWtq_CVHfUz0mKO_2H0,775
+pythonic_fp/gadgets/sentinels/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/gadgets/sentinels/flavored.py,sha256=LPmA-XOadcN5gJgxxo2prSnwRvq8bJ7o0Ae2_Y70Au0,2774
+pythonic_fp/gadgets/sentinels/flavored.pyi,sha256=K3YSyXLyylPII2ahRP0olhzLJruOeR73TFJDC6rCUwk,212
+pythonic_fp/gadgets/sentinels/novalue.py,sha256=gaQNm1TRtphbmWgDV8O0sblH7eU2M-Zymu_B67mwsJ8,6097
+pythonic_fp/gadgets/sentinels/novalue.pyi,sha256=1_iUI6FEwYma8P4XXVCb6CKhSYmfq53S8dLmiwNtJw4,244
+pythonic_fp_gadgets-4.5.0.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_gadgets-4.5.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_gadgets-4.5.0.dist-info/METADATA,sha256=vAT0Ldrr9Qyy2Uh4hkyidkSZ446UerMAOLBdnerSulo,1873
+pythonic_fp_gadgets-4.5.0.dist-info/RECORD,,

pythonic_fp/gadgets/__init__.pyi

@@ -1,6 +0,0 @@
-from collections.abc import Iterator
-
-__all__ = ['first_common_ancestor', 'iterate_over_arguments']
-
-def first_common_ancestor(cls1: type, cls2: type) -> type: ...
-def iterate_over_arguments[A](*args: A) -> Iterator[A]: ...

pythonic_fp/gadgets/box.pyi

@@ -1,27 +0,0 @@
-from _typeshed import Incomplete
-from collections.abc import Callable, Iterator
-from typing import overload
-
-__all__ = ['Box']
-
-type _Sentinel = object
-class Box[T]:
-    __match_args__: Incomplete
-    @overload
-    def __init__(self, item: T) -> None: ...
-    @overload
-    def __init__(self) -> None: ...
-    def __bool__(self) -> bool: ...
-    def __iter__(self) -> Iterator[T]: ...
-    def __len__(self) -> int: ...
-    def __eq__(self, other: object) -> bool: ...
-    @overload
-    def get(self) -> T: ...
-    @overload
-    def get(self, alt: T) -> T: ...
-    def pop(self) -> T: ...
-    def push(self, item: T) -> None: ...
-    def put(self, item: T) -> None: ...
-    def exchange(self, new_item: T) -> T: ...
-    def map[U](self, f: Callable[[T], U]) -> Box[U]: ...
-    def bind[U](self, f: Callable[[T], 'Box[U]']) -> Box[U]: ...

pythonic_fp/gadgets/wrap.pyi

@@ -1,23 +0,0 @@
-from _typeshed import Incomplete
-from collections.abc import Callable, Hashable, Iterator
-
-__all__ = ['Wrap', 'HWrap']
-
-class Wrap[T]:
-    __match_args__: Incomplete
-    def __init__(self, item: T) -> None: ...
-    def __bool__(self) -> bool: ...
-    def __iter__(self) -> Iterator[T]: ...
-    def __eq__(self, other: object) -> bool: ...
-    def map[U](self, f: Callable[[T], U]) -> Wrap[U]: ...
-    def bind[U](self, f: Callable[[T], 'Wrap[U]']) -> Wrap[U]: ...
-
-class HWrap[T: Hashable](Hashable):
-    __match_args__: Incomplete
-    def __init__(self, item: T) -> None: ...
-    def __hash__(self) -> int: ...
-    def __bool__(self) -> bool: ...
-    def __iter__(self) -> Iterator[T]: ...
-    def __eq__(self, other: object) -> bool: ...
-    def map[U](self, f: Callable[[T], U]) -> HWrap[U]: ...
-    def bind[U](self, f: Callable[[T], 'HWrap[U]']) -> HWrap[U]: ...

pythonic_fp_gadgets-4.3.1.dist-info/RECORD

@@ -1,17 +0,0 @@
-pythonic_fp/gadgets/__init__.py,sha256=zwRgxkaQYUbqjR-kX8pQeuPqipCB1bllVOEVBtGXl6I,2807
-pythonic_fp/gadgets/__init__.pyi,sha256=-O921ioE28UPnDm_EL928vl6dDxhrfXHBQenusBo1_o,224
-pythonic_fp/gadgets/box.py,sha256=gcW9mg-QCjc2lLTcOeqYJK0NAkHAbFs1JxhFjVTW1uQ,7115
-pythonic_fp/gadgets/box.pyi,sha256=UkJBY8Xiv4oe70Q3bhJL1jGHwYmFWwkTIdxvf2zR3v4,837
-pythonic_fp/gadgets/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/gadgets/wrap.py,sha256=Bdi-0rg7x37NWd0ciRi_IeDrsmlKQHJOMY9HcCnKt9M,6465
-pythonic_fp/gadgets/wrap.pyi,sha256=TRbBph_517VNCKchwU-pdtPCn73c09gq8EchDFM7Uyo,868
-pythonic_fp/gadgets/sentinels/__init__.py,sha256=Xh63-GTwiqqcBqs5OEYBSiLXuWtq_CVHfUz0mKO_2H0,775
-pythonic_fp/gadgets/sentinels/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/gadgets/sentinels/flavored.py,sha256=LPmA-XOadcN5gJgxxo2prSnwRvq8bJ7o0Ae2_Y70Au0,2774
-pythonic_fp/gadgets/sentinels/flavored.pyi,sha256=K3YSyXLyylPII2ahRP0olhzLJruOeR73TFJDC6rCUwk,212
-pythonic_fp/gadgets/sentinels/novalue.py,sha256=gaQNm1TRtphbmWgDV8O0sblH7eU2M-Zymu_B67mwsJ8,6097
-pythonic_fp/gadgets/sentinels/novalue.pyi,sha256=1_iUI6FEwYma8P4XXVCb6CKhSYmfq53S8dLmiwNtJw4,244
-pythonic_fp_gadgets-4.3.1.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
-pythonic_fp_gadgets-4.3.1.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_gadgets-4.3.1.dist-info/METADATA,sha256=IVjIF3Na-O4SOI3GOpr7jPtVShlsWa6Mlb-CMBupWgc,1798
-pythonic_fp_gadgets-4.3.1.dist-info/RECORD,,