dtools.fp 1.3.0__tar.gz

dtools_fp-1.3.0/CHANGELOG.md

@@ -0,0 +1,143 @@
+# CHANGELOG
+
+PyPI dtools.fp project.
+
+#### Semantic versioning
+
+* first digit - major event, epoch, or paradigm shift
+* second digit - breaking API changes, major changes
+* third digit - bug fixes, API additions, breaking API in dev env
+* forth digit - commit count changes/regressions (dev environment only)
+
+## Releases and Important Milestones
+
+### Version 1.2.0 - PyPI release date 01-04-25
+
+* added modules lazy and state
+* simplifications done to fp.iterables module
+* renamed flatmap methods to bind
+* minor MB and XOR updates/corrections
+
+### Version 1.1.0 - PyPI release date 11-18-24
+
+* added fp.function module
+  * combine and partially apply functions as first class objects
+  * some tests may be lacking
+
+### Version 1.0.2.0 - Commit date 2024-10-20
+
+* 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
+
+### Version 1.0.1 - PyPI release date 2024-10-20
+
+* removed docs from repo
+* docs for all grscheller namespace projects maintained here
+  * https://grscheller.github.io/grscheller-pypi-namespace-docs/
+
+### Version 1.0.0 - PyPI Release: 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
+
+### Version 0.4.0 - PyPI Release: 2024-10-03
+
+* long overdue PyPI release
+
+### Version 0.3.5.1 - Commit Date: 2024-10-03
+
+* 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
+
+### Version 0.3.4.0 - Commit Date: 2024-09-30
+
+* API change for fp.iterables
+  * function name changes
+    * `foldL`, `foldR`, `foldLsc`, `foldRsc`
+    * `sc` stands for "short circuit"
+  * all now return class woException.MB
+
+### Version 0.3.3.7 - Commit Date: 2024-09-22
+
+* added more functions to fp.iterables module
+  * take(it: Iterable[D], n: int) -> Iterator[D]
+  * takeWhile(it: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]
+  * drop(it: Iterable[D], n: int) -> Iterator[D]
+  * dropWhile(it: Iterable[D], pred: Callable[[D], bool]) -> Iterator[D]
+
+### Version 0.3.3.4 - Commit Date: 2024-09-16
+
+* fp.iterables `foldL_sc` & `foldR_sc` now have
+  * common paradigm
+  * similar signatures
+
+### Version 0.3.3.3 - Commit Date: 2024-09-15
+
+* added fp.iterables function `foldR_sc`
+  * shortcut version of `foldR`
+  * not fully tested
+  * docstring not updated
+
+### Version 0.3.3.2 - Commit Date: 2024-09-14
+
+* added fp.iterables function `foldL_sc`
+  * shortcut version of foldL
+
+### Version 0.3.3 - PyPI Release: 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]:
+
+### Version 0.3.1 - PyPI Release: 2024-08-20
+
+* fp.iterables no longer exports `CONCAT`, `MERGE`, `EXHAUST`
+  * for grscheller.datastructures
+    * grscheller.datastructures.ftuple
+    * grscheller.datastructures.split\_ends
+
+### Version 0.3.0 - PyPI Release: 2024-08-17
+
+* class Nothing re-added but renamed class Nada
+  * version grscheller.untyped.nothing for more strictly typed code
+
+### Version 0.2.1 - PyPI Release: 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
+
+### Version 0.2.0 - PyPI Release: 2024-07-26
+
+* from last PyPI release
+  * added accumulate function to fp.iterators
+  * 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
+* overall much better docstrings
+
+### Version 0.1.0 - Initial PyPI Release: 2024-07-11
+
+* replicated functionality from grscheller.datastructures
+  * grscheller.datastructures.fp.MB  -> grscheller.fp.wo\_exception.MB
+  * grscheller.datastructures.fp.XOR -> grscheller.fp.wo\_exception.XOR
+  * grscheller.core.iterlib          -> grscheller.fp.iterators

dtools_fp-1.3.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

dtools_fp-1.3.0/PKG-INFO

@@ -0,0 +1,58 @@
+Metadata-Version: 2.3
+Name: dtools.fp
+Version: 1.3.0
+Summary: ### Package dtools.fp - Pythonic Functional Programming
+Keywords: functional,functional programming,fp,monad,iterators,maybe,either,lazy,non-strict
+Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+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: Typing :: Typed
+Requires-Dist: pytest >=8.3 ; extra == "test"
+Requires-Dist: dtools.circular-array >=3.9.0, < 3.10 ; extra == "test"
+Requires-Dist: dtools.datastructures >=0.25.0, < 0.26 ; extra == "test"
+Project-URL: Changelog, https://github.com/grscheller/dtools-fp/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://grscheller.github.io/dtools-docs/fp
+Project-URL: Source, https://github.com/grscheller/dtools-fp
+Provides-Extra: test
+
+# Python Functional Programming (FP)
+
+Functional programming tools which endeavor to be Pythonic.
+
+* **Repositories**
+  * [dtools.fp][1] project on *PyPI*
+  * [Source code][2] on *GitHub*
+* Detailed documentation for dtools.fp
+  * [Detailed API documentation][3] on *GH-Pages*
+
+### Modules
+
+* grscheller.fp.iterables
+  * iteration tools implemented in Python
+* grscheller.fp.nothingness
+  * singleton classes representing either a
+    * missing value
+    * sentinel value
+    * failed calculation
+* grscheller.fp.err\_handling
+  * monadic tools for handling missing values & unexpected events
+
+### Benefits of FP
+
+* improved composability
+* avoid exception driven code paths
+* data sharing becomes trivial due to immutability
+
+---
+
+[1]: https://pypi.org/project/dtools.fp/
+[2]: https://github.com/grscheller/dtools-fp/
+[3]: https://grscheller.github.io/dtools-docs/fp/
+
+

dtools_fp-1.3.0/README.md

@@ -0,0 +1,34 @@
+# Python Functional Programming (FP)
+
+Functional programming tools which endeavor to be Pythonic.
+
+* **Repositories**
+  * [dtools.fp][1] project on *PyPI*
+  * [Source code][2] on *GitHub*
+* Detailed documentation for dtools.fp
+  * [Detailed API documentation][3] on *GH-Pages*
+
+### Modules
+
+* grscheller.fp.iterables
+  * iteration tools implemented in Python
+* grscheller.fp.nothingness
+  * singleton classes representing either a
+    * missing value
+    * sentinel value
+    * failed calculation
+* grscheller.fp.err\_handling
+  * monadic tools for handling missing values & unexpected events
+
+### Benefits of FP
+
+* improved composability
+* avoid exception driven code paths
+* data sharing becomes trivial due to immutability
+
+---
+
+[1]: https://pypi.org/project/dtools.fp/
+[2]: https://github.com/grscheller/dtools-fp/
+[3]: https://grscheller.github.io/dtools-docs/fp/
+

dtools_fp-1.3.0/pyproject.toml

@@ -0,0 +1,74 @@
+[build-system]
+requires = ["flit_core>=3.4,<4"]
+build-backend = "flit_core.buildapi"
+
+[project]
+name = "dtools.fp"
+authors = [
+    { name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" },
+]
+license = { file = "LICENSE" }
+readme = "README.md"
+requires-python = ">=3.12"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed"
+]
+dependencies = []
+dynamic = ["version", "description"]
+keywords = [
+    "functional", "functional programming", "fp",
+    "monad", "iterators",
+    "maybe", "either",
+    "lazy", "non-strict"
+]
+
+[project.optional-dependencies]
+test = [
+    "pytest >=8.3",
+    "dtools.circular-array >=3.9.0, < 3.10",
+    "dtools.datastructures >=0.25.0, < 0.26"
+]
+
+[project.urls]
+Source = "https://github.com/grscheller/dtools-fp"
+Changelog = "https://github.com/grscheller/dtools-fp/blob/main/CHANGELOG.md"
+Documentation = "https://grscheller.github.io/dtools-docs/fp"
+
+[tool.flit.sdist]
+exclude = ["dist", "docs", ".gitignore", ".mypy_cache"]
+
+[tool.pylsp-mypy]
+enabled = true
+live-mode = true
+strict = true
+report_progress = true
+
+[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.pytest.ini_options]
+testpaths = ["tests"]
+consider_namespace_packages = true
+
+[tool.ruff]
+target-version = "py313"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.format]
+quote-style = "single"
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"

dtools_fp-1.3.0/src/dtools/fp/__init__.py

@@ -0,0 +1,34 @@
+# 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.
+
+"""### Package dtools.fp - Pythonic Functional Programming
+
+Tools to aid with functional programming in Python yet still endeavoring to
+remain Pythonic.
+
+#### Modules and sub-packages
+
+* module dtools.fp.err_handling: monadic maybe and either
+* module dtools.fp.functions: tools combine and partially apply functions
+* module dtools.fp.iterables: tools for iterables
+* module dtools.fp.lazy: lazy (non-strict) function evaluation
+* module dtools.fp.singletons: useful types with but one instance
+* module dtools.fp.state: handle state monadically
+
+"""
+__version__ = "1.3.0"
+__author__ = "Geoffrey R. Scheller"
+__copyright__ = "Copyright (c) 2023-2025 Geoffrey R. Scheller"
+__license__ = "Apache License 2.0"
+