pythonic-fp-fptools 5.0.0__tar.gz

pythonic_fp_fptools-5.0.0/.gitignore

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

pythonic_fp_fptools-5.0.0/CHANGELOG.rst

@@ -0,0 +1,245 @@
+CHANGELOG
+=========
+
+PyPI pythonic-fp.fptools 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
+---------------------------------
+
+5.0.0 - TBD
+~~~~~~~~~~~~~~~~~~
+
+Coordinated entire project pythonic-fp PyPI deployment.
+
+- moved maybe.py and xor.py from containers, renamed xor.py -> either.py.
+
+4.0.0 - 2025-07-13
+~~~~~~~~~~~~~~~~~~
+
+Dropped developer status to Beta
+
+- Development Status :: 4 - Beta
+- planning to shuffle packages around a bit
+
+TODO: After next Boring Math (bm) deployment, I should be able to archive
+my dtools namespace repos
+
+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.
+
+2.0.0 - 2025-05-22
+~~~~~~~~~~~~~~~~~~
+
+- Moved dtools.fp.err_handling to the dtools.containers PyPI project
+
+  - Moved class MayBe -> module dtools.containers.maybe
+  - Moved class Xor -> module dtools.containers.xor
+  - dropped lazy methods
+
+    - will import dtools.fp.lazy directly for this functionality
+
+1.7.0 - 2025-04-22
+~~~~~~~~~~~~~~~~~~
+
+Last PyPI release as dtools.fp
+
+- API changes along the lines of dtools.ca 3.12
+- typing improvements
+- docstring changes
+- pyproject.toml standardization
+
+1.6.1.0 - 2025-04-17
+~~~~~~~~~~~~~~~~~~~~
+
+- MB.sequence and XOR.sequence now return a wrapped iterator
+
+  - to get a MB or XOR of the container
+
+    - MB.sequence(list_of_mb).map(list)
+    - XOR.sequence(ca_of_mb).map(CA)
+
+  - eliminates runtime polymorphism
+  - TODO: don't force a full evaluation
+
+- Also noticed MB and XOR still have camelCase APIs
+
+1.6.0 - 2025-04-07
+~~~~~~~~~~~~~~~~~~
+
+- typing improvements
+
+1.4.0 - 2025-03-16
+~~~~~~~~~~~~~~~~~~
+
+- added two state changing methods to dtools.err_handling.MB
+
+  - added put method to MB class
+
+    - if MB is empty, injects a value into it
+    - otherwise, do nothing
+
+  - added pop method to MB class
+
+    - if MB is not empty, remove the value and return it
+    - otherwise, raise ValueError
+
+  - found both methods useful to treat a MB just as a container
+
+    - avoid using these methods in pure code
+
+1.3.1 - 2025-02-05
+~~~~~~~~~~~~~~~~~~
+
+- added class method sequence to class State
+
+1.3.0 - 2025-01-17
+~~~~~~~~~~~~~~~~~~
+
+First release as dtools.fp
+
+Repo name changes.
+
+- GitHub: fp -> dtools-fp
+- PyPI: grscheller.fp -> dtools.fp
+
+1.2.0 - 2025-01-04
+~~~~~~~~~~~~~~~~~~
+
+- added modules lazy and state
+- renamed flatmap methods to bind
+- minor MB and XOR updates/corrections
+
+1.1.0 - 2024-11-18
+~~~~~~~~~~~~~~~~~~
+
+Added fp.function module.
+
+- combine and partially apply functions as first class objects
+- some tests may be lacking
+
+1.0.2.0 - 2024-10-20
+~~~~~~~~~~~~~~~~~~~~
+
+Development environment only.
+
+- breaking API changes, next PyPI release will be 1.1.0.
+- renamed module ``nothingness`` to ``singletons``
+ 
+  - split class NoValue into class NoValue and Sentinel
+   
+    - ``noValue`` represents a missing value
+    - ``_sentinel`` is intended to provide a "private" sentinel value
+     
+      - frees up ``None`` and ``()`` for application use
+      - avoids name collisions with user code
+      - will be used in grscheller.datastructures
+       
+- will redo docs in docs repo
+
+1.0.1 - 2024-10-20
+~~~~~~~~~~~~~~~~~~
+
+- removed docs from repo
+- docs for all grscheller namespace projects maintained here
+ 
+  - https://grscheller.github.io/grscheller-pypi-namespace-docs/
+
+1.0.0 - 2024-10-18
+~~~~~~~~~~~~~~~~~~
+
+Decided to make this release first stable release.
+
+- renamed module fp.woException to fp.err_handling
+ 
+  - better captures module's use case
+   
+- pytest improvements based on pytest documentation
+
+0.4.0 - 2024-10-03
+~~~~~~~~~~~~~~~~~~
+
+Long overdue PyPI release.
+
+0.3.5.1 - 2024-10-03
+~~~~~~~~~~~~~~~~~~~~
+
+Development environment only.
+
+- New module ``grscheller.fp.nothingness`` for
+
+  - Singleton ``noValue`` representing a missing value
+
+    - similar to ``None`` but while
+
+      - ``None`` represent "returned no values"
+      - ``noValue: _NoValue = _NoValue()`` represents an absent value
+
+    - mostly used as an implementation detail
+
+      - allows client code to use ``None`` as a sentinel value
+
+    - prefer class ``MB`` to represent a missing value in client code
+
+0.3.3 - 2024-08-25
+~~~~~~~~~~~~~~~~~~
+
+- removed woException ``XOR`` method
+
+  - ``getDefaultRight(self) -> R``:
+
+- added methods
+
+  - makeRight(self, right: R|Nada=nada) -> XOR\[L, R\]:
+  - swapRight(self, right: R) -> XOR\[L, R\]:
+
+0.3.0 - 2024-08-17
+~~~~~~~~~~~~~~~~~~
+
+Class Nothing re-added but renamed class Nada.
+
+Version grscheller.untyped.nothing for more strictly typed code.
+
+0.2.1 - 2024-07-26
+~~~~~~~~~~~~~~~~~~
+
+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
+
+0.2.0 - 2024-07-26
+~~~~~~~~~~~~~~~~~~
+
+- from last PyPI release
+
+  - new fp.nothing module implementing nothing: Nothing singleton
+
+    - represents a missing value
+    - better "bottom" type than either None or ()
+
+  - renamed ``fp.wo_exception`` to ``fp.woException``
+
+0.1.0 - 2024-07-11
+~~~~~~~~~~~~~~~~~~
+
+Initial PyPI release as grscheller.fp
+
+Replicated functionality from grscheller.datastructures.
+
+- ``grscheller.datastructures.fp.MB -> grscheller.fp.wo_exception.MB``
+- ``grscheller.datastructures.fp.XOR -> grscheller.fp.wo_exception.XOR``

pythonic_fp_fptools-5.0.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_fptools-5.0.0/PKG-INFO

@@ -0,0 +1,67 @@
+Metadata-Version: 2.4
+Name: pythonic-fp-fptools
+Version: 5.0.0
+Summary: Pythonic FP - 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
+Description-Content-Type: text/x-rst
+Classifier: Development Status :: 4 - Beta
+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-circulararray>=5.3.0
+Requires-Dist: pythonic-fp-singletons>=1.0.0
+Requires-Dist: pytest>=8.4.1 ; extra == "test"
+Requires-Dist: pythonic-fp-containers>=3.0.0 ; 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/releases.html
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-fptools
+Provides-Extra: test
+
+Pythonic FP - Functional tools
+==============================
+
+PyPI project
+`pythonic-fp.fptools
+<https://pypi.org/project/pythonic-fp.fptools>`_.
+
+Tools to aid with functional programming in Python yet still endeavoring to
+remain Pythonic.
+
+- Functions as first class objects
+- Lazy (non-strict) function evaluation
+- Maybe monad - representing a possible missing value
+- Either monad - left bias either monad representing either a LEFT or RIGHT value
+- State monad implementation
+
+  - pure FP handling of state (the state monad)
+  - Classic FP implementation
+
+    - the monad encapsulates a state transformation, not a "state"
+
+This PyPI project is part of of the grscheller
+`pythonic-fp namespace projects
+<https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+**Warning:** The maintainer intends to break out the first, forth and
+fifth modules to their own repos sometime in the near future.
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/fptools/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.
+

pythonic_fp_fptools-5.0.0/README.rst

@@ -0,0 +1,40 @@
+Pythonic FP - Functional tools
+==============================
+
+PyPI project
+`pythonic-fp.fptools
+<https://pypi.org/project/pythonic-fp.fptools>`_.
+
+Tools to aid with functional programming in Python yet still endeavoring to
+remain Pythonic.
+
+- Functions as first class objects
+- Lazy (non-strict) function evaluation
+- Maybe monad - representing a possible missing value
+- Either monad - left bias either monad representing either a LEFT or RIGHT value
+- State monad implementation
+
+  - pure FP handling of state (the state monad)
+  - Classic FP implementation
+
+    - the monad encapsulates a state transformation, not a "state"
+
+This PyPI project is part of of the grscheller
+`pythonic-fp namespace projects
+<https://github.com/grscheller/pythonic-fp/blob/main/README.md>`_
+
+**Warning:** The maintainer intends to break out the first, forth and
+fifth modules to their own repos sometime in the near future.
+
+Documentation
+-------------
+
+Documentation for this project is hosted on
+`GitHub Pages
+<https://grscheller.github.io/pythonic-fp/fptools/development/build/html>`_.
+
+Copyright and License
+---------------------
+
+Copyright (c) 2023-2025 Geoffrey R. Scheller. Licensed under the Apache
+License, Version 2.0. See the LICENSE file for details.

pythonic_fp_fptools-5.0.0/pyproject.toml

@@ -0,0 +1,80 @@
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "pythonic-fp-fptools"
+version = "5.0.0"
+readme = "README.rst"
+requires-python = ">=3.12"
+license = { file = "LICENSE" }
+authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+keywords = [
+  "either",
+  "fp",
+  "functional",
+  "functional programming",
+  "lazy",
+  "maybe",
+  "monad",
+  "non-strict",
+]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "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-circulararray>=5.3.0",
+  "pythonic-fp-singletons>=1.0.0",
+]
+dynamic = ["description"]
+
+[project.optional-dependencies]
+test = [
+  "pytest>=8.4.1",
+  "pythonic-fp-containers>=3.0.0",
+]
+
+[project.urls]
+Changelog = "https://github.com/grscheller/pythonic-fp-fptools/blob/main/CHANGELOG.rst"
+Documentation = "https://grscheller.github.io/pythonic-fp/fptools/development/build/html/releases.html"
+Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Source = "https://github.com/grscheller/pythonic-fp-fptools"
+
+[tool.flit.module]
+name = "pythonic_fp.fptools"
+
+[tool.mypy]
+enable_incomplete_feature = ["NewGenericSyntax"]
+implicit_reexport = false
+local_partial_types = true
+warn_redundant_casts = true
+warn_return_any = true
+warn_unused_configs = true
+
+[tool.pylsp-mypy]
+enabled = true
+live-mode = true
+strict = true
+report_progress = true
+
+[tool.pytest.ini_options]
+consider_namespace_packages = true
+testpaths = ["tests/"]
+addopts = "-ra"
+
+[tool.ruff]
+target-version = "py313"
+ignore = ["E741"]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-line-length = 72

pythonic_fp_fptools-5.0.0/src/pythonic_fp/fptools/__init__.py

@@ -0,0 +1,38 @@
+# 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.
+
+"""Pythonic FP - Functional Programming Tools
+
+Functions as first class objects, Lazy (non-strict) function evaluation,
+and classical Functional Programming data structures.
+
++--------------------------+------------------------------+
+| Description              | Module                       |
++==========================+==============================+
+| Function manipulation    | pythonic_fp.fptools.function |
++--------------------------+------------------------------+
+| Lazy function evaluation | pythonic_fp.fptools.lazy     |
++--------------------------+------------------------------+
+| Maybe monad              | pythonic_fp.fptools.maybe    |
++--------------------------+------------------------------+
+| Either monad             | pythonic_fp.fptools.either   |
++--------------------------+------------------------------+
+| State monad              | pythonic_fp.fptools.state    |
++--------------------------+------------------------------+
+
+"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'