pythonic-fp-gadgets 2.2.0__tar.gz → 3.0.0__tar.gz

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/CHANGELOG.rst

@@ -17,8 +17,22 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-Update - 2025-08-30
-~~~~~~~~~~~~~~~~~~~
+PyPI v3.0.0 - 2025-08-31
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Discovered I was not quite compliant with Python typing 3.12+ conventions.
+
+- No longer explicitly using TypeVar directly.
+- Removed Unions with Never from .py files
+
+  - only "happy path" return types (pythonic convention)
+  - stubgen actually puts them back in .pyi files
+
+- renamed it.it -> iterate_arguments.ita
+- renamed lca.latest_common_ancestor -> latest_common_ancestor.lca
+
+PyPI v2.2.0 - 2025-08-30
+~~~~~~~~~~~~~~~~~~~~~~~~
 
 Moved for pythonic_fp.gadgets package to a new GitHub repo, pythonic-fp-gadgets.
 Replaced it with the empty Python module ``pythonic_fp.name_claim``.
@@ -26,6 +40,9 @@ Replaced it with the empty Python module ``pythonic_fp.name_claim``.
 The gadgets package being different from the other namespace packages
 was throwing off my workflow.
 
+- added function it.it
+- added function lca.latest_common_ancestor
+
 Update - 2025-08-09
 ~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-gadgets
-Version: 2.2.0
-Summary: Simple Gadgets.
+Version: 3.0.0
+Summary: Simple Gadgets
 Keywords: gadgets
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
@@ -26,7 +26,7 @@ Pythonic FP - Gadgets
 =====================
 
 PyPI project
-`pythonic-fp
+`pythonic-fp-gadgets
 <https://pypi.org/project/pythonic-fp>`_.
 
 Library of simple, but useful, data structures with minimal dependencies.

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/README.rst

@@ -2,7 +2,7 @@ Pythonic FP - Gadgets
 =====================
 
 PyPI project
-`pythonic-fp
+`pythonic-fp-gadgets
 <https://pypi.org/project/pythonic-fp>`_.
 
 Library of simple, but useful, data structures with minimal dependencies.

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-gadgets"
-version = "2.2.0"
+version = "3.0.0"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }

pythonic_fp_gadgets-3.0.0/src/pythonic_fp/gadgets/__init__.py

@@ -0,0 +1,35 @@
+# Copyright 2023-2025 Geoffrey R. Scheller
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Simple Gadgets
+==============
+
+Library of simple, but useful, functions and classes with minimal dependencies.
+
++------------------------------+------------------+------------------------------------------------+
+| Description                  | Gadget           | Module                                         |
++==============================+==================+================================================+
+| Single item box              | class ``Box``    | ``pythonic_fp.gadgets.box``                    |
++------------------------------+------------------+------------------------------------------------+
+| Return Iterator of arguments | function ``ita`` | ``pythonic_fp.gadgets.iterate_arguments``      |
++------------------------------+------------------+------------------------------------------------+
+| Find least common base class | function ``lca`` | ``pythonic_fp.gadgets.latest_common_ancestor`` |
++------------------------------+------------------+------------------------------------------------+
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/src/pythonic_fp/gadgets/box.py

@@ -17,11 +17,9 @@
 __all__ = ['Box']
 
 from collections.abc import Callable, Iterator
-from typing import ClassVar, cast, Final, Never, overload, TypeVar
+from typing import ClassVar, cast, Final, overload
 from pythonic_fp.sentinels.flavored import Sentinel
 
-T = TypeVar('T')
-
 
 class Box[T]:
     """Container holding at most one item of a given type.
@@ -83,11 +81,11 @@ class Box[T]:
         return False
 
     @overload
-    def get(self) -> T | Never: ...
+    def get(self) -> T: ...
     @overload
     def get(self, alt: T) -> T: ...
 
-    def get(self, alt: T | Sentinel[str] = Sentinel('_Box')) -> T | Never:
+    def get(self, alt: T | Sentinel[str] = Sentinel('_Box')) -> T:
         """Return the contained item if it exists, otherwise an alternate item.
 
         :param alt: an "optional" item of type ``T`` to return if ``Box`` is empty
@@ -102,7 +100,7 @@ class Box[T]:
             raise ValueError(msg)
         return cast(T, alt)
 
-    def pop(self) -> T | Never:
+    def pop(self) -> T:
         """Pop the contained item if ``Box`` is not empty.
 
         :returns: item contained in the ``Box``
@@ -116,7 +114,7 @@ class Box[T]:
         self._item = self._sentinel
         return popped
 
-    def push(self, item: T) -> None | Never:
+    def push(self, item: T) -> None:
         """Push an item into an empty ``Box``.
 
         :param item: Item to push into the empty ``Box``.
@@ -134,7 +132,7 @@ class Box[T]:
         """Put an item in the Box. Discard any previous contents."""
         self._item = item
 
-    def exchange(self, new_item: T) -> T | Never:
+    def exchange(self, new_item: T) -> T:
         """Exchange an item with what is in the Box.
 
         :param ``new_item``: New item to exchange for current item.

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/src/pythonic_fp/gadgets/box.pyi

@@ -1,14 +1,11 @@
 from _typeshed import Incomplete
 from collections.abc import Callable, Iterator
-from typing import Never, TypeVar, overload
+from typing import overload
 
 __all__ = ['Box']
 
-T = TypeVar('T')
-
 class Box[T]:
     __match_args__: Incomplete
-    T = TypeVar('T')
     @overload
     def __init__(self) -> None: ...
     @overload
@@ -18,12 +15,12 @@ class Box[T]:
     def __len__(self) -> int: ...
     def __eq__(self, other: object) -> bool: ...
     @overload
-    def get(self) -> T | Never: ...
+    def get(self) -> T: ...
     @overload
     def get(self, alt: T) -> T: ...
-    def pop(self) -> T | Never: ...
-    def push(self, item: T) -> None | Never: ...
+    def pop(self) -> T: ...
+    def push(self, item: T) -> None: ...
     def put(self, item: T) -> None: ...
-    def exchange(self, new_item: T) -> T | Never: ...
+    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-2.2.0/src/pythonic_fp/gadgets/it.py → pythonic_fp_gadgets-3.0.0/src/pythonic_fp/gadgets/iterate_arguments.py

@@ -16,10 +16,10 @@
 
 from collections.abc import Iterator
 
-__all__ = ['it']
+__all__ = ['ita']
 
 
-def it[A](*args: A) -> Iterator[A]:
+def ita[A](*args: A) -> Iterator[A]:
     """Function returning an iterator of its arguments.
 
     .. note::

pythonic_fp_gadgets-3.0.0/src/pythonic_fp/gadgets/iterate_arguments.pyi

@@ -0,0 +1,5 @@
+from collections.abc import Iterator
+
+__all__ = ['ita']
+
+def ita[A](*args: A) -> Iterator[A]: ...

pythonic_fp_gadgets-2.2.0/src/pythonic_fp/gadgets/lca.py → pythonic_fp_gadgets-3.0.0/src/pythonic_fp/gadgets/latest_common_ancestor.py

@@ -12,15 +12,14 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-"""Lastest Common Ancestor of Two Classes."""
+"""Last Common Ancestor of Two Classes."""
 
 from inspect import getmro
-from typing import Never
 
-__all__ = ['latest_common_ancestor']
+__all__ = ['lca']
 
 
-def latest_common_ancestor(cls1: type, cls2: type) -> type | Never:
+def lca(cls1: type, cls2: type) -> type:
     """Find the least upper bound in the inheritance graph
     of two classes.
 

pythonic_fp_gadgets-3.0.0/src/pythonic_fp/gadgets/latest_common_ancestor.pyi

@@ -0,0 +1,3 @@
+__all__ = ['lca']
+
+def lca(cls1: type, cls2: type) -> type: ...

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/tests/test_box.py

@@ -20,11 +20,12 @@ class TestGadgetBox:
 
     def test_box_unchanged(self) -> None:
         box_init_empty: Box[int] = Box()
-        box_init_full = Box(42)
+        box_init_full: Box[int] = Box(42)
 
         if box_init_empty or not box_init_full:
             assert False
 
+        ii: int
         for ii in box_init_empty:
             assert False
 

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/tests/test_it.py

@@ -13,22 +13,22 @@
 # limitations under the License.
 
 from pythonic_fp.circulararray.auto import ca, CA
-from pythonic_fp.gadgets.it import it
+from pythonic_fp.gadgets.iterate_arguments import ita
 
 class TestGadgetIt:
     """Functionality testing"""
 
-    def test_it(self) -> None:
+    def test_ita(self) -> None:
         ref0: list[int] = []
-        trg0: list[int] = list(it())
+        trg0: list[int] = list(ita())
         assert ref0 == trg0
 
         ref1 = [1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2046, 4092]
-        trg1 = list(it(1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2046, 4092))
+        trg1 = list(ita(1, 2, 4, 8, 16, 32, 64, 128, 256, 512, 1024, 2046, 4092))
         assert ref1 == trg1
 
         ref2 = [1, 2, 3]
-        trg2 = [*it(1,2,3)]
+        trg2 = [*ita(1,2,3)]
         assert ref2 == trg2
 
         ca_iter = CA((1, 2))
@@ -36,11 +36,11 @@ class TestGadgetIt:
         assert ca_iter == ca_args
 
         ca0_ref: CA[int] = ca()
-        ca0_trg: CA[int] = CA[int](it())
+        ca0_trg: CA[int] = CA[int](ita())
         assert ca0_ref == ca0_trg
 
         ca1_ref: CA[int] = CA((42, 7, 11, 100))
-        ca1_trg = CA(it(42, 7, 11, 100))
-        ca1_splat1 = ca(*it(42, 7, 11, 100))
-        ca1_splat2 = ca(*it(42, 7), *it(11, 100))
+        ca1_trg = CA(ita(42, 7, 11, 100))
+        ca1_splat1 = ca(*ita(42, 7, 11, 100))
+        ca1_splat2 = ca(*ita(42, 7), *ita(11, 100))
         assert ca1_ref == ca1_trg == ca1_splat1 == ca1_splat2

{pythonic_fp_gadgets-2.2.0 → pythonic_fp_gadgets-3.0.0}/tests/test_lca.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from pythonic_fp.gadgets.lca import latest_common_ancestor as lca
+from pythonic_fp.gadgets.latest_common_ancestor import lca
 
 class A1():
     pass

pythonic_fp_gadgets-2.2.0/src/pythonic_fp/gadgets/__init__.py

@@ -1,33 +0,0 @@
-# Copyright 2023-2025 Geoffrey R. Scheller
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-"""Simple Gadgets.
-
-Library of simple, but useful, functions and classes with minimal dependencies.
-
-+-------------------------------------+-----------------------------------+------------------------------+
-| Gadget                              | Description                       | Module                       |
-+=====================================+===================================+==============================+
-| class ``Box``                       | Single item box                   | ``pythonic_fp.gadgets.box``  |
-+-------------------------------------+-----------------------------------+------------------------------+
-| function ``it``                     | Returns iterator of its arguments | ``pythonic_fp.gadgets.it``   |
-+-------------------------------------+-----------------------------------+------------------------------+
-| function ``latest_common_ancestor`` | Find least common base class      | ``pythonic_fp.gadgets.lca``  |
-+-------------------------------------+-----------------------------------+------------------------------+
-
-"""
-
-__author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
-__license__ = 'Apache License 2.0'

pythonic_fp_gadgets-2.2.0/src/pythonic_fp/gadgets/it.pyi

@@ -1,5 +0,0 @@
-from collections.abc import Iterator
-
-__all__ = ['it']
-
-def it[A](*args: A) -> Iterator[A]: ...

pythonic_fp_gadgets-2.2.0/src/pythonic_fp/gadgets/lca.pyi

@@ -1,5 +0,0 @@
-from typing import Never
-
-__all__ = ['latest_common_ancestor']
-
-def latest_common_ancestor(cls1: type, cls2: type) -> type | Never: ...