pythonic-fp-gadgets 4.0.2__tar.gz

pythonic_fp_gadgets-4.0.2/.gitignore

@@ -0,0 +1,7 @@
+# Minimal version - only add to when necessary
+**/__pycache__/
+dist/
+**/.dmypy.json
+**/.mypy_cache/
+**/.pytest_cache/
+**/.ruff_cache

pythonic_fp_gadgets-4.0.2/CHANGELOG.rst

@@ -0,0 +1,90 @@
+CHANGELOG
+=========
+
+PyPI pythonic-fp-gadgets project.
+
+Semantic Versioning
+-------------------
+
+Strict 3 digit semantic versioning
+
+- **MAJOR** version incremented for incompatible API changes
+- **MINOR** version incremented for backward compatible added functionality
+- **PATCH** version incremented for backward compatible bug fixes
+
+See `Semantic Versioning 2.0.0 <https://semver.org>`_.
+
+Releases and Important Milestones
+---------------------------------
+
+PyPI 4.0.2 - 2026-01-TBD
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Docstring improvements based on lessons learned from my PyPI
+boring-math-abstract-algebra project.
+
+PyPI v4.0.1 - 2025-12-02
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Move functions out of their own packages to __init__.py (2025-10-13).
+
+- latest_common_ancestor.lca -> first_common_ancestor
+- iterate_arguments.ita -> iterate_over_arguments
+
+Unfortunately I forgot to push these changes to PyPI for a
+month and a half!
+
+PyPI v3.0.1 - 2025-09-09
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Corrected incorrect dependencies.
+
+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
+
+    - the "happy path" returns just 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 in pythonic-fp.
+
+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
+~~~~~~~~~~~~~~~~~~~
+
+Preparing for upcoming PyPI release for gadgets.
+
+- decided to make gadget's pyproject.toml the exemplar for rest of pythonic-fp namespace
+- pythonic_fp.gadget works with previous and next release of singletons
+
+PyPI v1.1.0 - 2025-08-02
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Released pythonic-fp v1.1.0 which contains pythonic_fp.gadgets package.
+
+Update - 2025-08-01
+~~~~~~~~~~~~~~~~~~~
+
+Added package pythonic_fp.gadgets to the "name-claim" PyPI
+project pythonic-fp. The gadgets library is for simple,
+but useful, functions and data structures with minimal
+dependencies.

pythonic_fp_gadgets-4.0.2/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

pythonic_fp_gadgets-4.0.2/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-gadgets
+Version: 4.0.2
+Summary: Gadgets
+Keywords: gadgets
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: pytest>=8.4.1 ; extra == "test"
+Requires-Dist: pythonic-fp-circulararray>=6.0.1 ; extra == "test"
+Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/gadgets/development/build/html/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/build/html/
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-gadgets
+Provides-Extra: test
+
+Pythonic FP - Gadgets
+=====================
+
+PyPI project
+`pythonic-fp-gadgets
+<https://pypi.org/project/pythonic-fp>`_.
+
+Library of simple, but useful, classes and functions with no dependencies
+outside the Python Standard Library.
+
+- Gadgets
+
+  - single item box
+  - function returning iterator of its arguments
+  - function to find the latest common ancestor of two classes
+
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp>`_
+PyPI projects.
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/gadgets>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_gadgets-4.0.2/README.rst

@@ -0,0 +1,33 @@
+Pythonic FP - Gadgets
+=====================
+
+PyPI project
+`pythonic-fp-gadgets
+<https://pypi.org/project/pythonic-fp>`_.
+
+Library of simple, but useful, classes and functions with no dependencies
+outside the Python Standard Library.
+
+- Gadgets
+
+  - single item box
+  - function returning iterator of its arguments
+  - function to find the latest common ancestor of two classes
+
+Part of the
+`pythonic-fp
+<https://grscheller.github.io/pythonic-fp>`_
+PyPI projects.
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/gadgets>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.

pythonic_fp_gadgets-4.0.2/pyproject.toml

@@ -0,0 +1,77 @@
+[project]
+name = "pythonic-fp-gadgets"
+version = "4.0.2"
+readme = "README.rst"
+requires-python = ">=3.13"
+license = { file = "LICENSE" }
+authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+keywords = [
+  "gadgets",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Framework :: Pytest",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+dependencies = []
+dynamic = ["description"]
+
+[project.urls]
+Changelog = "https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst"
+Documentation = "https://grscheller.github.io/pythonic-fp/gadgets/development/build/html/"
+Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
+Source = "https://github.com/grscheller/pythonic-fp-gadgets"
+
+[project.optional-dependencies]
+test = [
+  "pytest>=8.4.1",
+  "pythonic-fp-circulararray>=6.0.1",
+]
+
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.module]
+name = "pythonic_fp.gadgets"
+
+[tool.mypy]
+enable_incomplete_feature = "NewGenericSyntax"
+explicit_package_bases = true
+implicit_reexport = false
+local_partial_types = true
+namespace_packages = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pylsp-mypy]
+enabled = true
+live-mode = true
+dmypy = false
+strict = true
+report_progress = true
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+consider_namespace_packages = true
+testpaths = ["tests/"]
+
+[tool.ruff]
+target-version = "py313"
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["C901"]
+"tests/**/*.py" = ['E731']
+"**/*.py" = ["E741"]
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-line-length = 72

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

@@ -0,0 +1,85 @@
+# 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.
+
+"""
+Gadgets
+-------
+
+.. admonition:: Collection of mostly self-contained functions and classes
+
+    - Functions and classes which could go multiple places or have
+      no good place to go.
+    - Self-contained with minimal dependencies.
+    - No pythonic_fp dependencies.
+
+"""
+
+from collections.abc import Iterator
+from inspect import getmro
+
+__all__ = ['first_common_ancestor', 'iterate_over_arguments']
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'
+
+
+def first_common_ancestor(cls1: type, cls2: type) -> type:
+    """Find the least upper bound in the inheritance graph
+    of two classes.
+
+    .. warning::
+
+        This function can fail with a TypeError. Some error messages
+        seen are
+
+        - multiple bases have instance lay-out conflict
+        - type 'bool' is not an acceptable base type
+
+        This happens frequently when the function is given
+        Python builtin types or in multiple inheritance situations.
+
+    :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 or not
+                       caught when raised by ``inspect.getmro``.
+
+    """
+    if issubclass(cls1, cls2):
+        return cls2
+    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!!!")
+
+
+def iterate_over_arguments[A](*args: A) -> Iterator[A]:
+    """Function returning an iterator of its arguments.
+
+    .. note::
+
+        Does not create an object to iterate over.
+
+        - well, not in the Python world
+        - maybe in the C world
+
+    :param args: Objects to iterate over.
+    :returns: An iterator of the functions arguments.
+
+    """
+    yield from args

pythonic_fp_gadgets-4.0.2/src/pythonic_fp/gadgets/__init__.pyi

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