pythonic-fp-fptools 5.0.0__py3-none-any.whl

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'

pythonic_fp/fptools/either.py

@@ -0,0 +1,274 @@
+# 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.
+
+from __future__ import annotations
+
+__all__ = ['Either', 'LEFT', 'RIGHT']
+
+from collections.abc import Callable, Iterator, Sequence
+from typing import cast, Never, overload, TypeVar
+from pythonic_fp.singletons.sbool import SBool, Truth as Left, Lie as Right
+from pythonic_fp.singletons.sentinel import Sentinel as _Sentinel
+from .maybe import MayBe
+
+L = TypeVar('L', covariant=True)
+R = TypeVar('R', covariant=True)
+
+LEFT = Left('LEFT')
+RIGHT = Right('RIGHT')
+
+
+class Either[L, R]:
+    """Either monad, data structure semantically containing either a left
+    or a right value, but not both.
+
+    Implements a left biased Either Monad.
+
+    - `Either(value: +L, LEFT)` produces a left `Either`
+    - `Either(value: +L, RIGHT)` produces a right `Either`
+
+    In a Boolean context
+
+    - `True` if a left `Either`
+    - `False` if a right `Either`
+
+    Two `Either` objects compare as equal when
+
+    - both are left values or both are right values whose values
+
+      - are the same object
+      - compare as equal
+
+    Immutable, an `Either` does not change after being created. Therefore
+    map & bind return new instances
+
+    .. warning::
+
+        The contained value need not be immutable, therefore
+        not hashable if value is mutable.
+
+    .. note::
+
+        ``Either(value: +L, side: Left): Either[+L, +R] -> left: Either[+L, +R]``
+        ``Either(value: +R, side: Right): Either[+L, +R] -> right: Either[+L, +R]``
+
+    """
+    __slots__ = '_value', '_side'
+    __match_args__ = ('_value', '_side')
+
+    U = TypeVar('U', covariant=True)
+    V = TypeVar('V', covariant=True)
+    T = TypeVar('T')
+
+    @overload
+    def __init__(self, value: L, side: Left) -> None: ...
+    @overload
+    def __init__(self, value: R, side: Right) -> None: ...
+
+    def __init__(self, value: L | R, side: SBool = LEFT) -> None:
+        self._value = value
+        self._side = side
+
+    def __hash__(self) -> int:
+        return hash((_Sentinel('XOR'), self._value, self._side))
+
+    def __bool__(self) -> bool:
+        return self._side == LEFT
+
+    def __iter__(self) -> Iterator[L]:
+        if self:
+            yield cast(L, self._value)
+
+    def __repr__(self) -> str:
+        if self:
+            return 'Either(' + repr(self._value) + ', LEFT)'
+        return 'Either(' + repr(self._value) + ', RIGHT)'
+
+    def __str__(self) -> str:
+        if self:
+            return '< ' + str(self._value) + ' | >'
+        return '< | ' + str(self._value) + ' >'
+
+    def __len__(self) -> int:
+        """An Either always contains just one value."""
+        return 1
+
+    def __eq__(self, other: object) -> bool:
+        if not isinstance(other, type(self)):
+            return False
+
+        if self and other:
+            if (self._value is other._value) or (self._value == other._value):
+                return True
+
+        if not self and not other:
+            if (self._value is other._value) or (self._value == other._value):
+                return True
+
+        return False
+
+    def get(self) -> L | Never:
+        """Get value if a left.
+
+        .. warning::
+
+            Unsafe method ``get``. Will raise ``ValueError`` if ``Either``
+            is a right. Best practice is to first check the ``Either`` in
+            a boolean context.
+
+        :return: its value if a Left
+        :rtype: +L
+        :raises ValueError: if not a left
+
+        """
+        if self._side == RIGHT:
+            msg = 'Either: get method called on a right valued Either'
+            raise ValueError(msg)
+        return cast(L, self._value)
+
+    def get_left(self) -> MayBe[L]:
+        """Get value of `Either` if a left. Safer version of `get` method.
+
+        - if `Either` contains a left value, return it wrapped in a MayBe
+        - if `Either` contains a right value, return MayBe()
+
+        """
+        if self._side == LEFT:
+            return MayBe(cast(L, self._value))
+        return MayBe()
+
+    def get_right(self) -> MayBe[R]:
+        """Get value of `Either` if a right
+
+        - if `Either` contains a right value, return it wrapped in a MayBe
+        - if `Either` contains a left value, return MayBe()
+
+        """
+        if self._side == RIGHT:
+            return MayBe(cast(R, self._value))
+        return MayBe()
+
+    def map_right[V](self, f: Callable[[R], V]) -> Either[L, V]:
+        """Construct new Either with a different right."""
+        if self._side == LEFT:
+            return cast(Either[L, V], self)
+        return Either[L, V](f(cast(R, self._value)), RIGHT)
+
+    def map[U](self, f: Callable[[L], U]) -> Either[U, R]:
+        """Map over if a left value. Return new instance."""
+        if self._side == RIGHT:
+            return cast(Either[U, R], self)
+        return Either(f(cast(L, self._value)), LEFT)
+
+    def bind[U](self, f: Callable[[L], Either[U, R]]) -> Either[U, R]:
+        """Flatmap over the left value, propagate right values."""
+        if self:
+            return f(cast(L, self._value))
+        return cast(Either[U, R], self)
+
+    def map_except[U](self, f: Callable[[L], U], fallback_right: R) -> Either[U, R]:
+        """Map over if a left value - with fallback upon exception.
+
+        - if `Either` is a left then map `f` over its value
+
+          - if `f` successful return a left `Either[+U, +R]`
+          - if `f` unsuccessful return right `Either[+U, +R]`
+
+            - swallows many exceptions `f` may throw at run time
+
+        - if `Either` is a right
+
+          - return new `Either(right=self._right): Either[+U, +R]`
+
+        """
+        if self._side == RIGHT:
+            return cast(Either[U, R], self)
+
+        applied: MayBe[Either[U, R]] = MayBe()
+        fall_back: MayBe[Either[U, R]] = MayBe()
+        try:
+            applied = MayBe(Either(f(cast(L, self._value)), LEFT))
+        except (
+            LookupError,
+            ValueError,
+            TypeError,
+            BufferError,
+            ArithmeticError,
+            RecursionError,
+            ReferenceError,
+            RuntimeError,
+        ):
+            fall_back = MayBe(cast(Either[U, R], Either(fallback_right, RIGHT)))
+
+        if fall_back:
+            return fall_back.get()
+        return applied.get()
+
+    def bind_except[U](
+        self, f: Callable[[L], Either[U, R]], fallback_right: R
+    ) -> Either[U, R]:
+        """Flatmap `Either` with function `f` with fallback right
+
+        .. warning::
+            Swallows exceptions.
+
+        :param fallback_right: fallback value if exception thrown
+
+        """
+        if self._side == RIGHT:
+            return cast(Either[U, R], self)
+
+        applied: MayBe[Either[U, R]] = MayBe()
+        fall_back: MayBe[Either[U, R]] = MayBe()
+        try:
+            if self:
+                applied = MayBe(f(cast(L, self._value)))
+        except (
+            LookupError,
+            ValueError,
+            TypeError,
+            BufferError,
+            ArithmeticError,
+            RecursionError,
+            ReferenceError,
+            RuntimeError,
+        ):
+            fall_back = MayBe(cast(Either[U, R], Either(fallback_right, RIGHT)))
+
+        if fall_back:
+            return fall_back.get()
+        return applied.get()
+
+    @staticmethod
+    def sequence[U, V](
+        sequence_xor_uv: Sequence[Either[U, V]],
+    ) -> Either[Sequence[U], V]:
+        """Sequence an indexable of type `Either[~U, ~V]`
+
+        If the iterated `Either` values are all lefts, then return an `Either` of
+        an iterable of the left values. Otherwise return a right Either containing
+        the first right encountered.
+
+        """
+        list_items: list[U] = []
+
+        for xor_uv in sequence_xor_uv:
+            if xor_uv:
+                list_items.append(xor_uv.get())
+            else:
+                return Either(xor_uv.get_right().get(), RIGHT)
+
+        sequence_type = cast(Sequence[U], type(sequence_xor_uv))
+
+        return Either(sequence_type(list_items))  # type: ignore # subclass will be callable

pythonic_fp/fptools/function.py

@@ -0,0 +1,83 @@
+# Copyright 2024-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 - FP tools for functions
+
+Not a replacement for the std library's `functools` which is more about
+modifying function behavior through decorators than functional composition
+and application.
+
+FP utilities to manipulate and partially apply functions
+
+- *function* **swap** - Swap the arguments of a 2 argument function
+- *function* **sequenced** - Convert function to take a sequence of its arguments
+- *function* **negate** - Transforms a predicate to its negation
+- *function* **partial** - Returns a partially applied function
+
+"""
+
+from __future__ import annotations
+from collections.abc import Callable
+from typing import Any, ParamSpec
+
+__all__ = ['swap', 'sequenced', 'partial', 'negate']
+
+P = ParamSpec('P')
+
+
+def swap[U, V, R](f: Callable[[U, V], R]) -> Callable[[V, U], R]:
+    """Swap arguments of a two argument function."""
+    return lambda v, u: f(u, v)
+
+
+def negate[**P](f: Callable[P, bool]) -> Callable[P, bool]:
+    """Take a predicate and return its negation."""
+
+    def ff(*args: P.args, **kwargs: P.kwargs) -> bool:
+        return not f(*args, **kwargs)
+
+    return ff
+
+
+def sequenced[R](f: Callable[..., R]) -> Callable[[tuple[Any]], R]:
+    """Convert a function with arbitrary positional arguments to one taking
+    a tuple of the original arguments.
+
+    - was awaiting typing and mypy "improvements" to ParamSpec
+
+      - return type: Callable[tuple[P.args], R]   ???
+      - return type: Callable[[tuple[P.args]], R] ???
+
+    - not going to happen, `see <https://github.com/python/mypy/pull/18278>`_
+
+    TODO: Look into replacing this function with a Callable class?
+
+    """
+    def ff(tupled_args: tuple[Any]) -> R:
+        return f(*tupled_args)
+
+    return ff
+
+
+def partial[**P, R](f: Callable[P, R], *args: Any) -> Callable[..., R]:
+    """Partially apply arguments to a function, left to right.
+
+    - type-wise the only thing guaranteed is the return type
+    - best practice is to cast the result immediately
+
+    """
+    def finish(*rest: Any) -> R:
+        return sequenced(f)(args + rest)
+
+    return finish

pythonic_fp/fptools/lazy.py

@@ -0,0 +1,177 @@
+# 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 - Lazy function evaluation
+
+Delayed function evaluations. FP tools for "non-strict" function evaluations.
+Useful to delay a function's evaluation until some inner scope.
+
+Non-strict delayed function evaluation.
+
+- *class* **Lazy** - Delay evaluation of functions taking & returning single values
+- *function* **lazy** - Delay evaluation of functions taking any number of values
+- *function* **real_lazy** - Version of ``lazy`` which caches its result
+
+"""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Any, Final, Never, TypeVar, ParamSpec
+from .function import sequenced
+from .either import Either, LEFT, RIGHT
+from .maybe import MayBe
+
+__all__ = ['Lazy', 'lazy', 'real_lazy']
+
+D = TypeVar('D')
+R = TypeVar('R', contravariant=True)
+P = ParamSpec('P')
+
+
+class Lazy[D, R]:
+    """Delayed evaluation of a singled valued function.
+
+    Class instance delays the executable of a function where ``Lazy(f, arg)``
+    constructs an object that can evaluate the Callable ``f`` with its argument
+    at a later time.
+
+    - first argument ``f`` taking values of type ``D`` to values of type ``R``
+    - second argument ``arg: D`` is the argument to be passed to ``f``
+
+      - where the type ``D`` is the ``tuple`` type of the argument types to ``f``
+
+    - function is evaluated when the ``eval`` method is called
+    - result is cached unless ``pure`` is set to ``False``
+    - returns True in Boolean context if evaluated
+
+    Usually use case is to make a function "non-strict" by passing some of its
+    arguments wrapped in Lazy instances.
+
+    """
+
+    __slots__ = ('_f', '_d', '_result', '_pure', '_evaluated', '_exceptional')
+
+    def __init__(self, f: Callable[[D], R], d: D, pure: bool = True) -> None:
+        self._f: Final[Callable[[D], R]] = f
+        self._d: Final[D] = d
+        self._pure: bool = pure
+        self._evaluated: bool = False
+        self._exceptional: MayBe[bool] = MayBe()
+        self._result: Either[R, Exception]
+
+    def __bool__(self) -> bool:
+        return self._evaluated
+
+    def eval(self) -> None:
+        """Evaluate function with its argument.
+
+        - evaluate function
+        - cache result or exception if ``pure == True``
+        - reevaluate if ``pure == False``
+
+        """
+        if not (self._pure and self._evaluated):
+            try:
+                result = self._f(self._d)
+            except Exception as exc:
+                self._result, self._evaluated, self._exceptional = (
+                    Either(exc, RIGHT),
+                    True,
+                    MayBe(True),
+                )
+            else:
+                self._result, self._evaluated, self._exceptional = (
+                    Either(result, LEFT),
+                    True,
+                    MayBe(False),
+                )
+
+    def got_result(self) -> MayBe[bool]:
+        """Return true if an evaluated Lazy did not raise an exception."""
+        return self._exceptional.bind(lambda x: MayBe(not x))
+
+    def got_exception(self) -> MayBe[bool]:
+        """Return true if Lazy raised exception."""
+        return self._exceptional
+
+    def get(self, alt: R | None = None) -> R | Never:
+        """Get result only if evaluated and no exceptions occurred, otherwise
+        return an alternate value.
+
+        A possible use case would be if the calculation is expensive, but if it
+        has already been done, its result is better than the alternate value.
+
+        """
+        if self._evaluated and self._result:
+            return self._result.get()
+        if alt is not None:
+            return alt
+        msg = 'Lazy: method get needed an alternate value but none given.'
+        raise ValueError(msg)
+
+    def get_result(self) -> MayBe[R]:
+        """Get result only if evaluated and not exceptional."""
+        if self._evaluated and self._result:
+            return self._result.get_left()
+        return MayBe()
+
+    def get_exception(self) -> MayBe[Exception]:
+        """Get result only if evaluate and exceptional."""
+        if self._evaluated and not self._result:
+            return self._result.get_right()
+        return MayBe()
+
+
+def lazy[**P, R](
+    f: Callable[P, R], *args: P.args, **kwargs: P.kwargs
+) -> Lazy[tuple[Any, ...], R]:
+    """Delayed evaluation of a function with arbitrary positional arguments.
+
+    Function returning a delayed evaluation of a function of an arbitrary number
+    of positional arguments.
+
+    - first positional argument ``f`` takes a function
+    - next positional arguments are the arguments to be applied later to ``f``
+
+      - ``f`` is reevaluated whenever ``eval`` method of the returned ``Lazy`` is called
+
+    - any kwargs passed are ignored
+
+      - if ``f`` needs them, then wrap ``f`` in another function
+
+    """
+    return Lazy(sequenced(f), args, pure=False)
+
+
+def real_lazy[**P, R](
+    f: Callable[P, R], *args: P.args, **kwargs: P.kwargs
+) -> Lazy[tuple[Any, ...], R]:
+    """Cached delayed evaluation of a function with arbitrary positional arguments.
+
+    Function returning a delayed evaluation of a function of an arbitrary number
+    of positional arguments.
+
+    - first positional argument ``f`` takes a function
+    - next positional arguments are the arguments to be applied later to ``f``
+
+      - ``f`` is evaluated when ``eval`` method of the returned ``Lazy`` is called
+      - ``f`` is evaluated only once with results cached
+
+    - any kwargs passed are ignored
+
+      - if ``f`` needs them then wrap ``f`` in another function
+
+    """
+    return Lazy(sequenced(f), args)

pythonic_fp/fptools/maybe.py

@@ -0,0 +1,141 @@
+# 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 - Maybe Monad"""
+
+from __future__ import annotations
+
+__all__ = ['MayBe']
+
+from collections.abc import Callable, Iterator, Sequence
+from typing import cast, Final, Never, overload, TypeVar
+from pythonic_fp.singletons.sentinel import Sentinel
+
+D = TypeVar('D', covariant=True)
+
+
+class MayBe[D]:
+    """Maybe monad, data structure wrapping a potentially missing value.
+
+    Immutable semantics
+
+    - can store any item of any type, including ``None``
+    - can store any value of any type with one exception
+    - immutable semantics, therefore made covariant
+
+    .. warning::
+
+        Hashability invalidated if contained value is not hashable.
+
+    """
+
+    U = TypeVar('U', covariant=True)
+    V = TypeVar('V', covariant=True)
+    T = TypeVar('T')
+
+    __slots__ = ('_value',)
+    __match_args__ = ('_value',)
+
+    @overload
+    def __init__(self) -> None: ...
+    @overload
+    def __init__(self, value: D) -> None: ...
+
+    def __init__(self, value: D | Sentinel = Sentinel('MayBe')) -> None:
+        self._value: D | Sentinel = value
+
+    def __hash__(self) -> int:
+        return hash((Sentinel('MayBe'), self._value))
+
+    def __bool__(self) -> bool:
+        return self._value is not Sentinel('MayBe')
+
+    def __iter__(self) -> Iterator[D]:
+        if self:
+            yield cast(D, self._value)
+
+    def __repr__(self) -> str:
+        if self:
+            return 'MayBe(' + repr(self._value) + ')'
+        return 'MayBe()'
+
+    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._value is other._value:
+            return True
+        if self._value == other._value:
+            return True
+        return False
+
+    @overload
+    def get(self) -> D | Never: ...
+    @overload
+    def get(self, alt: D) -> D: ...
+
+    def get(self, alt: D | Sentinel = Sentinel('MayBe')) -> D | Never:
+        """Return the contained value if it exists, otherwise an alternate value.
+
+        .. warning::
+
+            Unsafe method ``get``. Will raise ``ValueError`` if MayBe empty
+            and an alt return value not given. Best practice is to first check
+            the MayBe in a boolean context.
+
+        :raises ValueError: when an alternate value is not provided but needed
+
+        """
+        _sentinel: Final[Sentinel] = Sentinel('MayBe')
+        if self._value is not _sentinel:
+            return cast(D, self._value)
+        if alt is _sentinel:
+            msg = 'MayBe: an alternate return type not provided'
+            raise ValueError(msg)
+        return cast(D, alt)
+
+    def map[U](self, f: Callable[[D], U]) -> MayBe[U]:
+        """Map function `f` over contents."""
+
+        if self:
+            return MayBe(f(cast(D, self._value)))
+        return cast(MayBe[U], self)
+
+    def bind[U](self, f: Callable[[D], MayBe[U]]) -> MayBe[U]:
+        """Flatmap ``MayBe`` with function ``f``."""
+        return f(cast(D, self._value)) if self else cast(MayBe[U], self)
+
+    @staticmethod
+    def sequence[U](sequence_mb_u: Sequence[MayBe[U]]) -> MayBe[Sequence[U]]:
+        """Sequence a mutable indexable of type ``MayBe[~U]``
+
+        If the iterated `MayBe` values are not all empty,
+
+        - return a MayBe of the Sequence subtype of the contained values
+        - otherwise return an empty MayBe
+
+        """
+        list_items: list[U] = list()
+
+        for mb_u in sequence_mb_u:
+            if mb_u:
+                list_items.append(mb_u.get())
+            else:
+                return MayBe()
+
+        sequence_type = cast(Sequence[U], type(sequence_mb_u))
+
+        return MayBe(sequence_type(list_items))  # type: ignore # subclass will be callable

pythonic_fp/fptools/state.py

@@ -0,0 +1,156 @@
+# Copyright 2024-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 - State Monad
+
+Handling state functionally.
+
+##### *class* State - Classic FP State Monad
+
+A pure FP immutable implementation for the State Monad.
+
+- translated to Python from the book "Functional Programming in Scala"
+
+  - authors Chiusana & Bjarnason
+  - run "action" returns a tuple ``(a, s)`` reversed to the type ``State[S, A]``
+
+    - the standard convention seen in the FP community
+    - another "factoid" to remember
+
+- choose the name ``bind`` instead of ``flatmap``
+
+  - the ``flatmap`` name is misleading for non-container-like monads
+  - ``flatmap`` name too long, ``bind`` shorter to type
+
+    - without "do-notation", code tends to march to the right
+
+- typing for the ``modify`` class method may be a bit suspect
+
+"""
+
+from __future__ import annotations
+
+__all__ = ['State']
+
+from collections.abc import Callable
+from typing import TypeVar
+from pythonic_fp.circulararray.auto import CA
+
+S = TypeVar('S')
+A = TypeVar('A')
+B = TypeVar('B')
+C = TypeVar('C')
+ST = TypeVar('ST')
+AA = TypeVar('AA')
+
+
+class State[S, A]:
+    """Data structure generating values while propagating changes of state.
+
+    - class ``State`` represents neither a state nor (value, state) pair
+
+      - it wraps a transformation old_state -> (value, new_state)
+      - the ``run`` method is this wrapped transformation
+      - ``bind`` is just state propagating function composition
+
+    """
+
+    __slots__ = ('run',)
+
+    def __init__(self, run: Callable[[S], tuple[A, S]]) -> None:
+        self.run = run
+
+    def bind[B](self, g: Callable[[A], State[S, B]]) -> State[S, B]:
+        """Perform function composition while propagating state."""
+
+        def compose(s: S) -> tuple[B, S]:
+            a, s = self.run(s)
+            return g(a).run(s)
+
+        return State(compose)
+
+    def eval(self, init: S) -> A:
+        """Evaluate the Monad via passing an initial state."""
+        a, _ = self.run(init)
+        return a
+
+    def map[B](self, f: Callable[[A], B]) -> State[S, B]:
+        """Map a function over a run action."""
+        return self.bind(lambda a: State.unit(f(a)))
+
+    def map2[B, C](self, sb: State[S, B], f: Callable[[A, B], C]) -> State[S, C]:
+        """Map a function of two variables over two state actions."""
+        return self.bind(lambda a: sb.map(lambda b: f(a, b)))
+
+    def both[B](self, rb: State[S, B]) -> State[S, tuple[A, B]]:
+        """Return a tuple of two state actions."""
+        return self.map2(rb, lambda a, b: (a, b))
+
+    @staticmethod
+    def unit[ST, B](b: B) -> State[ST, B]:
+        """Create a State action returning the given value."""
+        return State(lambda s: (b, s))
+
+    @staticmethod
+    def get[ST]() -> State[ST, ST]:
+        """Set run action to return the current state
+
+        - the current state is propagated unchanged
+        - current value now set to current state
+        - will need type annotation
+
+        """
+        return State[ST, ST](lambda s: (s, s))
+
+    @staticmethod
+    def put[ST](s: ST) -> State[ST, tuple[()]]:
+        """Manually insert a state.
+
+        THe run action.
+
+        - ignores previous state and swaps in a new state
+        - assigns a canonically meaningless value to current value
+
+        """
+        return State(lambda _: ((), s))
+
+    @staticmethod
+    def modify[ST](f: Callable[[ST], ST]) -> State[ST, tuple[()]]:
+        """Modify previous state.
+
+        - like put, but modify previous state via ``f``
+        - will need type annotation
+
+          - mypy has no "a priori" way to know what ST is
+
+        """
+        return State.get().bind(lambda a: State.put(f(a)))  # type: ignore
+
+    @staticmethod
+    def sequence[ST, AA](sas: list[State[ST, AA]]) -> State[ST, list[AA]]:
+        """Combine a list of state actions into a state action of a list.
+
+        - all state actions must be of the same type
+        - run method evaluates list front to back
+
+        """
+
+        def append_ret(ls: list[AA], a: AA) -> list[AA]:
+            ls.append(a)
+            return ls
+
+        return CA(sas).foldl(
+            lambda s1, sa: s1.map2(sa, append_ret),
+            State.unit(list[AA]([]))
+        )

pythonic_fp_fptools-5.0.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,11 @@
+pythonic_fp/fptools/__init__.py,sha256=wMmxz9DMh1r27bJxoPtP46YCMVRLLsERv2gXORAf8Uk,1685
+pythonic_fp/fptools/either.py,sha256=Au32tb7NeyPsgmB17d3Ic6svVWwJ8w0cQd3k34QpQVs,8502
+pythonic_fp/fptools/function.py,sha256=tqJkWNyeK-ifMA-gCa4rSmuyS5yuFBOHFB8pfL7YpCI,2652
+pythonic_fp/fptools/lazy.py,sha256=Z-bUsMy0EF56cToZIOlRz4Nz-F1YoYw29dvVMIfJpcI,6152
+pythonic_fp/fptools/maybe.py,sha256=C-QWzyt74ztKj0gNaipiJ7ZqRXmFiUc_8GRLmeeGj7s,4320
+pythonic_fp/fptools/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/fptools/state.py,sha256=nulrtZRmGcB65l7-ZfxpmRNKPflhRzrwIBujAUILRnw,4717
+pythonic_fp_fptools-5.0.0.dist-info/licenses/LICENSE,sha256=psuoW8kuDP96RQsdhzwOqi6fyWv0ct8CR6Jr7He_P_k,10173
+pythonic_fp_fptools-5.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_fptools-5.0.0.dist-info/METADATA,sha256=UGLIvIrh8IBAzTzgmrzvLpmvtbBFLK1TCBXNldkoF_I,2490
+pythonic_fp_fptools-5.0.0.dist-info/RECORD,,

pythonic_fp_fptools-5.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: flit 3.12.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pythonic_fp_fptools-5.0.0.dist-info/licenses/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