pythonic-fp-booleans 1.1.0__tar.gz

pythonic_fp_booleans-1.1.0/.gitignore

@@ -0,0 +1,7 @@
+# Minimal version - only add to when necessary
+**/__pycache__/
+dist/
+**/.dmypy.json
+**/.mypy_cache/
+**/.pytest_cache/
+**/.ruff_cache

pythonic_fp_booleans-1.1.0/CHANGELOG.rst

@@ -0,0 +1,39 @@
+CHANGELOG
+=========
+
+PyPI pythonic-fp-booleans project.
+
+Semantic Versioning
+-------------------
+
+Strict 3 digit semantic versioning adopted 2025-05-19.
+
+- **MAJOR** version incremented for incompatible API changes
+- **MINOR** version incremented for backward compatible added functionality
+- **PATCH** version incremented for backward compatible bug fixes
+
+See `Semantic Versioning 2.0.0 <https://semver.org>`_.
+
+Releases and Important Milestones
+---------------------------------
+
+PyPI v1.1.0 - 2025-09-02
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+First PyPI release.
+
+- module booleans.subtypable
+- package booleans.subtypes
+
+  - module booleans.subtypes.flavored
+  - module booleans.subtypes.truthy_falsy
+
+Needs
+
+-  "pythonic-fp>=3.0.0" for gadgets
+-  "pythonic-fp-sentinels>=2.1.0",
+
+Created pythonic-fp-boolean GitHub repo - 2025-08-06
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Moved pythonic_fp.singletons.sbool -> pythonic_fp.booleans.sbool

pythonic_fp_booleans-1.1.0/LICENSE

@@ -0,0 +1,176 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

pythonic_fp_booleans-1.1.0/PKG-INFO

@@ -0,0 +1,54 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-booleans
+Version: 1.1.0
+Summary: Subtypable Boolean like classes
+Keywords: boolean,inheritable
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.13
+Description-Content-Type: text/x-rst
+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: Typing :: Typed
+License-File: LICENSE
+Requires-Dist: pythonic-fp-gadgets>=3.0.0
+Requires-Dist: pythonic-fp-sentinels>=2.1.0
+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/releases.html
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-booleans
+Provides-Extra: test
+
+Pythonic FP - Booleans
+======================
+
+PyPI project
+`pythonic-fp-booleans
+<https://pypi.org/project/pythonic-fp-booleans>`_.
+
+Library of simple, but useful, data structures with minimal dependencies.
+
+- single item box
+- function returning iterator of its arguments
+
+This PyPI project is part of of the grscheller
+`pythonic-fp namespace projects
+<https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/gadgets/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_booleans-1.1.0/README.rst

@@ -0,0 +1,28 @@
+Pythonic FP - Booleans
+======================
+
+PyPI project
+`pythonic-fp-booleans
+<https://pypi.org/project/pythonic-fp-booleans>`_.
+
+Library of simple, but useful, data structures with minimal dependencies.
+
+- single item box
+- function returning iterator of its arguments
+
+This PyPI project is part of of the grscheller
+`pythonic-fp namespace projects
+<https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/gadgets/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.

pythonic_fp_booleans-1.1.0/pyproject.toml

@@ -0,0 +1,79 @@
+[project]
+name = "pythonic-fp-booleans"
+version = "1.1.0"
+readme = "README.rst"
+requires-python = ">=3.13"
+license = { file = "LICENSE" }
+authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+keywords = [
+  "boolean",
+  "inheritable",
+]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Framework :: Pytest",
+  "Intended Audience :: Developers",
+  "License :: OSI Approved :: Apache Software License",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+dependencies = [
+  "pythonic-fp-gadgets>=3.0.0",
+  "pythonic-fp-sentinels>=2.1.0",
+]
+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/releases.html"
+Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Source = "https://github.com/grscheller/pythonic-fp-booleans"
+
+[project.optional-dependencies]
+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"
+
+[tool.mypy]
+enable_incomplete_feature = "NewGenericSyntax"
+explicit_package_bases = true
+implicit_reexport = false
+local_partial_types = true
+namespace_packages = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pylsp-mypy]
+enabled = true
+live-mode = true
+dmypy = false
+strict = true
+report_progress = true
+
+[tool.pytest.ini_options]
+addopts = "-ra"
+consider_namespace_packages = true
+testpaths = ["tests/"]
+
+[tool.ruff]
+target-version = "py313"
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["C901"]
+"**/*.py" = ["E741"]
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-line-length = 72

pythonic_fp_booleans-1.1.0/src/pythonic_fp/booleans/__init__.py

@@ -0,0 +1,99 @@
+# Copyright 2023-2025 Geoffrey R. Scheller
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+Subtypable Boolean like classes
+===============================
+
+While still compatible with Python shortcut logic, these classes can
+be non-shortcut logically composed with Python's bitwise operators.
+These classes are implemented with the Singleton Pattern.
+
+Covariant class hierarchy
+-------------------------
+
+.. graphviz::
+
+    digraph Booleans {
+        bgcolor="deepskyblue";
+        int -> bool;
+        int -> SBool;
+        SBool -> "FBool(h1)";
+        SBool -> "FBool(h2)";
+        SBool -> "FBool(h3)";
+        SBool -> TF_Bool;
+        TF_Bool -> T_Bool;
+        TF_Bool -> F_Bool;
+    }
+
+Contravariant non-shortcut "bitwise" operators
+----------------------------------------------
+
++-------------------+--------+------------+
+| Boolean operation | symbol | dunder     |
++===================+========+============+
+|       not         | ``~``  | __invert__ |
++-------------------+--------+------------+
+|       and         | ``&``  | __and__    |
++-------------------+--------+------------+
+|       or          | ``|``  | __or__     |
++-------------------+--------+------------+
+|       xor         | ``^``  | __xor__    |
++-------------------+--------+------------+
+
+These operators are contravariant, that is they will return
+the instance of the latest common ancestor of their arguments.
+More specifically, the instance returned will have the type
+of the least upper bound in the inheritance graph of the classes
+of the two arguments.
+
+.. warning::
+
+   These "bitwise" operators could raise ``TypeError`` exceptions
+   when applied against an ``SBool`` and objects not descended
+   from ``int``.
+
+Classes
+-------
+
+Class SBool
+~~~~~~~~~~~
+
+Base of the hierarchy.
+
+Like Python's built-in ``bool``, ``SBool`` is a subclass of ``int``,
+unlike ``bool``, class ``SBool`` can be further subclassed.
+
+Class FBool
+~~~~~~~~~~~
+
+For when you need to deal with different "flavors" of the truth.
+
+Each "flavor" corresponds to a hashable value. Instances of ``FBool``
+are invariant in their flavor. Best to think of the "flavor" as an
+index.
+
+Class TF_Bool
+~~~~~~~~~~~~~
+
+Class ``TF_Bool`` consists of just two disjoint subclasses, each one
+a singleton.
+
+- class ``T_Bool`` is the  always truthy ``TF_Bool`` subtype
+- class ``F_Bool`` is the  always falsy ``TF_Bool`` subtype
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp_booleans-1.1.0/src/pythonic_fp/booleans/subtypable.py

@@ -0,0 +1,143 @@
+# Copyright 2023-2025 Geoffrey R. Scheller
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""Subtypable Booleans."""
+
+import threading
+from collections.abc import Hashable
+from typing import cast, ClassVar, Final, overload
+from pythonic_fp.gadgets.latest_common_ancestor import lca
+from pythonic_fp.sentinels.novalue import NoValue
+
+__all__ = ['SBool', 'TRUTH', 'LIE']
+
+_novalue = NoValue()
+
+
+class SBool(int):
+    """Subtypable Booleans.
+
+    Like Python's built in bool, class SBool is a subclass of int.
+    Unlike bool, this version can be further subclassed. It can be
+    used with Python ``and`` and ``or`` short-cut logic. The ``not``
+    operator will just return a ``bool``. Use the ``snot`` function
+    to return an ``SBool`` or ``SBool`` subclass.
+
+    This type and its subtypes can also do (non-shortcut) Boolean logic
+    using Python bitwise operators.
+    """
+    _falsy: 'ClassVar[SBool | NoValue]' = _novalue
+    _falsy_lock: ClassVar[threading.Lock] = threading.Lock()
+
+    _truthy: 'ClassVar[SBool | NoValue]' = _novalue
+    _truthy_lock: ClassVar[threading.Lock] = threading.Lock()
+
+    @overload
+    def __new__(cls) -> 'SBool': ...
+    @overload
+    def __new__(cls, witness: object) -> 'SBool': ...
+
+    def __new__(cls, witness: object = False, flavor: Hashable = _novalue) -> 'SBool':
+        """
+        :param witness: Determines truthiness of the ``SBool``.
+        :returns: The truthy or falsy SBool class instance.
+        """
+        if witness:
+            if cls._truthy is _novalue:
+                with cls._truthy_lock:
+                    if cls._truthy is _novalue:
+                        cls._truthy = super().__new__(cls, 1)
+            return cast(SBool, cls._truthy)
+        else:
+            if cls._falsy is _novalue:
+                with cls._falsy_lock:
+                    if cls._falsy is _novalue:
+                        cls._falsy = super().__new__(cls, 0)
+            return cast(SBool, cls._falsy)
+
+    def __init__(self, witness: object = False, flavor: Hashable = _novalue) -> None:
+        self._flavor = flavor
+
+    # override in derived classes
+    def __repr__(self) -> str:
+        if self:
+            return 'TRUTH'
+        return 'LIE'
+
+    def __invert__(self) -> 'SBool':
+        if self:
+            return type(self)(False)
+        return type(self)(True)
+
+    def __and__(self, other: int) -> int:
+        try:
+            base_class = lca(type(self), type(other))
+        except TypeError:
+            if type(other) is bool:
+                base_class = int
+            else:
+                msg = (
+                    f"unsupported operand type(s) for &: '{type(self)}' and '{type(other)}'"
+                )
+                raise TypeError(msg)
+
+        if issubclass(base_class, SBool):
+            if self and other:
+                return base_class(1)
+            return base_class(0)
+        else:
+            return int(self) & int(other)
+
+    def __or__(self, other: int) -> int:
+        try:
+            base_class = lca(type(self), type(other))
+        except TypeError:
+            if type(other) is bool:
+                base_class = int
+            else:
+                msg = (
+                    f"unsupported operand type(s) for |: '{type(self)}' and '{type(other)}'"
+                )
+                raise TypeError(msg)
+
+        if issubclass(base_class, SBool):
+            if self or other:
+                return base_class(1)
+            return base_class(0)
+        else:
+            return int(self) | int(other)
+
+    def __xor__(self, other: int) -> int:
+        try:
+            base_class = lca(type(self), type(other))
+        except TypeError:
+            if type(other) is bool:
+                base_class = int
+            else:
+                msg = (
+                    f"unsupported operand type(s) for ^: '{type(self)}' and '{type(other)}'"
+                )
+                raise TypeError(msg)
+
+        if issubclass(base_class, SBool):
+            if self and not other or other and not self:
+                return base_class(1)
+            return base_class(0)
+        else:
+            return int(self) ^ int(other)
+
+
+TRUTH: Final[SBool] = SBool(True)  #: The truthy singleton of type ``SBool``.
+LIE: Final[SBool] = SBool(False)  #: The falsy singleton of type ``SBool``.

pythonic_fp_booleans-1.1.0/src/pythonic_fp/booleans/subtypable.pyi

@@ -0,0 +1,18 @@
+from collections.abc import Hashable
+from typing import Final, overload
+
+__all__ = ['SBool', 'TRUTH', 'LIE']
+
+class SBool(int):
+    @overload
+    def __new__(cls) -> SBool: ...
+    @overload
+    def __new__(cls, witness: object) -> SBool: ...
+    def __init__(self, witness: object = False, flavor: Hashable = ...) -> None: ...
+    def __invert__(self) -> SBool: ...
+    def __and__(self, other: int) -> int: ...
+    def __or__(self, other: int) -> int: ...
+    def __xor__(self, other: int) -> int: ...
+
+TRUTH: Final[SBool]
+LIE: Final[SBool]