py-doubly-linked-list 0.1.0__cp314-cp314t-win32.whl → 0.1.1__cp314-cp314t-win32.whl

py_doubly_linked_list/__init__.pyi

@@ -1,21 +1,48 @@
-from typing import Iterable, Any
+from typing import Iterable, Any, Self
+from collections.abc import Callable
 
 class DoublyLinkedList:
     def __init__(self, Iterable: Iterable) -> None: ...
-    def append(self, object: Any, forward: bool = True) -> None: ...
-    def clear(self) -> None: ...
-    def copy(self) -> DoublyLinkedList: ...
-    def count(self, value: Any) -> int: ...
-    def extend(self, iterable: Iterable, forward: bool = True) -> None: ...
-    def index(self, value: Any, start: int, stop: int) -> int: ...
-    def insert(self, object: Any, index: int, forward: bool = True) -> None: ...
-    def pop(self, index: int = -1) -> Any: ...
-    def remove(self, value: Any) -> None: ...
-    def reverse(self) -> None: ...
+    def append(self, object: Any, 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:
+        """Return a shallow copy of the list."""
+        ...
+    def count(self, value: Any) -> int:
+        """Return number of occurrences of value in the list."""
+        ...
+    def extend(self, iterable: Iterable, 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: Any, start: int, stop: int) -> int:
+        """Return first index of value.  
+        Raises ValueError if the value is not present."""
+        ...
+    def insert(self, object: Any, index: int, forward: bool = True) -> None:
+        """Insert object after index. Set forward to false to insert before index."""
+        ...
+    def pop(self, index: int = -1) -> Any:
+        """Remove and return item at index (default last).  
+        Raises IndexError if list is empty or index is out of range."""
+        ...
+    def remove(self, value: Any) -> None:
+        """Remove first occurence of value.  
+        Raises ValueError if the value is not present."""
+        ...
+    def reverse(self) -> None:
+        """Reverse the order of the list."""
+        ...
+    def sort(self: DoublyLinkedList, key: Callable, 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."""
+        ...
     def __add__(self, Iterable: Iterable) -> DoublyLinkedList: ...
     def __contains__(self, Any: Any) -> bool: ...
     def __delitem__(self, Any: Any) -> None: ...
     def __getitem__(self, Index: int) -> Any: ...
-    def __iadd__(self, Iterable: Iterable) -> None: ...
+    def __iadd__(self, Iterable: Iterable) -> Self: ...
     def __len__(self) -> int: ...
-    def __setitem__(self, Index: int, Object: Any) -> None: ...
+    def __setitem__(self, Index: int, Object: Any) -> None: ...

{py_doubly_linked_list-0.1.0.dist-info → py_doubly_linked_list-0.1.1.dist-info}/METADATA

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: py-doubly-linked-list
-Version: 0.1.0
+Version: 0.1.1
 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
@@ -78,6 +79,11 @@ 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
@@ -86,7 +92,6 @@ The DoublyLinkedList also supports:
 - iterating  
 
 Things that are not currently supported but might be in the future:
-- sorting
 - assigning slices
 - repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
 

py_doubly_linked_list-0.1.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+py_doubly_linked_list/__init__.py,sha256=yr4gaBVd4p_p8w2baBhpKltQ_o75jiU5YIELuJ5U5zI,48
+py_doubly_linked_list/__init__.pyi,sha256=a021k23zu0S8D0CybY4HozaX6gahJ2nrQ3QNOtWTZ0s,2345
+py_doubly_linked_list/doubly_linked_list.cp314t-win32.pyd,sha256=F8J18KZ4pMbPvJfgTwGXv3nkbDeTpSVnLuJiAa7Slpw,22528
+py_doubly_linked_list-0.1.1.dist-info/licenses/LICENSE,sha256=adZAxhbQOLyFXxc0-jXSjtCw90eU3I5ecVZ4nXkCbMk,1070
+py_doubly_linked_list-0.1.1.dist-info/licenses/README.MD,sha256=oPpx8zBQqPXp2DeDJzukyXuVWmclHlMC1G6ZGPIi0Bw,3502
+py_doubly_linked_list-0.1.1.dist-info/METADATA,sha256=lvOh14rhjYNL2QTGPfscMpMpjnPIuY64TrBJH8WT-Rs,4750
+py_doubly_linked_list-0.1.1.dist-info/WHEEL,sha256=QZj5mezaA5oNm6LDNW4xgYLgBYwS1DTKsN1RAjQk9mo,98
+py_doubly_linked_list-0.1.1.dist-info/top_level.txt,sha256=8eaqZ5zvqWobW61EaJ1AudwZk29Tp4A6Y_c4FVwxz24,22
+py_doubly_linked_list-0.1.1.dist-info/RECORD,,

{py_doubly_linked_list-0.1.0.dist-info → py_doubly_linked_list-0.1.1.dist-info}/licenses/README.MD

@@ -52,6 +52,11 @@ 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
@@ -60,7 +65,6 @@ The DoublyLinkedList also supports:
 - iterating  
 
 Things that are not currently supported but might be in the future:
-- sorting
 - assigning slices
 - repeating, i.e list = [1] * 5 create a list with 1 repeated 5 times
 

py_doubly_linked_list-0.1.0.dist-info/RECORD

@@ -1,9 +0,0 @@
-py_doubly_linked_list/__init__.py,sha256=yr4gaBVd4p_p8w2baBhpKltQ_o75jiU5YIELuJ5U5zI,48
-py_doubly_linked_list/__init__.pyi,sha256=dmn663JfPTkFYnKfLKjwIIEJnTjuDNFxKl5aHEbv5v0,1045
-py_doubly_linked_list/doubly_linked_list.cp314t-win32.pyd,sha256=DCwfRLI9EZ7IZSW9JGyokNqiUWfyCVgyfYl9YTBmPXA,20480
-py_doubly_linked_list-0.1.0.dist-info/licenses/LICENSE,sha256=adZAxhbQOLyFXxc0-jXSjtCw90eU3I5ecVZ4nXkCbMk,1070
-py_doubly_linked_list-0.1.0.dist-info/licenses/README.MD,sha256=JZUKP_kXyX0Ium83jwV8xD9-dDEuIR5SVg6Fsf66xGQ,3216
-py_doubly_linked_list-0.1.0.dist-info/METADATA,sha256=0e9cd6CDU3twp-38vD_UQVWLLrUGDS1HcSzDpMFAgM0,4401
-py_doubly_linked_list-0.1.0.dist-info/WHEEL,sha256=QZj5mezaA5oNm6LDNW4xgYLgBYwS1DTKsN1RAjQk9mo,98
-py_doubly_linked_list-0.1.0.dist-info/top_level.txt,sha256=8eaqZ5zvqWobW61EaJ1AudwZk29Tp4A6Y_c4FVwxz24,22
-py_doubly_linked_list-0.1.0.dist-info/RECORD,,