pythonic-fp.containers 2.0.0__tar.gz

pythonic_fp_containers-2.0.0/.github/workflows/static.yml

@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload docs/build directory
+          path: './docs/build'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

pythonic_fp_containers-2.0.0/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright (c) 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_containers-2.0.0/PKG-INFO

@@ -0,0 +1,50 @@
+Metadata-Version: 2.4
+Name: pythonic-fp.containers
+Version: 2.0.0
+Summary: Developer Tools - Container-like data structures
+Keywords: boxes,functional_tuple,immutable_list,maybe
+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
+License-File: LICENSE
+Requires-Dist: pythonic-fp.fptools >=3.0.0
+Requires-Dist: pythonic-fp.iterables >=3.0.0
+Project-URL: Changelog, https://grscheller.github.io/pythonic-fp-containers/html/changelog.html
+Project-URL: Documentation, https://grscheller.github.io/pythonic-fp-containers/html/
+Project-URL: Homepage, https://github.com/grscheller/pythonic-fp/blob/main/README.md
+Project-URL: Source, https://github.com/grscheller/pythonic-fp-containers
+
+# Pythonic FP - Containers
+
+PyPI project
+[pythonic-fp.containers](https://pypi.org/project/pythonic-fp.containers/)
+implements a Python package of container like data structures.
+
+| Description | Module |
+|:----------- |:----------- |
+| Single item box | *module* `pythonic_fp.containers.box` |
+| Functional tuple | *module* `pythonic_fp.containers.functional_tuple` |
+| Immutable list | *module* `pythonic_fp.containers.immutable_list` |
+| Maybe monad | *module* `pythonic_fp.containers.maybe` |
+| Either monad | *module* `pythonic_fp.containers.xor` |
+
+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 hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp-containers/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_containers-2.0.0/README.md

@@ -0,0 +1,26 @@
+# Pythonic FP - Containers
+
+PyPI project
+[pythonic-fp.containers](https://pypi.org/project/pythonic-fp.containers/)
+implements a Python package of container like data structures.
+
+| Description | Module |
+|:----------- |:----------- |
+| Single item box | *module* `pythonic_fp.containers.box` |
+| Functional tuple | *module* `pythonic_fp.containers.functional_tuple` |
+| Immutable list | *module* `pythonic_fp.containers.immutable_list` |
+| Maybe monad | *module* `pythonic_fp.containers.maybe` |
+| Either monad | *module* `pythonic_fp.containers.xor` |
+
+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 hosted on
+[GitHub Pages](https://grscheller.github.io/pythonic-fp-containers/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_containers-2.0.0/pyproject.toml

@@ -0,0 +1,75 @@
+[project]
+name = "pythonic-fp.containers"
+version = "2.0.0"
+readme = "README.md"
+requires-python = ">=3.12"
+license = { file = "LICENSE" }
+authors = [{ name = "Geoffrey R. Scheller", email = "geoffrey@scheller.com" }]
+keywords = ["boxes", "functional_tuple", "immutable_list", "maybe"]
+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 = [
+  "pythonic-fp.fptools >=3.0.0",
+  "pythonic-fp.iterables >=3.0.0",
+]
+dynamic = ["description"]
+
+[project.urls]
+Changelog = "https://grscheller.github.io/pythonic-fp-containers/html/changelog.html"
+Documentation = "https://grscheller.github.io/pythonic-fp-containers/html/"
+Homepage = "https://github.com/grscheller/pythonic-fp/blob/main/README.md"
+Source = "https://github.com/grscheller/pythonic-fp-containers"
+
+[build-system]
+requires = ["flit_core>=3.12,<4"]
+build-backend = "flit_core.buildapi"
+
+[tool.flit.sdist]
+exclude = ["dist", "docs", "tests", ".gitignore", ".mypy_cache", ".pytest_cache"]
+
+[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]
+python_path = [
+  "/home/grs/devel/pypi/fptools/pythonic-fp-containers/src",
+  "/home/grs/devel/pypi/fptools/pythonic-fp-fptools/src",
+  "/home/grs/devel/pypi/fptools/pythonic-fp-iterables/src",
+]
+
+[tool.pylsp-mypy]
+enabled = true
+live-mode = true
+strict = true
+report_progress = true
+exclude = ["tests/.*"]
+
+[tool.pytest.ini_options]
+consider_namespace_packages = true
+testpaths = ["tests"]
+addopts = "-ra"
+
+[tool.ruff]
+target-version = "py313"
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["F401"]
+
+[tool.ruff.lint.flake8-quotes]
+docstring-quotes = "double"
+
+[tool.ruff.format]
+quote-style = "single"
+docstring-code-line-length = 72

pythonic_fp_containers-2.0.0/src/pythonic_fp/containers/__init__.py

@@ -0,0 +1,19 @@
+# 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.
+
+"""Developer Tools - Container-like data structures"""
+
+__author__ = 'Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__license__ = 'Apache License 2.0'

pythonic_fp_containers-2.0.0/src/pythonic_fp/containers/box.py

@@ -0,0 +1,159 @@
+# 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.
+
+"""Stateful container holds at most one item of a given type."""
+
+from __future__ import annotations
+
+__all__ = ['Box']
+
+from collections.abc import Callable, Iterator
+from typing import cast, Final, Never, overload, TypeVar
+from pythonic_fp.fptools.singletons import Sentinel
+
+D = TypeVar('D')
+
+_sentinel: Final[Sentinel] = Sentinel('Box')
+
+class Box[D]:
+    """Container holding at most one item of a given type
+
+    - where ``Box(item)`` contains at most one item of type ``~D``
+
+      - ``Box()`` creates an empty container
+      - can store any item of any type, including ``None``
+    """
+
+    __slots__ = ('_item',)
+    __match_args__ = ('_item',)
+
+    T = TypeVar('T')
+
+    @overload
+    def __init__(self) -> None: ...
+    @overload
+    def __init__(self, value: D) -> None: ...
+
+    def __init__(self, value: D | Sentinel = Sentinel('Box')) -> None:
+        """Initialize Box with an "optional" initial value.
+
+           :param value: "optional" initial value
+           :type value: ~D
+        """
+        self._item: D | Sentinel = value
+
+    def __bool__(self) -> bool:
+        return self._item is not Sentinel('Box')
+
+    def __iter__(self) -> Iterator[D]:
+        if self:
+            yield cast(D, self._item)
+
+    def __repr__(self) -> str:
+        if self:
+            return 'Box(' + repr(self._item) + ')'
+        return 'Box()'
+
+    def __len__(self) -> int:
+        return 1 if self else 0
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self._item is other._item:
+            return True
+        if self._item == other._item:
+            return True
+        return False
+
+    @overload
+    def get(self) -> D | Never: ...
+    @overload
+    def get(self, alt: D) -> D: ...
+    @overload
+    def get(self, alt: Sentinel) -> D | Never: ...
+
+    def get(self, alt: D | Sentinel = Sentinel('Box')) -> D | Never:
+        """Return the contained value if it exists, otherwise an alternate value.
+
+        :rtype: ~D 
+        :raises ValueError: when an alternate value is not provided but needed
+        """
+        if self._item is not _sentinel:
+            return cast(D, self._item)
+        if alt is _sentinel:
+            msg = 'Box: get from empty Box with no alt return value provided'
+            raise ValueError(msg)
+        return cast(D, alt)
+
+    def pop(self) -> D | Never:
+        """Pop the value if Box is not empty.
+
+        :rtype: ~D
+        :raises ValueError: if box is empty
+        """
+        if self._item is _sentinel:
+            msg = 'Box: Trying to pop an item from an empty Box'
+            raise ValueError(msg)
+        popped = cast(D, self._item)
+        self._item = _sentinel
+        return popped
+
+    def push(self, item: D) -> None | Never:
+        """Push an item in an empty Box.
+
+        :raises ValueError: if box is not empty
+        """
+        if self._item is Sentinel('Box'):
+            self._item = item
+        else:
+            msg = 'Box: Trying to push an item in an empty Box'
+            raise ValueError(msg)
+        return None
+
+    def put(self, item: D) -> None:
+        """Put an item in the Box. Discard any previous contents."""
+        self._item = item
+
+    def exchange(self, new_item: D) -> D | Never:
+        """Exchange an item with what is in the Box.
+
+        :rtype: ~D
+        :raises ValueError: if box is empty
+        """
+        if self._item is _sentinel:
+            msg = 'Box: Trying to exchange items using an empty Box'
+            raise ValueError(msg)
+        popped = cast(D, self._item)
+        self._item = new_item
+        return popped
+
+    def map[T](self, f: Callable[[D], T]) -> Box[T]:
+        """Map function ``f`` over contents.
+
+        :return: a new instance
+        """
+        if self._item is Sentinel('Box'):
+            return Box()
+        return Box(f(cast(D, self._item)))
+
+    def bind[T](self, f: Callable[[D], Box[T]]) -> Box[T]:
+        """Flatmap ``Box`` with function ``f``.
+
+        :return: a new instance
+        """
+        if self._item is _sentinel:
+            return Box()
+        return f(cast(D, self._item))