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

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/.github/workflows/static.yml

@@ -5,6 +5,11 @@ on:
     branches: ["main"]
   workflow_dispatch:
 
+env:
+  RELEASE: '4.0.4'
+  DEVEL: '4.0.4'
+  PYTHON: '3.14'
+
 permissions:
   contents: read
   pages: write
@@ -17,6 +22,9 @@ concurrency:
 jobs:
   deploy:
     runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
     steps:
       - name: Checkout
         uses: actions/checkout@v6
@@ -24,7 +32,7 @@ jobs:
       - name: Select Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.14'
+          python-version: ${{ env.PYTHON }}
 
       - name: Install Sphinx Dependencies
         run: |
@@ -34,15 +42,13 @@ jobs:
       - 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
+          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 .
-          cp docs/index_devel.rst docs/source/index.rst
-          cp docs/conf_devel.py docs/source/conf.py
+          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

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

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

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

@@ -17,6 +17,18 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+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
 ~~~~~~~~~~~~~~~~~~~~~~~
 

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

@@ -1,12 +1,12 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-gadgets
-Version: 4.0.3
+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
@@ -17,8 +17,8 @@ License-File: LICENSE
 Requires-Dist: pytest>=8.4.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/
-Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/homepage/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
 
@@ -35,22 +35,22 @@ outside the Python Standard Library.
 - Gadgets
 
   - single item box
-  - wrapped (hashable) references
+  - 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/homepage/html/>`_
+<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
 ---------------------

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

@@ -11,22 +11,22 @@ outside the Python Standard Library.
 - Gadgets
 
   - single item box
-  - wrapped (hashable) references
+  - 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/homepage/html/>`_
+<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
 ---------------------

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/source/_static/custom.css

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

{pythonic_fp_gadgets-4.0.3/docs/source/docs → pythonic_fp_gadgets-4.0.4/docs/source/api}/functions/first_common_ancestor.rst

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

{pythonic_fp_gadgets-4.0.3/docs/source/docs → pythonic_fp_gadgets-4.0.4/docs/source/api}/functions/iterate_over_arguments.rst

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

{pythonic_fp_gadgets-4.0.3/docs/source/docs → pythonic_fp_gadgets-4.0.4/docs/source/api}/sentinels/index.rst

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

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/docs/source/changelog.rst

@@ -1,4 +1,4 @@
-changelog
+Changelog
 =========
 
 Changelog for the

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/docs/source/description.rst

@@ -2,6 +2,7 @@ Description
 -----------
 
 .. automodule:: pythonic_fp.gadgets
-    :synopsis:
-    :noindex:
+    :no-members:
+    :ignore-module-all:
+    :no-index:
 

pythonic_fp_gadgets-4.0.3/docs/index_release.rst → pythonic_fp_gadgets-4.0.4/docs/source/index.rst

@@ -2,12 +2,12 @@ pythonic-fp-gadgets
 ===================
 
 Project
-`pythonic-fp-gadgets <https://pypi.org/project/pythonic-fp-gadgets/>`_
+`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**
+|RELEASE_STRING|
 
 .. toctree::
     :caption: Overview
@@ -27,4 +27,4 @@ PyPI projects.
     :caption: API Documentation
     :maxdepth: 1
 
-    docs/index
+    api/index

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/docs/source/releases.rst

@@ -8,7 +8,11 @@ PyPI releases
 +=====================================================================================+==============+
 | `development <https://grscheller.github.io/pythonic-fp-gadgets/development/html/>`_ |              |
 +-------------------------------------------------------------------------------------+--------------+
-| `v4.0.2 <https://grscheller.github.io/pythonic-fp-gadgets/release/html/>`_          | 2026-01-08   |
+| `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   |
 +-------------------------------------------------------------------------------------+--------------+

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/pyproject.toml

@@ -4,15 +4,17 @@ build-backend = "flit_core.buildapi"
 
 [project]
 name = "pythonic-fp-gadgets"
-version = "4.0.3"
+version = "4.0.4"
 readme = "README.rst"
 requires-python = ">=3.13"
-authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+authors = [
+  { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
 keywords = [
   "gadgets",
 ]
 classifiers = [
-  "Development Status :: 4 - Beta",
+  "Development Status :: 3 - Alpha",
   "Framework :: Pytest",
   "Intended Audience :: Developers",
   "License :: OSI Approved :: Apache Software License",
@@ -25,8 +27,8 @@ dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-gadgets/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp-gadgets/"
-Homepage = "https://grscheller.github.io/pythonic-fp/homepage/html/"
+Documentation = "https://grscheller.github.io/pythonic-fp/projects/gadgets.html"
+Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-gadgets"
 
 [project.optional-dependencies]

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/src/pythonic_fp/gadgets/__init__.py

@@ -14,14 +14,15 @@
 
 """
 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 at all.
+
+      - No pythonic_fp dependencies at all.
 
 """
 
@@ -42,23 +43,22 @@ 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
+        :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``.
 
-        - multiple bases have instance lay-out conflict
-        - type 'bool' is not an acceptable base type
+        .. warning::
 
-        This happens frequently when the function is given
-        Python builtin types or in multiple inheritance situations.
+            This function can fail with a TypeError. Some error messages
+            seen are
 
-    :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``.
+            - 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.
     """
     if issubclass(cls1, cls2):
         return cls2
@@ -77,12 +77,12 @@ def iterate_over_arguments[A](*args: A) -> Iterator[A]:
 
         Function returning an iterator over its arguments.
 
-    .. note::
+        :param args: Objects to iterate over.
+        :returns: An iterator of the function's arguments.
 
-        Does not create a Python object to iterate over.
+        .. note::
 
-    :param args: Objects to iterate over.
-    :returns: An iterator of the functions arguments.
+            Does not create a Python object to iterate over.
 
     """
     yield from args

{pythonic_fp_gadgets-4.0.3 → pythonic_fp_gadgets-4.0.4}/src/pythonic_fp/gadgets/__init__.pyi

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