py-doubly-linked-list 0.1.3__cp314-cp314-win32.whl

py_doubly_linked_list/__init__.py

@@ -0,0 +1 @@
+from .doubly_linked_list import DoublyLinkedList

py_doubly_linked_list/__init__.pyi

@@ -0,0 +1,56 @@
+from typing import Iterable, TypeVar, overload
+from collections.abc import Callable, MutableSequence
+from _typeshed import SupportsRichComparison, SupportsRichComparisonT, _T
+import sys
+
+_S = TypeVar("_S")
+
+class DoublyLinkedList(MutableSequence[_T]):
+    @overload
+    def __init__(self) -> None: ...
+    def __init__(self, iterable: Iterable[_T], /) -> None: ...
+    def append(self, object: _T, forward: bool = True) -> None:
+        """Append object to the end of the list. Set forward to false to append to the start."""
+        ...
+    def clear(self) -> None:
+        """Remove all items from the list."""
+        ...
+    def copy(self) -> DoublyLinkedList[_T]:
+        """Return a shallow copy of the list."""
+        ...
+    def count(self, value: _T) -> int:
+        """Return number of occurrences of value in the list."""
+        ...
+    def extend(self, iterable: Iterable[_T], forward: bool = True) -> None:
+        """Extend list by appending elements from the iterable. Set forward to false to extend from the start."""
+        ...
+    def index(self, value: _T, start: int = 0, stop: int = sys.maxsize) -> int:
+        """Return first index of value.  
+        Raises ValueError if the value is not present."""
+        ...
+    def insert(self, object: _T, index: int, forward: bool = True) -> None:
+        """Insert object after index. Set forward to false to insert before index."""
+        ...
+    def pop(self, index: int = -1) -> _T:
+        """Remove and return item at index (default last).  
+        Raises IndexError if list is empty or index is out of range."""
+        ...
+    def remove(self, value: _T) -> None:
+        """Remove first occurence of value.  
+        Raises ValueError if the value is not present."""
+        ...
+    def reverse(self) -> None:
+        """Reverse the order of the list."""
+        ...
+    @overload
+    def sort(self: DoublyLinkedList[SupportsRichComparisonT], key: None = None, reverse: bool = False) -> None:
+        """In-place sort in ascending order, equal objects are not swapped. Reverse will reverse the sort order."""
+        ...
+    @overload
+    def sort(self, key: Callable[[_T], SupportsRichComparison], reverse: bool = False) -> None:
+        """In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order."""
+        ...
+    @overload
+    def __add__(self, value: Iterable[_T], /) -> DoublyLinkedList[_T]: ...
+    @overload
+    def __add__(self, value: Iterable[_S], /) -> DoublyLinkedList[_T | _S]: ...

py_doubly_linked_list-0.1.3.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: py-doubly-linked-list
+Version: 0.1.3
+Summary: A library adding doubly linked lists to python.
+Author-email: Joshua Morningstar <joshuam18745@gmail.com>
+Maintainer-email: Joshua Morningstar <joshuam18745@gmail.com>
+License-Expression: MIT
+Project-URL: Documentation, https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/README.MD
+Project-URL: Repository, https://github.com/JoshuaM176/PyDoublyLinkedList
+Project-URL: Issues, https://github.com/JoshuaM176/PyDoublyLinkedList/issues
+Project-URL: Changelog, https://github.com/JoshuaM176/PyDoublyLinkedList/blob/main/CHANGES
+Keywords: doubly linked list,data structure
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: README.MD
+Dynamic: license-file
+
+# py-doubly-linked-list
+## Description
+This library provides an implementation of a doubly linked list for python written with the c api. It is meant to be as close as possible to a regular list in its interface, meaning you can interact with it in almost all of the same ways you interact with a regular python list.
+## Methods
+- append  
+Append object to the end of the list. Set forward to false to append to the start.  
+```Python
+doubly_linked_list.append(object: Any, forward: bool = True)
+```
+- clear  
+Remove all items from the list.  
+```Python
+doubly_linked_list.clear()
+```
+- copy  
+Return a shallow copy of the list.  
+```Python
+doubly_linked_list.copy()
+```
+- count  
+Return number of occurrences of value in the list.  
+```Python
+doubly_linked_list.count(value: Any)
+```
+- extend  
+Extend list by appending elements from the iterable. Set forward to false to extend from the start.  
+```Python
+doubly_linked_list.extend(iterable: Iterable, forward: bool = True)
+```
+- index  
+Return first index of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.index(value: Any, start: int, stop: int)
+```
+- insert  
+Insert object after index. Set forward to false to insert before index.  
+```Python
+doubly_linked_list.insert(object: Any, index: int, forward: bool = True)
+```
+- pop  
+Remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.  
+```Python
+doubly_linked_list.pop(index: int = -1)
+```
+- remove  
+Remove first occurence of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.remove(value: Any)
+```
+- reverse  
+Reverse the order of the list.  
+```Python
+doubly_linked_list.reverse()
+```
+- sort  
+In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order.
+```Python
+doubly_linked_list.sort(key: Callable = None, reverse: bool = False)
+```
+The DoublyLinkedList also supports:
+- concatenation with other iterables
+- in-place concatenation with other iterables
+- indexing and assignment by index
+- slicing
+- iterating  
+
+Things that are not currently supported but might be in the future:
+- assigning slices
+- repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
+
+# License
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.3.dist-info/RECORD

@@ -0,0 +1,10 @@
+py_doubly_linked_list/__init__.py,sha256=yr4gaBVd4p_p8w2baBhpKltQ_o75jiU5YIELuJ5U5zI,48
+py_doubly_linked_list/__init__.pyi,sha256=AlTW1fCj1gBUf3NB4TuuNWQDxW92Qvvx24QxIJoQizk,2673
+py_doubly_linked_list/doubly_linked_list.cp314-win32.pyd,sha256=EEbDiFoXKevHKTCwjp-8iAErFrnm9l4tf8SyQ2KVei0,17408
+py_doubly_linked_list/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+py_doubly_linked_list-0.1.3.dist-info/licenses/LICENSE,sha256=adZAxhbQOLyFXxc0-jXSjtCw90eU3I5ecVZ4nXkCbMk,1070
+py_doubly_linked_list-0.1.3.dist-info/licenses/README.MD,sha256=oPpx8zBQqPXp2DeDJzukyXuVWmclHlMC1G6ZGPIi0Bw,3502
+py_doubly_linked_list-0.1.3.dist-info/METADATA,sha256=PrzNyrtyhJcYN0piKvhB8wTmasS1H144id3ch0ASi_w,4763
+py_doubly_linked_list-0.1.3.dist-info/WHEEL,sha256=avp3B09fSRXVHn4cshTNKc58MtFVN-cVe0NyrqeYT2s,97
+py_doubly_linked_list-0.1.3.dist-info/top_level.txt,sha256=8eaqZ5zvqWobW61EaJ1AudwZk29Tp4A6Y_c4FVwxz24,22
+py_doubly_linked_list-0.1.3.dist-info/RECORD,,

py_doubly_linked_list-0.1.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp314-cp314-win32
+

py_doubly_linked_list-0.1.3.dist-info/licenses/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.3.dist-info/licenses/README.MD

@@ -0,0 +1,78 @@
+# py-doubly-linked-list
+## Description
+This library provides an implementation of a doubly linked list for python written with the c api. It is meant to be as close as possible to a regular list in its interface, meaning you can interact with it in almost all of the same ways you interact with a regular python list.
+## Methods
+- append  
+Append object to the end of the list. Set forward to false to append to the start.  
+```Python
+doubly_linked_list.append(object: Any, forward: bool = True)
+```
+- clear  
+Remove all items from the list.  
+```Python
+doubly_linked_list.clear()
+```
+- copy  
+Return a shallow copy of the list.  
+```Python
+doubly_linked_list.copy()
+```
+- count  
+Return number of occurrences of value in the list.  
+```Python
+doubly_linked_list.count(value: Any)
+```
+- extend  
+Extend list by appending elements from the iterable. Set forward to false to extend from the start.  
+```Python
+doubly_linked_list.extend(iterable: Iterable, forward: bool = True)
+```
+- index  
+Return first index of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.index(value: Any, start: int, stop: int)
+```
+- insert  
+Insert object after index. Set forward to false to insert before index.  
+```Python
+doubly_linked_list.insert(object: Any, index: int, forward: bool = True)
+```
+- pop  
+Remove and return item at index (default last). Raises IndexError if list is empty or index is out of range.  
+```Python
+doubly_linked_list.pop(index: int = -1)
+```
+- remove  
+Remove first occurence of value. Raises ValueError if the value is not present.  
+```Python
+doubly_linked_list.remove(value: Any)
+```
+- reverse  
+Reverse the order of the list.  
+```Python
+doubly_linked_list.reverse()
+```
+- sort  
+In-place sort in ascending order, equal objects are not swapped. Key can be applied to values and the list will be sorted based on the result of applying the key. Reverse will reverse the sort order.
+```Python
+doubly_linked_list.sort(key: Callable = None, reverse: bool = False)
+```
+The DoublyLinkedList also supports:
+- concatenation with other iterables
+- in-place concatenation with other iterables
+- indexing and assignment by index
+- slicing
+- iterating  
+
+Things that are not currently supported but might be in the future:
+- assigning slices
+- repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
+
+# License
+Copyright (c) 2025 Joshua A. Morningstar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

py_doubly_linked_list-0.1.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+py_doubly_linked_list