pythonic-fp-gadgets 4.0.1__tar.gz → 4.0.3__tar.gz

pythonic_fp_gadgets-4.0.3/.github/workflows/static.yml

@@ -0,0 +1,58 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Select Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Sphinx Dependencies
+        run: |
+          pip install -r docs/requirements.txt
+          sudo apt-get install -y graphviz
+
+      - name: Build Release Docs
+        run: |
+          pip install pythonic-fp-gadgets
+          cp docs/index_release.rst docs/source/index.rst
+          cp docs/conf_release.py docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/release
+
+      - name: Build Development Docs
+        run: |
+          pip install -e .
+          cp docs/index_devel.rst docs/source/index.rst
+          cp docs/conf_devel.py docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/development
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/build
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v5
+        id: deployment

{pythonic_fp_gadgets-4.0.1 → pythonic_fp_gadgets-4.0.3}/.gitignore

@@ -1,6 +1,10 @@
 # Minimal version - only add to when necessary
 **/__pycache__/
 dist/
+docs/build/release/
+docs/build/development/
+docs/source/conf.py
+docs/source/index.rst
 **/.dmypy.json
 **/.mypy_cache/
 **/.pytest_cache/

{pythonic_fp_gadgets-4.0.1 → pythonic_fp_gadgets-4.0.3}/CHANGELOG.rst

@@ -17,6 +17,20 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 4.0.3 - 2026-04-26
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Redoing docs based on circulararray and booleans.
+
+- made some innovations which I will back port to the above two.
+
+
+PyPI 4.0.2 - 2026-01-08
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Docstring improvements based on lessons learned from my PyPI
+boring-math-abstract-algebra project.
+
 PyPI v4.0.1 - 2025-12-02
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -26,7 +40,7 @@ Move functions out of their own packages to __init__.py (2025-10-13).
 - iterate_arguments.ita -> iterate_over_arguments
 
 Unfortunately I forgot to push these changes to PyPI for a
-month and a half.
+month and a half!
 
 PyPI v3.0.1 - 2025-09-09
 ~~~~~~~~~~~~~~~~~~~~~~~~

{pythonic_fp_gadgets-4.0.1 → pythonic_fp_gadgets-4.0.3}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-gadgets
-Version: 4.0.1
-Summary: **Module level function names.**
+Version: 4.0.3
+Summary: Gadgets
 Keywords: gadgets
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
 Requires-Python: >=3.13
@@ -11,14 +11,14 @@ 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: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 License-File: LICENSE
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
-Requires-Dist: pythonic-fp-circulararray>=6.0.0 ; extra == "test"
+Requires-Dist: pythonic-fp-circulararray>=6.0.4 ; 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: Documentation, https://grscheller.github.io/pythonic-fp-gadgets/
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/html/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-gadgets
 Provides-Extra: test
 
@@ -27,7 +27,7 @@ Pythonic FP - Gadgets
 
 PyPI project
 `pythonic-fp-gadgets
-<https://pypi.org/project/pythonic-fp>`_.
+<https://pypi.org/project/pythonic-fp-gadgets>`_.
 
 Library of simple, but useful, classes and functions with no dependencies
 outside the Python Standard Library.
@@ -35,12 +35,14 @@ outside the Python Standard Library.
 - Gadgets
 
   - single item box
+  - wrapped (hashable) references
   - function returning iterator of its arguments
-  - find the latest common ancestor of two classes
+  - function to find the latest common ancestor of two classes
+  - sentinel values
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/homepage/html/>`_
 PyPI projects.
 
 Documentation
@@ -48,11 +50,11 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/gadgets>`_.
+<https://grscheller.github.io/pythonic-fp-gadgets>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2025-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.
 

{pythonic_fp_gadgets-4.0.1 → pythonic_fp_gadgets-4.0.3}/README.rst

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

pythonic_fp_gadgets-4.0.3/docs/Makefile

@@ -0,0 +1,47 @@
+# Makefile for Sphinx documentation
+#
+# Important Note: "make devel" and "make release" will just
+# use the first pythonic_fp.circulararray package found.
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+STATICDIR     = source/_static
+TEMPLATEDIR   = source/_templates
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+Makefile:
+	mkdir -p $(STATICDIR) $(TEMPLATEDIR)
+
+# Build development labeled html docs.
+devel: Makefile
+	rm -rf "$(BUILDDIR)"/development
+	rm -f "$(SOURCEDIR)"/index.rst "$(SOURCEDIR)"/conf.py
+	cp index_devel.rst "$(SOURCEDIR)"/index.rst
+	cp conf_devel.py "$(SOURCEDIR)"/conf.py
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
+
+# Build release labeled html docs.
+release: Makefile
+	rm -rf "$(BUILDDIR)"/release
+	rm -f "$(SOURCEDIR)"/index.rst "$(SOURCEDIR)"/conf.py
+	cp index_release.rst "$(SOURCEDIR)"/index.rst
+	cp conf_release.py "$(SOURCEDIR)"/conf.py
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
+
+.PHONY: help Makefile devel release
+
+# Catch-all target: route all unknown targets to Sphinx, build development docs
+%: Makefile
+	rm -rf "$(BUILDDIR)"/development
+	rm -f "$(SOURCEDIR)"/index.rst "$(SOURCEDIR)"/conf.py
+	cp index_devel.rst "$(SOURCEDIR)"/index.rst
+	cp conf_devel.py "$(SOURCEDIR)"/conf.py
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)

pythonic_fp_gadgets-4.0.3/docs/build/index.html

@@ -0,0 +1,44 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <title>PyPI Project: pythonic-fp-gadgets</title>
+  <link rel="stylesheet" href="style.css" />
+</head>
+
+<body>
+  <table>
+    <tr>
+      <td>
+        <h3>Pythonic FP Gadgets</h3>
+        <dl>
+          <dt>Gadgets - pythonic-fp-gadgets:</dt>
+          <dd><a href="https://pypi.org/project/pythonic-fp-gadgets/"> PyPI</a></dd>
+          <dd><a href="https://github.com/grscheller/pythonic-fp-gadgets"> GitHub</a></dd>
+        </dl>
+
+        <dl>
+          <dt>Gadgets Documentation:</dt>
+          <dd><a href="https://grscheller.github.io/pythonic-fp-gadgets/release/html/"> Latest release</a></dd>
+          <dd><a href="https://grscheller.github.io/pythonic-fp-gadgets/development/html/"> Development</a></dd>
+        </dl>
+      </td>
+
+      <td>
+        <h3>Related PyPI Projects</h3>
+        <dl>
+          <dt>Pythonic Functional Programming:</dt>
+          <dd><a href="https://grscheller.github.io/pythonic-fp/"> Pythonic FP Homepage</a></dd>
+        </dl>
+
+        <dl>
+          <dt>Daddy's Boring Math Library :</dt>
+          <dd><a href="https://grscheller.github.io/boring-math/"> Boring Math Homepage</a></dd>
+        </dl>
+      </td>
+    </tr>
+  </table>
+</body>
+
+</html>

pythonic_fp_gadgets-4.0.3/docs/build/style.css

@@ -0,0 +1,44 @@
+body {
+    color: #c5c9c5;
+    background-color: #181616;
+    font-family: cantarell,liberation,arial,helvetica,sans-serif
+}
+
+a:link {
+    color: #6884c0;
+    text-decoration: none;
+}
+
+a:visited {
+    color: #7e9cd8;
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+h3 {
+    color: #b6927b;
+    margin-left: 20px;
+}
+
+table {
+    width: 100%;
+}
+
+td {
+    vertical-align: top;
+}
+
+dt {
+    color: #acafac;
+    margin-left: 20px;
+    margin-top: 5px;
+}
+
+dd {
+    color: #c5c9c5;
+    margin-left: 20px;
+    padding-left: 15px;
+}

pythonic_fp_gadgets-4.0.3/docs/conf_devel.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Gadgets'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '4.0.3'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_member_order = 'bysource'
+autoclass_content = 'class'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_gadgets-4.0.3/docs/conf_release.py

@@ -0,0 +1,61 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Gadgets'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '4.0.2'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_member_order = 'bysource'
+autoclass_content = 'class'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_gadgets-4.0.3/docs/index_devel.rst

@@ -0,0 +1,30 @@
+pythonic-fp-gadgets
+===================
+
+Project
+`pythonic-fp-gadgets <https://pypi.org/project/pythonic-fp-gadgets/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**Proposed PyPI 4.0.3 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_gadgets-4.0.3/docs/index_release.rst

@@ -0,0 +1,30 @@
+pythonic-fp-gadgets
+===================
+
+Project
+`pythonic-fp-gadgets <https://pypi.org/project/pythonic-fp-gadgets/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**PyPI 4.0.2 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_gadgets-4.0.3/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx>=9.1
+furo

pythonic_fp_gadgets-4.0.3/docs/source/changelog.rst

@@ -0,0 +1,7 @@
+changelog
+=========
+
+Changelog for the
+`pythonic-fp-gadgets
+<https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst>`_
+PyPI project.

pythonic_fp_gadgets-4.0.3/docs/source/description.rst

@@ -0,0 +1,7 @@
+Description
+-----------
+
+.. automodule:: pythonic_fp.gadgets
+    :synopsis:
+    :noindex:
+

pythonic_fp_gadgets-4.0.3/docs/source/docs/box.rst

@@ -0,0 +1,6 @@
+box
+===
+
+.. automodule:: pythonic_fp.gadgets.box
+    :members:
+    :special-members:

pythonic_fp_gadgets-4.0.3/docs/source/docs/functions/first_common_ancestor.rst

@@ -0,0 +1,4 @@
+first_common_ancestor
+---------------------
+
+.. autofunction:: pythonic_fp.gadgets.first_common_ancestor

pythonic_fp_gadgets-4.0.3/docs/source/docs/functions/index.rst

@@ -0,0 +1,8 @@
+functions
+=========
+
+.. toctree::
+    :caption: Functions
+
+    first_common_ancestor
+    iterate_over_arguments

pythonic_fp_gadgets-4.0.3/docs/source/docs/functions/iterate_over_arguments.rst

@@ -0,0 +1,4 @@
+iterate_over_arguments
+----------------------
+
+.. autofunction:: pythonic_fp.gadgets.iterate_over_arguments

pythonic_fp_gadgets-4.0.3/docs/source/docs/index.rst

@@ -0,0 +1,31 @@
+Gadgets
+=======
+
+.. automodule:: pythonic_fp.gadgets
+    :no-members:
+    :ignore-module-all:
+    :no-index:
+
+.. toctree::
+    :caption: functions
+    :maxdepth: 1
+
+    functions/index
+
+.. toctree::
+    :caption: module box
+    :maxdepth: 1
+
+    box
+
+.. toctree::
+    :caption: module wrap
+    :maxdepth: 1
+
+    wrap
+
+.. toctree::
+    :caption: module sentinels
+    :maxdepth: 1
+
+    sentinels/index

pythonic_fp_gadgets-4.0.3/docs/source/docs/sentinels/flavored.rst

@@ -0,0 +1,8 @@
+flavored
+========
+
+**Sentinel values "indexed" by hashable values of a given type.**
+
+.. automodule:: pythonic_fp.gadgets.sentinels.flavored
+    :members:
+    :special-members:

pythonic_fp_gadgets-4.0.3/docs/source/docs/sentinels/index.rst

@@ -0,0 +1,12 @@
+sentinels
+=========
+
+.. automodule:: pythonic_fp.gadgets.sentinels
+    :synopsis:
+
+.. toctree::
+    :caption: Sentinel Values
+
+    novalue
+    flavored
+

pythonic_fp_gadgets-4.0.3/docs/source/docs/sentinels/novalue.rst

@@ -0,0 +1,11 @@
+novalue
+=======
+
+.. automodule:: pythonic_fp.gadgets.sentinels.novalue
+    :members:
+    :special-members:
+    :exclude-members: NoValue
+
+.. autoclass:: pythonic_fp.gadgets.sentinels.novalue.NoValue
+    :members:
+    :special-members: __eq__, __ne__

pythonic_fp_gadgets-4.0.3/docs/source/docs/wrap.rst

@@ -0,0 +1,6 @@
+wrap
+====
+
+.. automodule:: pythonic_fp.gadgets.wrap
+    :members:
+    :special-members: