pythonic-fp-fptools 5.2.0__tar.gz → 5.3.0__tar.gz

pythonic_fp_fptools-5.3.0/.github/workflows/static.yml

@@ -0,0 +1,64 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+env:
+  RELEASE: '5.2.0'
+  DEVEL: '6.0.0'
+  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: '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-fptools
+          docs/gen_conf.py release ${{ env.RELEASE }} "FP Tools" fptools > 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 }} "FP Tools" fptools > 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_fptools-5.2.0 → pythonic_fp_fptools-5.3.0}/.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_fptools-5.2.0 → pythonic_fp_fptools-5.3.0}/CHANGELOG.rst

@@ -17,16 +17,37 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 5.3.0 - 2026-05-09
+~~~~~~~~~~~~~~~~~~~~~~~
+
+First PyPI release in over a year with actual substative code
+changes.
+
+- Finally happy with the Sphinx/Furo based documentation.
+- Fixed errors with MayBe and Either hashing.
+- This will fix the PyPI link issues.
+- Next release will be 6.0.0 when I move the monads to
+  their own submodule.
+
+Development Status Reappraisal - 2026-05-05
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Maintainer reappraised the Development Status for
+pythonic-fp-fptools to be ``"5 - Production/Stable"``.
+
+
 PyPI 5.2.0 - 2026-01-13
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Added function.compose back on 2025-12-04. Docstring updates for Sphinx.
 
+
 PyPI 5.1.2 - 2025-09-28
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Patch bump for pythonic-fp PyPI coordinated release 3.3.3.
 
+
 PyPI 5.1.1 - 2025-09-09
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -43,10 +64,11 @@ made it a MINOR release due to introducing .pyi files.
 PyPI 5.0.0 - 2025-08-02
 ~~~~~~~~~~~~~~~~~~~~~~~
 
-Coordinated entire project pythonic-fp PyPI deployment.
+Coordinated moving entire project to the pythonic-fp PyPI name.
 
 - moved maybe.py and xor.py from containers, renamed xor.py -> either.py.
 
+
 PyPI 4.0.0 - 2025-07-13
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -58,16 +80,21 @@ Dropped developer status to Beta
 TODO: After next Boring Math (bm) deployment, I should be able to archive
 my dtools namespace repos
 
+
 PyPI 3.0.0 - 2025-07-06
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 First PyPI release as ``pythonic-fp.fptools``
 
-- dropping dtools namespace name because there is a repo by that name.
+- dropping dtools namespace name because there is a repo by that name
+  on PyPI.
+
 
 PyPI 2.0.0 - 2025-05-22
 ~~~~~~~~~~~~~~~~~~~~~~~
 
+One more release as dtools.fp.
+
 - Moved dtools.fp.err_handling to the dtools.containers PyPI project
 
   - Moved class MayBe -> module dtools.containers.maybe
@@ -76,6 +103,7 @@ PyPI 2.0.0 - 2025-05-22
 
     - will import dtools.fp.lazy directly for this functionality
 
+
 PyPI 1.7.0 - 2025-04-22
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -86,6 +114,7 @@ Last PyPI release as dtools.fp
 - docstring changes
 - pyproject.toml standardization
 
+
 PyPI 1.6.1.0 - 2025-04-17
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -101,11 +130,13 @@ PyPI 1.6.1.0 - 2025-04-17
 
 - Also noticed MB and XOR still have camelCase APIs
 
+
 PyPI 1.6.0 - 2025-04-07
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 - typing improvements
 
+
 PyPI 1.4.0 - 2025-03-16
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -125,11 +156,13 @@ PyPI 1.4.0 - 2025-03-16
 
     - avoid using these methods in pure code
 
+
 PyPI 1.3.1 - 2025-02-05
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 - added class method sequence to class State
 
+
 PyPI 1.3.0 - 2025-01-17
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -140,6 +173,7 @@ Repo name changes.
 - GitHub: fp -> dtools-fp
 - PyPI: grscheller.fp -> dtools.fp
 
+
 PyPI 1.2.0 - 2025-01-04
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -147,6 +181,7 @@ PyPI 1.2.0 - 2025-01-04
 - renamed flatmap methods to bind
 - minor MB and XOR updates/corrections
 
+
 PyPI 1.1.0 - 2024-11-18
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -155,6 +190,7 @@ Added fp.function module.
 - combine and partially apply functions as first class objects
 - some tests may be lacking
 
+
 Version 1.0.2.0 - 2024-10-20 (Devel environment only)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -172,6 +208,7 @@ Version 1.0.2.0 - 2024-10-20 (Devel environment only)
        
 - will redo docs in docs repo
 
+
 PyPI 1.0.1 - 2024-10-20
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -183,6 +220,7 @@ PyPI 1.0.1 - 2024-10-20
 PyPI 1.0.0 - 2024-10-18
 ~~~~~~~~~~~~~~~~~~~~~~~
 
+
 Decided to make this release first stable release.
 
 - renamed module fp.woException to fp.err_handling
@@ -191,11 +229,13 @@ Decided to make this release first stable release.
    
 - pytest improvements based on pytest documentation
 
+
 PyPI 0.4.0 - 2024-10-03
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Long overdue PyPI release.
 
+
 Version 0.3.5.1 - 2024-10-03 (Devel environment only)
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -214,6 +254,7 @@ New module ``grscheller.fp.nothingness`` which contains
 
   - prefer class ``MB`` to represent a missing value in client code
 
+
 PyPI 0.3.3 - 2024-08-25
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -226,6 +267,7 @@ PyPI 0.3.3 - 2024-08-25
   - makeRight(self, right: R|Nada=nada) -> XOR\[L, R\]:
   - swapRight(self, right: R) -> XOR\[L, R\]:
 
+
 PyPI 0.3.0 - 2024-08-17
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -233,6 +275,7 @@ Class Nothing re-added but renamed class Nada.
 
 Version grscheller.untyped.nothing for more strictly typed code.
 
+
 PyPI 0.2.1 - 2024-07-26
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -241,6 +284,7 @@ PyPI grscheller.fp package release v0.2.1
 - forgot to update README.md on last PyPI release
 - simplified README.md to help alleviate this mistake in the future
 
+
 PyPI 0.2.0 - 2024-07-26
 ~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -253,6 +297,7 @@ PyPI 0.2.0 - 2024-07-26
 
   - renamed ``fp.wo_exception`` to ``fp.woException``
 
+
 PyPI 0.1.0 - 2024-07-11
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_fptools-5.2.0 → pythonic_fp_fptools-5.3.0}/PKG-INFO

@@ -1,29 +1,29 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-fptools
-Version: 5.2.0
-Summary: Pythonic FP - Functional Programming Tools
+Version: 5.3.0
+Summary: Functional Programming Tools
 Keywords: either,fp,functional,functional programming,lazy,maybe,monad,non-strict
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
-Requires-Python: >=3.12
+Requires-Python: >=3.13
 Description-Content-Type: text/x-rst
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 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: pythonic-fp-booleans>=2.1.1
-Requires-Dist: pythonic-fp-circulararray>=6.0.1
+Requires-Dist: pythonic-fp-booleans>=3.0.2
+Requires-Dist: pythonic-fp-circulararray>=6.0.4
 Requires-Dist: pythonic-fp-gadgets>=4.0.2
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Requires-Dist: pythonic-fp-containers>=4.0.1 ; extra == "test"
 Requires-Dist: pythonic-fp-iterables>=5.1.3 ; extra == "test"
 Requires-Dist: pythonic-fp-queues>=5.1.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-fptools/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/fptools/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/fptools.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-fptools
 Provides-Extra: test
 
@@ -32,7 +32,7 @@ Pythonic FP - Functional tools
 
 PyPI project
 `pythonic-fp.fptools
-<https://pypi.org/project/pythonic-fp.fptools>`_.
+<https://pypi.org/project/pythonic-fp-fptools>`_.
 
 Tools to aid with functional programming in Python while still
 endeavoring to be Pythonic.
@@ -53,19 +53,19 @@ endeavoring to be Pythonic.
 
 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/fptools>`_.
+<https://grscheller.github.io/pythonic-fp/projects/fptools.html>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.
 

{pythonic_fp_fptools-5.2.0 → pythonic_fp_fptools-5.3.0}/README.rst

@@ -3,7 +3,7 @@ Pythonic FP - Functional tools
 
 PyPI project
 `pythonic-fp.fptools
-<https://pypi.org/project/pythonic-fp.fptools>`_.
+<https://pypi.org/project/pythonic-fp-fptools>`_.
 
 Tools to aid with functional programming in Python while still
 endeavoring to be Pythonic.
@@ -24,18 +24,18 @@ endeavoring to be Pythonic.
 
 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/fptools>`_.
+<https://grscheller.github.io/pythonic-fp/projects/fptools.html>`_.
 
 Copyright and License
 ---------------------
 
-Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+Copyright (c) 2023-2026 Geoffrey R. Scheller. Licensed under the Apache
 License, Version 2.0. See the LICENSE file for details.

pythonic_fp_fptools-5.3.0/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 = FP Tools Array
+PYPI_NAME = fptools
+RELEASE_VERSION = 5.3.0
+DEVEL_VERSION = 5.3.0
+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_fptools-5.3.0/docs/gen_conf.py

@@ -0,0 +1,109 @@
+#!/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']
+
+rst_epilog = """
+.. |RELEASE_STRING| replace:: {release_string}
+
+"""
+''')

pythonic_fp_fptools-5.3.0/docs/requirements.txt

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

pythonic_fp_fptools-5.3.0/docs/source/api/function.rst

@@ -0,0 +1,6 @@
+function
+========
+
+.. automodule:: pythonic_fp.fptools.function
+    :members:
+    :special-members:

pythonic_fp_fptools-5.3.0/docs/source/api/index.rst

@@ -0,0 +1,20 @@
+FP Tools
+========
+
+.. toctree::
+    :caption: Function manipulation
+    :maxdepth: 1
+
+    function
+
+.. toctree::
+    :caption: Lazy function evaluation
+    :maxdepth: 1
+
+    lazy
+
+.. toctree::
+    :caption: Monads
+    :maxdepth: 2
+
+    monads/index

pythonic_fp_fptools-5.3.0/docs/source/api/lazy.rst

@@ -0,0 +1,6 @@
+lazy
+====
+
+.. automodule:: pythonic_fp.fptools.lazy
+    :members:
+    :special-members:

pythonic_fp_fptools-5.3.0/docs/source/api/monads/either.rst

@@ -0,0 +1,6 @@
+either monad
+============
+
+.. automodule:: pythonic_fp.fptools.either
+    :members:
+    :special-members:

pythonic_fp_fptools-5.3.0/docs/source/api/monads/index.rst

@@ -0,0 +1,10 @@
+Monads
+======
+
+.. toctree::
+    :caption: Monads
+    :maxdepth: 2
+
+    maybe
+    either
+    state

pythonic_fp_fptools-5.3.0/docs/source/api/monads/maybe.rst

@@ -0,0 +1,6 @@
+maybe monad
+===========
+
+.. automodule:: pythonic_fp.fptools.maybe
+    :members:
+    :special-members:

pythonic_fp_fptools-5.3.0/docs/source/api/monads/state.rst

@@ -0,0 +1,6 @@
+state monad
+===========
+
+.. automodule:: pythonic_fp.fptools.state
+    :members:
+    :special-members:

pythonic_fp_fptools-5.3.0/docs/source/changelog.rst

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

pythonic_fp_fptools-5.3.0/docs/source/description.rst

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