pythonic-fp-booleans 3.0.1__tar.gz → 4.0.0__tar.gz

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/.github/workflows/static.yml

@@ -5,6 +5,11 @@ on:
     branches: ["main"]
   workflow_dispatch:
 
+env:
+  RELEASE: '4.0.0'
+  DEVEL: '4.0.1'
+  PYTHON: '3.14'
+
 permissions:
   contents: read
   pages: write
@@ -27,23 +32,23 @@ jobs:
       - name: Select Python
         uses: actions/setup-python@v6
         with:
-          python-version: '3.14'
+          python-version: ${{ env.PYTHON }}
 
       - name: Install Sphinx Dependencies
-        run: pip install -r docs/requirements.txt
+        run: |
+          pip install -r docs/requirements.txt
+          sudo apt-get install -y graphviz
 
-      - name: Build release docs
+      - name: Build Release Docs
         run: |
           pip install pythonic-fp-booleans
-          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 }} Booleans booleans > docs/source/conf.py
           sphinx-build -M html docs/source docs/build/release
 
-      - name: Build development docs
+      - 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 }} Booleans booleans > docs/source/conf.py
           sphinx-build -M html docs/source docs/build/development
 
       - name: Setup Pages

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/.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_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/CHANGELOG.rst

@@ -17,6 +17,42 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
+PyPI 4.0.0 - 2026-05-18
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Revamped pythonic-fp-booleans implementation.
+
+- API changes due to flavored booleans being made runtime "invariant"
+
+  - removed dunders methods __rand__, __ror__, __rxor__ from all classes
+  - flavored booleans bitwise operators now throw ValueError for different flavors
+
+    - pushing Python's type system a bit
+
+      - invariant, contravariant, covariant apply to operator arguments
+      - not to the class itself
+
+        - it should, but it does not
+        - the class is a "namespace" not the first argument to an operator
+
+  - if I were to do this over again I'd
+
+    - define class functions (contravariant args, covariant return values) which dunders would call
+    - make SBool a "true Boolean" not a subtype of "int"
+
+Development Status Reappraisal - 2026-05-05
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Maintainer appraises the Development Status for
+pythonic-fp-booleans to be ``"4 - Beta"``.
+
+PyPI 3.0.2 - 2026-04-25
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Corrected locations of project links. Changes will not
+fully be in effect until the next release of each
+Pythonic FP project to PyPI.
+
 PyPI 3.0.1 - 2025-12-02
 ~~~~~~~~~~~~~~~~~~~~~~~
 

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-booleans
-Version: 3.0.1
-Summary: Subtypable Boolean Class Hierarchy
+Version: 4.0.0
+Summary: Booleans
 Keywords: booleans,subtypable
 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: pythonic-fp-gadgets>=4.0.2
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-booleans/blob/main/CHANGELOG.rst
-Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/booleans/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/booleans.html
+Project-URL: Homepage, https://grscheller.github.io/pythonic-fp/
 Project-URL: Source, https://github.com/grscheller/pythonic-fp-booleans
 Provides-Extra: test
 
@@ -36,15 +36,15 @@ can be non-shortcut logically composed with Python’s bitwise operators.
 
 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-booleans>`_.
+<https://grscheller.github.io/pythonic-fp/projects/booleans.html>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/README.rst

@@ -12,15 +12,15 @@ can be non-shortcut logically composed with Python’s bitwise operators.
 
 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-booleans>`_.
+<https://grscheller.github.io/pythonic-fp/projects/booleans.html>`_.
 
 Copyright and License
 ---------------------

pythonic_fp_booleans-4.0.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 = Booleans
+PYPI_NAME = booleans
+RELEASE_VERSION = 4.0.0
+DEVEL_VERSION = 4.0.1
+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_booleans-4.0.0/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_booleans-4.0.0/docs/source/_static/custom.css

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

{pythonic_fp_booleans-3.0.1/docs/source/docs → pythonic_fp_booleans-4.0.0/docs/source/api}/flavored.rst

@@ -1,4 +1,4 @@
-module flavored
----------------
+flavored
+--------
 
 .. automodule:: pythonic_fp.booleans.flavored

pythonic_fp_booleans-4.0.0/docs/source/api/index.rst

@@ -0,0 +1,20 @@
+Booleans
+========
+
+.. automodule:: pythonic_fp.booleans
+    :no-members:
+    :ignore-module-all:
+    :no-index:
+
+.. toctree::
+    :caption: Subtypable Boolean
+    :maxdepth: 1
+
+    subtypable
+
+.. toctree::
+    :caption: Subtyped Boolean examples
+    :maxdepth: 1
+
+    flavored
+    truthy_falsy

pythonic_fp_booleans-4.0.0/docs/source/api/subtypable.rst

@@ -0,0 +1,6 @@
+subtypable
+==========
+
+.. automodule:: pythonic_fp.booleans.subtypable
+    :members:
+    :special-members:

{pythonic_fp_booleans-3.0.1/docs/source/docs → pythonic_fp_booleans-4.0.0/docs/source/api}/truthy_falsy.rst

@@ -1,4 +1,4 @@
-module truthy_falsy
--------------------
+truthy_falsy
+------------
 
 .. automodule:: pythonic_fp.booleans.truthy_falsy

pythonic_fp_booleans-4.0.0/docs/source/description.rst

@@ -0,0 +1,25 @@
+Description
+===========
+
+.. automodule:: pythonic_fp.booleans
+    :no-members:
+    :ignore-module-all:
+    :no-index:
+
+**Boolean type hierarchy**
+
+.. graphviz::
+
+    digraph Booleans {
+        bgcolor="#957fb8";
+        node [style=filled, fillcolor="#181616", fontcolor="#dcd7ba"];
+        edge [color="#181616", fontcolor="#dcd7ba"];
+        int -> bool;
+        int -> SBool;
+        SBool -> "FBool[H1]";
+        SBool -> "FBool[H2]";
+        SBool -> "FBool[H3]";
+        SBool -> TF_Bool;
+        TF_Bool -> T_Bool;
+        TF_Bool -> F_Bool;
+    }

pythonic_fp_booleans-3.0.1/docs/index_release.rst → pythonic_fp_booleans-4.0.0/docs/source/index.rst

@@ -2,12 +2,12 @@ pythonic-fp-booleans
 ====================
 
 Project
-`pythonic-fp-booleans <https://pypi.org/project/pythonic-fp-booleans/>`_
+`Pythonic FP - Booleans <https://pypi.org/project/pythonic-fp-booleans/>`_
 one of the
 `Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
 PyPI projects.
 
-**PyPI 3.0.0 release**
+|RELEASE_STRING|
 
 .. toctree::
     :caption: Overview
@@ -27,4 +27,4 @@ PyPI projects.
     :caption: API Documentation
     :maxdepth: 1
 
-    docs/index
+    api/index

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/docs/source/releases.rst

@@ -8,7 +8,11 @@ PyPI releases
 +======================================================================================+==============+
 | `development <https://grscheller.github.io/pythonic-fp-booleans/development/html/>`_ |              |
 +--------------------------------------------------------------------------------------+--------------+
-| `v3.0.0 <https://grscheller.github.io/pythonic-fp-booleans/release/html/>`_          | 2026-01-12   |
+| `v4.0.0 <https://grscheller.github.io/pythonic-fp-booleans/release/html/>`_          | 2026-05-18   |
++--------------------------------------------------------------------------------------+--------------+
+| v3.0.2                                                                               | 2026-04-25   |
++--------------------------------------------------------------------------------------+--------------+
+| v3.0.0                                                                               | 2026-01-12   |
 +--------------------------------------------------------------------------------------+--------------+
 | v2.1.0                                                                               | 2025-12-02   |
 +--------------------------------------------------------------------------------------+--------------+

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/pyproject.toml

@@ -1,10 +1,15 @@
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
 [project]
 name = "pythonic-fp-booleans"
-version = "3.0.1"
+version = "4.0.0"
 readme = "README.rst"
 requires-python = ">=3.13"
-license = { file = "LICENSE" }
-authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+authors = [
+  { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
 keywords = [
   "booleans",
   "subtypable",
@@ -15,7 +20,7 @@ classifiers = [
   "Intended Audience :: Developers",
   "License :: OSI Approved :: Apache Software License",
   "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Typing :: Typed",
 ]
 dependencies = [
@@ -25,8 +30,8 @@ dynamic = ["description"]
 
 [project.urls]
 Changelog = "https://github.com/grscheller/pythonic-fp-booleans/blob/main/CHANGELOG.rst"
-Documentation = "https://grscheller.github.io/pythonic-fp/booleans/development/build/html/"
-Homepage = "https://grscheller.github.io/pythonic-fp/homepage/build/html/"
+Documentation = "https://grscheller.github.io/pythonic-fp/projects/booleans.html"
+Homepage = "https://grscheller.github.io/pythonic-fp/"
 Source = "https://github.com/grscheller/pythonic-fp-booleans"
 
 [project.optional-dependencies]
@@ -34,10 +39,6 @@ test = [
   "pytest>=8.4.1",
 ]
 
-[build-system]
-requires = ["flit_core>=3.12,<4"]
-build-backend = "flit_core.buildapi"
-
 [tool.flit.module]
 name = "pythonic_fp.booleans"
 
@@ -56,13 +57,15 @@ dmypy = false
 strict = true
 report_progress = true
 
-[tool.pytest.ini_options]
-addopts = "-ra"
+[tool.pytest]
+addopts = [
+  "-ra",
+]
 consider_namespace_packages = true
 testpaths = ["tests/"]
 
 [tool.ruff]
-target-version = "py313"
+target-version = "py314"
 
 [tool.ruff.lint.flake8-quotes]
 docstring-quotes = "double"

{pythonic_fp_booleans-3.0.1 → pythonic_fp_booleans-4.0.0}/src/pythonic_fp/booleans/__init__.py

@@ -13,28 +13,15 @@
 # limitations under the License.
 
 """
-Subtypable Boolean Class Hierarchy
-----------------------------------
+Booleans
+========
 
-.. graphviz::
+.. admonition:: Subtypable/subtyped Boolean like classes
 
-    digraph Booleans {
-        bgcolor="#957fb8";
-        node [style=filled, fillcolor="#181616", fontcolor="#dcd7ba"];
-        edge [color="#181616", fontcolor="#dcd7ba"];
-        int -> bool;
-        int -> SBool;
-        SBool -> "FBool(h1)";
-        SBool -> "FBool(h2)";
-        SBool -> "FBool(h3)";
-        SBool -> TF_Bool;
-        TF_Bool -> T_Bool;
-        TF_Bool -> F_Bool;
-    }
-
-While still compatible with Python shortcut logic, ``SBool`` and its
-subclasses can be non-shortcut logically composed with Python's bitwise
-operators.
+    - Like Python's builtin  ``bool``, ``SBool`` and its subclasses
+      are threadsafe singletons.
+    - While still compatible with Python shortcut logic, these can be
+      non-shortcut logically composed with Python's bitwise operators.
 
 """