pythonic-fp.splitends 2.0.0__py3-none-any.whl → 2.0.2__py3-none-any.whl

pythonic_fp/splitends/__init__.py

@@ -1,4 +1,4 @@
-# Copyright 2024-2025 Geoffrey R. Scheller
+# Copyright 2024-2026 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.
@@ -26,12 +26,13 @@ node is at the bottom of the stack and can not be "snipped" or "cut" off.
 A ``SplitEnd`` can be duplicated onto a compatible root node. By compatible, the
 new root must contain data that compares as equal to the old root node.
 
-TODO: A ``scalp`` is a container of root nodes all of whose contained data must be
-hashable. The ``scalp.add(d)`` method will return the unique root node with data
+**TODO:** A ``scalp`` is a container of root nodes all of whose contained data must
+be hashable. The ``scalp.add(d)`` method will return the unique root node with data
 that compares as equal to ``d``, or create a new root node if such a contained node
 does not exist.
+
 """
 
 __author__ = 'Geoffrey R. Scheller'
-__copyright__ = 'Copyright (c) 2023-2025 Geoffrey R. Scheller'
+__copyright__ = 'Copyright (c) 2023-2026 Geoffrey R. Scheller'
 __license__ = 'Apache License 2.0'

pythonic_fp/splitends/splitend.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2025 Geoffrey R. Scheller
+# Copyright 2023-2026 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.
@@ -14,27 +14,29 @@
 
 """
 Class SplitEnds
-===============
+---------------
 
-**LIFO stacks safely sharing immutable data.**
+.. admonition:: LIFO stacks safely sharing immutable data.
 
-- each ``SplitEnd`` is a very simple stateful (mutable) LIFO stack
-- data can be either "extended" to or "snipped" off the "end" 
-- the "root" of a ``SplitEnd``
-  - it is fixed and cannot be removed from the ``SplitEnd``
-- different mutable split ends can safely share the same "tail"
-- each ``SplitEnd`` sees itself as a singularly linked list
-- bush-like datastructures can be formed using multiple ``SplitEnds``
-- the ``SplitEnd.split`` and ``len`` methods are O(1)
-- in boolean context returns true if the ``SplitEnd`` is not just its "root"
+    - each ``SplitEnd`` is a very simple stateful (mutable) LIFO stack
+    - data can be either "extended" to or "snipped" off the "end" 
+    - the "root" of a ``SplitEnd``
+
+      - it is fixed and cannot be removed from the ``SplitEnd``
+
+    - different mutable split ends can safely share the same "tail"
+    - each ``SplitEnd`` sees itself as a singularly linked list
+    - bush-like datastructures can be formed using multiple ``SplitEnds``
+    - the ``SplitEnd.split`` and ``len`` methods are O(1)
+    - in boolean context returns true if the ``SplitEnd`` is not just its "root"
 
 """
 
 from collections.abc import Callable, Iterator
-from pythonic_fp.iterables.folding import reduce_left, fold_left
 from typing import cast, Final, overload
-from pythonic_fp.queues.lifo import LIFOQueue
 from pythonic_fp.gadgets.sentinels.flavored import Sentinel
+from pythonic_fp.iterables.folding import reduce_left, fold_left
+from pythonic_fp.queues.lifo import LIFOQueue
 from .splitend_node import SENode
 
 __all__ = ['SplitEnd']
@@ -52,6 +54,7 @@ class SplitEnd[D]:
         """
         :param root_data: Irremovable initial data at bottom of stack.
         :param data: Removable data to be pushed onto splitend stack.
+
         """
         if root is _sentinel:
             if ds:
@@ -83,6 +86,7 @@ class SplitEnd[D]:
     def __bool__(self) -> bool:
         """
         :returns: ``True`` is ``SplitEnd`` is not just its root node.
+
         """
         return bool(self._end)
 
@@ -121,6 +125,7 @@ class SplitEnd[D]:
 
         :param num: Optional number of nodes to cut, default is entire stack.
         :returns: Tuple of data cut off from end.
+
         """
         if num is None or num > self._count:
             num = self._count
@@ -146,6 +151,7 @@ class SplitEnd[D]:
         extension.
 
         :param ds: data to extend the splitend
+
         """
         for d in ds:
             node = SENode(d, self._end)
@@ -155,12 +161,14 @@ class SplitEnd[D]:
         """Return the data at end (top) of SplitEnd without consuming it.
 
         :returns: The data at the end of the SplitEnd.
+
         """
         return self._end.data()
 
     def root(self) -> SENode[D]:
         """
         :returns: The root SENode node of the SplitEnd.
+
         """
         return self._root
 
@@ -172,12 +180,16 @@ class SplitEnd[D]:
             Two nodes are compatible root nodes if and only if
 
             - they are both actually root nodes
-              - that is their previous nodes are themselves
+
+              - which implies that their previous nodes are themselves
+
             - their data compare as equal
+
               - comparing by identity is too strong for some use cases
 
         :returns: New SplitEnd with the same data and the new ``root``.
         :raises ValueError: If new and original root nodes are not compatible.
+
         """
         if not root:
             msg = 'New root node is not a root node.'
@@ -197,6 +209,7 @@ class SplitEnd[D]:
         """Snip data off tip of SplitEnd. Just return data if tip is root.
 
         :returns: Data snipped off tip, just return root data if at root.
+
         """
         if self._count > 1:
             data, self._end, self._count = self._end.both() + (self._count - 1,)
@@ -209,6 +222,7 @@ class SplitEnd[D]:
         """Split the end and add more data.
 
         :returns: New instance, same data nodes plus additional ones on end.
+
         """
         se: SplitEnd[D] = SplitEnd(self._root.data())
         se._count, se._end, se._root = self._count, self._end, self._root
@@ -226,6 +240,7 @@ class SplitEnd[D]:
         :param f: Folding function, first argument is for the accumulator.
         :param init: Optional initial starting value for the fold.
         :returns: Reduced value folding from tip to root in natural LIFO order.
+
         """
         if init is None:
             return self._end.fold(f)  # type: ignore
@@ -242,6 +257,7 @@ class SplitEnd[D]:
         :param f: Folding function, first argument is for the accumulator.
         :param init: Optional initial starting value for the fold.
         :returns: Reduced value folding from root to tip.
+
         """
         if init is None:
             return cast(T, reduce_left(reversed(self), cast(Callable[[D, D], D], f)))

pythonic_fp/splitends/splitend_node.py

@@ -1,4 +1,4 @@
-# Copyright 2023-2025 Geoffrey R. Scheller
+# Copyright 2023-2026 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.
@@ -14,20 +14,25 @@
 
 """
 Class SENode
-============
+------------
 
-**Used to make inwardly directed bush-like graphs.**
+.. admonition:: Used to make inwardly directed bush-like graphs
 
-- designed so multiple splitends can safely share the same data
-- nodes always contain data
-- data node ``SENode[D]`` make up end-to-root singularly linked lists
-- two nodes compare as equal if
-    - both their previous Nodes are the same
-    - their data compare as equal
-- a root node is a node whose previous node is itself
-    - root nodes mark the bottom of splitend stacks
-- more than one node can point to the same proceeding node
-    - forming bush like graphs
+    - designed so multiple splitends can safely share the same data
+    - nodes always contain data
+    - data node ``SENode[D]`` make up end-to-root singularly linked lists
+    - two nodes compare as equal if
+
+      - both their previous Nodes are the same
+      - their data compare as equal
+
+    - a root node is a node whose previous node is itself
+
+      - root nodes mark the bottom of splitend stacks
+
+    - more than one node can point to the same proceeding node
+
+      - forming bush like graphs
 
 """
 
@@ -72,6 +77,7 @@ class SENode[D]:
         """
         Two ``SENodes`` nodes are equal if their previous nodes are the
         same object and their data compare as equal.
+
         """
         if not isinstance(other, type(self)):
             return False
@@ -86,6 +92,7 @@ class SENode[D]:
         """Peak at data and previous node, if a root then data and self.
 
         :returns: tuple of type tuple[D, SENode[D]]
+
         """
         return self._data, self._prev
 
@@ -93,6 +100,7 @@ class SENode[D]:
         """Peak at data.
 
         :returns: The data stored in the ``SENode``.
+
         """
         return self._data
 
@@ -100,6 +108,7 @@ class SENode[D]:
         """Peak at previous node.
 
         :returns: The previous node stored in the ``SENode``.
+
         """
         return self._prev
 
@@ -108,6 +117,7 @@ class SENode[D]:
 
         :param data: Data for new node to contain.
         :returns: New ``SENode`` whose previous node is the current node.
+
         """
         return cast(Self, SENode(data, self))
 
@@ -122,6 +132,7 @@ class SENode[D]:
         :param f: Folding function, first argument is for accumulated value.`
         :param init: Optional initial starting value for the fold.
         :returns: Reduced value folded from end to root in natural LIFO order.
+
         """
         if init is not _sentinel:
             acc = cast(T, init)

{pythonic_fp_splitends-2.0.0.dist-info → pythonic_fp_splitends-2.0.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-splitends
-Version: 2.0.0
+Version: 2.0.2
 Summary: Mutable stack objects that can safely share data.
 Keywords: SplitEnd,lifo,stack
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -14,9 +14,9 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Typing :: Typed
 License-File: LICENSE
-Requires-Dist: pythonic-fp-fptools>=5.1.2
-Requires-Dist: pythonic-fp-iterables>=5.1.2
-Requires-Dist: pythonic-fp-queues>=5.1.0
+Requires-Dist: pythonic-fp-fptools>=5.2.0
+Requires-Dist: pythonic-fp-iterables>=5.1.3
+Requires-Dist: pythonic-fp-queues>=5.1.1
 Requires-Dist: pytest>=8.4.1 ; extra == "test"
 Project-URL: Changelog, https://github.com/grscheller/pythonic-fp-splitends/blob/main/CHANGELOG.rst
 Project-URL: Documentation, https://grscheller.github.io/pythonic-fp/splitends/development/build/html/
@@ -45,7 +45,7 @@ between themselves.
 
 Part of the
 `pythonic-fp
-<https://grscheller.github.io/pythonic-fp/homepage/build/html/index.html>`_
+<https://grscheller.github.io/pythonic-fp>`_
 PyPI projects.
 
 Documentation
@@ -53,7 +53,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/splitends/development/build/html>`_.
+<https://grscheller.github.io/pythonic-fp/splitends>`_.
 
 Copyright and License
 ---------------------

pythonic_fp_splitends-2.0.2.dist-info/RECORD

@@ -0,0 +1,11 @@
+pythonic_fp/splitends/__init__.py,sha256=T3FgFehJkrlKx2OKHJJETDcEJ_2nKfyl96wTb4Nw6Fw,1780
+pythonic_fp/splitends/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/splitends/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pythonic_fp/splitends/splitend.py,sha256=TkLQ5o4-SCnnC_HTpda6cSotaxyQ6aNbc8DB81qNqSI,8317
+pythonic_fp/splitends/splitend.pyi,sha256=OdTRATFXX5smbpwc8wm3gt4yyeTd_kN8VbMeNYl2Cho,1193
+pythonic_fp/splitends/splitend_node.py,sha256=0Qz_oIvwbvtlYZOD-tZ0lD4PxMRysFPkBNPTBkGdkQk,4306
+pythonic_fp/splitends/splitend_node.pyi,sha256=TozeGg4lmjMf0UPfZRTxRJR2kRpq0053VjbjIBUeosk,705
+pythonic_fp_splitends-2.0.2.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
+pythonic_fp_splitends-2.0.2.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
+pythonic_fp_splitends-2.0.2.dist-info/METADATA,sha256=l9gYIuYaAd9pIQwLAe_6AHnSjowRzx6JKsV4uxtI6dQ,2381
+pythonic_fp_splitends-2.0.2.dist-info/RECORD,,

pythonic_fp_splitends-2.0.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-pythonic_fp/splitends/__init__.py,sha256=mydkUVuGD_Ns3G4LYgOQvPfTxMCkCkFwC3oZFDHnRmM,1775
-pythonic_fp/splitends/__init__.pyi,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/splitends/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pythonic_fp/splitends/splitend.py,sha256=XQ4-1x8lW5i480YHjBcwAhh4ddxtPF7KsIrMnbaM8Ks,8242
-pythonic_fp/splitends/splitend.pyi,sha256=OdTRATFXX5smbpwc8wm3gt4yyeTd_kN8VbMeNYl2Cho,1193
-pythonic_fp/splitends/splitend_node.py,sha256=rNjGU8VqhOo6AFa-R6zcOrrAtfIpzkzI9ulsa8iRg2w,4252
-pythonic_fp/splitends/splitend_node.pyi,sha256=TozeGg4lmjMf0UPfZRTxRJR2kRpq0053VjbjIBUeosk,705
-pythonic_fp_splitends-2.0.0.dist-info/licenses/LICENSE,sha256=IJMkVWQUVy-SonK6SMaMotDQ6Zb-lVi2bUTiGp1GUO8,10774
-pythonic_fp_splitends-2.0.0.dist-info/WHEEL,sha256=G2gURzTEtmeR8nrdXUJfNiB3VYVxigPQ-bEQujpNiNs,82
-pythonic_fp_splitends-2.0.0.dist-info/METADATA,sha256=LMjr3oM6p1DbZhL9f6mAvd8gDDa5klTdA8IiJiFdn_w,2435
-pythonic_fp_splitends-2.0.0.dist-info/RECORD,,