pythonic-fp-gadgets 4.0.2__tar.gz → 4.0.4__tar.gz

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

@@ -0,0 +1,64 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  RELEASE: '4.0.4'
+  DEVEL: '4.0.4'
+  PYTHON: '3.14'
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Select Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ env.PYTHON }}
+
+      - 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
+          docs/gen_conf.py release ${{ env.RELEASE }} Gadgets gadgets > docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/release
+
+      - name: Build Development Docs
+        run: |
+          pip install -e .
+          docs/gen_conf.py devel ${{ env.DEVEL }} Gadgets gadgets > 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.2 → pythonic_fp_gadgets-4.0.4}/.gitignore

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

{pythonic_fp_gadgets-4.0.2 → pythonic_fp_gadgets-4.0.4}/CHANGELOG.rst

@@ -17,8 +17,28 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-PyPI 4.0.2 - 2026-01-TBD
-~~~~~~~~~~~~~~~~~~~~~~~~
+PyPI 4.0.4 - 2026-04-26
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Much docstring work for sentinels. Need to push now going into
+documentation maintenance to fix broken links on PyPI.
+
+Development Status Reappraisal - 2026-05-05
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Maintainer appraised the Development Status for
+pythonic-fp-gadgets to be ``"3 - Alpha"``.
+
+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.

{pythonic_fp_gadgets-4.0.2 → pythonic_fp_gadgets-4.0.4}/PKG-INFO

@@ -1,24 +1,24 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-gadgets
-Version: 4.0.2
+Version: 4.0.4
 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: Development Status :: 3 - Alpha
 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.1 ; 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/projects/gadgets.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 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,24 +35,26 @@ outside the Python Standard Library.
 - 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
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/gadgets>`_.
+<https://grscheller.github.io/pythonic-fp/projects/gadgets.html>`_.
 
 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.2 → pythonic_fp_gadgets-4.0.4}/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,23 +11,25 @@ outside the Python Standard Library.
 - 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
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp>`_
+<https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
 Documentation
 -------------
 
-Documentation for this project is hosted on
+Documentation and other links for this project are hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/gadgets>`_.
+<https://grscheller.github.io/pythonic-fp/projects/gadgets.html>`_.
 
 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.4/docs/Makefile

@@ -0,0 +1,78 @@
+# Makefile for Sphinx documentation
+
+# Last and future releases
+#  - former needs to agree with PyPI
+#  - later needs to agree with pyproject.toml
+PROJECT_NAME = Gadgets
+PYPI_NAME = gadgets
+RELEASE_VERSION = 4.0.4
+DEVEL_VERSION = 4.0.4
+CUSTOM_VERSION = 0.0.0
+
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+SOURCEDIR = source
+BUILDDIR = build
+
+STATICDIR = source/_static
+TEMPLATEDIR = source/_templates
+
+# Put help first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+clean_source:
+	@rm -f "$(SOURCEDIR)"/conf.py
+
+clean_devel:
+	@rm -rf "$(BUILDDIR)"/development
+
+clean_release:
+	@rm -rf "$(BUILDDIR)"/release
+
+clean_custom:
+	@rm -rf "$(BUILDDIR)"/custom
+
+clean: clean_devel clean_release clean_custom clean_source
+	@rm -rf $(BUILDDIR)
+	@echo Removed all doc build artifacts.
+
+setup_devel: clean_devel
+	@./gen_conf.py devel "$(DEVEL_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_release: clean_release
+	@./gen_conf.py release "$(RELEASE_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_custom: clean_custom
+	@./gen_conf.py custom "$(CUSTOM_VERSION)" "$(PROJECT_NAME)" "$(PYPI_NAME)" > "$(SOURCEDIR)"/conf.py
+
+setup_redo: clean_custom
+	@echo Redoing custom build with a possibly reeditted conf.py
+	@./gen_conf.py redo "" "" ""
+
+# Build development labeled html docs.
+devel: Makefile setup_devel
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
+
+# Build release labeled html docs.
+release: Makefile setup_release
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
+
+# Build custom labeled html docs.
+custom: Makefile setup_custom
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+# Build HTML docs with previous generated (possibly hand edited) source/conf.py,
+# put results in $(BUILDDIR)/custom.
+redo: Makefile setup_redo
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+# Catch-all target: route all unknown targets to Sphinx and save to $(BUILDDIR)/custom.
+# Reuse a previously generated source/conf.py.
+%: Makefile setup_redo
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)
+
+.PHONY: help Makefile
+.PHONY: setup_devel setup_release setup_custom
+.PHONY: devel release
+.PHONY: clean_source clean_devel clean_release clean_custom clean

pythonic_fp_gadgets-4.0.4/docs/gen_conf.py

@@ -0,0 +1,110 @@
+#!/usr/bin/env python
+# Generate conf.py Sphinx configuration executable
+
+import sys
+import os
+
+project_prefix = 'Pythonic FP'
+pypi_prefix = 'pythonic-fp'
+author = 'Geoffrey R. Scheller'
+copyright = f'2023-2026, {author}'
+
+args = sys.argv[1:]
+num_args = len(args)
+
+if num_args == 4:
+    build_type, version, project_name, pypi_name = args
+    project = project_prefix + ' - ' + project_name
+    pypi_project_repo = pypi_prefix + '-' + pypi_name
+    project_url_rst = f'`{project} <https://pypi.org/project/{pypi_project_repo}/>`_'
+    homepage_url_rst = f'`{project_prefix} <https://grscheller.github.io/{pypi_prefix}/>`_'
+
+else:
+    sys.exit('Error: gen_conf.py takes exactly 4 arguments')
+
+match build_type:
+    case 'custom':
+        release = f'{version}'
+        release_string = f'**Custom PyPI Non-release version {release}**'
+    case 'devel':
+        release = f'{version}'
+        release_string = f'**Proposed PyPI release version {release}**'
+    case 'release':
+        release = f'{version}'
+        release_string = f'**PyPI release version {release}**'
+    case 'redo':
+        if not os.path.isfile('source/conf.py'):
+            sys.exit('Error: cannot redo without source/conf.py')
+        sys.exit()
+    case _:
+        sys.exit(f'Error: unknown built_type {build_type} given')
+
+print(f'''# Generated conf.py Sphinx configuration executable
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = '{project}'
+author = '{author}'
+copyright = '{copyright}'
+release = '{release}'
+release_string = '{release_string}'
+
+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_default_options = {{
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': False,
+    'show-inheritance': True,
+}}
+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']
+html_css_files = ['custom.css']
+
+rst_epilog = """
+.. |RELEASE_STRING| replace:: {release_string}
+
+"""
+''')

pythonic_fp_gadgets-4.0.4/docs/requirements.txt

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

pythonic_fp_gadgets-4.0.4/docs/source/_static/custom.css

@@ -0,0 +1,3 @@
+dl.field-list > dt {
+    text-transform: none !important;
+}

pythonic_fp_gadgets-4.0.4/docs/source/api/box.rst

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

pythonic_fp_gadgets-4.0.4/docs/source/api/functions/first_common_ancestor.rst

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

pythonic_fp_gadgets-4.0.4/docs/source/api/functions/index.rst

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

pythonic_fp_gadgets-4.0.4/docs/source/api/functions/iterate_over_arguments.rst

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

pythonic_fp_gadgets-4.0.4/docs/source/api/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.4/docs/source/api/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.4/docs/source/api/sentinels/index.rst

@@ -0,0 +1,14 @@
+sentinels
+=========
+
+.. automodule:: pythonic_fp.gadgets.sentinels
+    :no-members:
+    :ignore-module-all:
+    :no-index:
+
+.. toctree::
+    :caption: Sentinel Values
+    :maxdepth: 2
+
+    novalue
+    flavored

pythonic_fp_gadgets-4.0.4/docs/source/api/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.4/docs/source/api/wrap.rst

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

pythonic_fp_gadgets-4.0.4/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.4/docs/source/description.rst

@@ -0,0 +1,8 @@
+Description
+-----------
+
+.. automodule:: pythonic_fp.gadgets
+    :no-members:
+    :ignore-module-all:
+    :no-index:
+

pythonic_fp_gadgets-4.0.4/docs/source/index.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.
+
+|RELEASE_STRING|
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    api/index

pythonic_fp_gadgets-4.0.4/docs/source/releases.rst

@@ -0,0 +1,28 @@
+PyPI releases
+=============
+
+**pythonic-fp-gadgets:** pythonic_fp.gadgets
+
++-------------------------------------------------------------------------------------+--------------+
+| PyPI Release                                                                        | Release date |
++=====================================================================================+==============+
+| `development <https://grscheller.github.io/pythonic-fp-gadgets/development/html/>`_ |              |
++-------------------------------------------------------------------------------------+--------------+
+| `v4.0.4 <https://grscheller.github.io/pythonic-fp-gadgets/release/html/>`_          | 2026-05-12   |
++-------------------------------------------------------------------------------------+--------------+
+| v4.0.3                                                                              | 2026-04-26   |
++-------------------------------------------------------------------------------------+--------------+
+| v4.0.2                                                                              | 2026-01-08   |
++-------------------------------------------------------------------------------------+--------------+
+| v4.0.1                                                                              | 2025-12-02   |
++-------------------------------------------------------------------------------------+--------------+
+| v3.1.0                                                                              | 2025-09-26   |
++-------------------------------------------------------------------------------------+--------------+
+| v3.0.1                                                                              | 2025-09-09   |
++-------------------------------------------------------------------------------------+--------------+
+| v3.0.0                                                                              | 2025-08-31   |
++-------------------------------------------------------------------------------------+--------------+
+| v2.2.0                                                                              | 2025-08-30   |
++-------------------------------------------------------------------------------------+--------------+
+| v1.1.0                                                                              | 2025-08-02   |
++-------------------------------------------------------------------------------------+--------------+