Dev (#12)

* Add GenericTree, BinaryTree and BinarySearchTree.
* Change typing (any --> Any).
* README and `pyproject.toml` changes.

Author: rubenperezm

README.md

@@ -6,13 +6,27 @@
 <!-- [![Python Versions](https://img.shields.io/pypi/pyversions/pystrukts.svg)](https://pypi.org/project/pystrukts) -->
 
 
-A Python library for data structures. This library provides more than 20 advanced data structures not available in the Python standard library, including:
+A Python library for data structures. This library provides more than 20 advanced data structures not available in the Python standard library.
 
+## Installation
+
+```bash
+pip install pystrukts
+```
+
+## Data Structures
+### Lists
+- [x] Singly Linked Node
 - [x] Singly Linked List
+- [x] Doubly Linked Node
 - [x] Doubly Linked List
 - [x] Circular Linked List (Single, Double)
-- [ ] Generic Tree
-- [ ] Binary Search Tree
+- [ ] Skip List
+
+### Trees
+- [x] Binary Tree
+- [x] Generic Tree
+- [x] Binary Search Tree
 - [ ] Ternary Search Tree
 - [ ] Suffix Tree
 - [ ] AVL Tree
@@ -24,9 +38,12 @@ A Python library for data structures. This library provides more than 20 advance
 - [ ] Interval Tree
 - [ ] Segment Tree
 - [ ] Fenwick Tree
-- [x] Disjoint Set
-- [ ] Skip List
 - [x] Trie
+
+### Graphs
+- [x] Adjacency Matrix
+- [x] Adjacency List
+
+### Others
+- [x] Disjoint Set (Union Find)
 - [x] Max Heap
-- [x] Graph (Adjacency Matrix)
-- [x] Graph (Adjacency List)

pyproject.toml

@@ -4,10 +4,9 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pystrukts"
-description = "Advanced data structures for Python."
 readme = "README.md"
 requires-python = ">=3.8"
-dynamic = ["version"]
+dynamic = ["version", "description", "authors", "urls", "keywords"]
 license = { file = "LICENSE" }
 classifiers = [
     "License :: OSI Approved :: Apache Software License",
@@ -22,10 +21,6 @@ classifiers = [
 dependencies = [
 ]
 
-authors = [
-    { name = "Rubén Pérez Mercado", email = "[email protected]" }
-]
-
 [tool.setuptools_scm]
 write_to = "pystrukts/_version.py"
 

pystrukts/list/doubly_linked_list.py

@@ -5,6 +5,7 @@
 '''
 
 from dataclasses import dataclass
+from typing import Any
 from .linked_list import LinkedList
 
 @dataclass
@@ -13,15 +14,15 @@ class DoublyLinkedNode:
     DoublyLinkedNode Class.
 
     Attributes:
-        data (any): The data stored in the node.
+        data (Any): The data stored in the node.
         prev (DoublyLinkedNode): The previous node in the list.
         next (DoublyLinkedNode): The next node in the list.
 
     Methods:
         `__str__()`: Return the string representation of the node.
     '''
 
-    data: any = None
+    data: Any = None
     prev: 'DoublyLinkedNode' = None
     next: 'DoublyLinkedNode' = None
 
@@ -46,14 +47,14 @@ class DoublyLinkedList(LinkedList[DoublyLinkedNode]):
         `iscircular()`: Check if the list is circular.
         `_link(node1: Type[T], node2: Type[T])`: Link two nodes.
         `_preprocess_index(index: int)`: Preprocess the index.
-        `insert(data: any, index: int)`: Insert data at the specified index.
-        `append(data: any)`: Append data to the end of the list.
-        `appendleft(data: any)`: Append data to the beginning of the list.
+        `insert(data: Any, index: int)`: Insert data at the specified index.
+        `append(data: Any)`: Append data to the end of the list.
+        `appendleft(data: Any)`: Append data to the beginning of the list.
         `remove(index: int)`: Remove data at the specified index.
         `pop()`: Remove data from the end of the list.
         `popleft()`: Remove data from the beginning of the list.
         `get(index: int)`: Get data at the specified index.
-        `index(data: any)`: Get the index of the specified data.
+        `index(data: Any)`: Get the index of the specified data.
         `clear()`: Clear the list.
     '''
 
@@ -63,6 +64,7 @@ def __init__(self, circular: bool = False):
     def _link(self, node1: DoublyLinkedNode, node2: DoublyLinkedNode):
         '''
         Link two nodes.
+        Link two nodes.
 
         Args:
             node1 (DoublyLinkedNode): The first node.

pystrukts/list/linked_list.py

@@ -6,7 +6,7 @@
 
 from dataclasses import dataclass
 from abc import ABC, abstractmethod
-from typing import Type, TypeVar, Generic
+from typing import Type, TypeVar, Generic, Any
 
 T = TypeVar('T')
 
@@ -28,14 +28,14 @@ class LinkedList(ABC, Generic[T]):
         `iscircular()`: Check if the list is circular.
         `_link(node1: Type[T], node2: Type[T])`: Link two nodes.
         `_preprocess_index(index: int)`: Preprocess the index.
-        `insert(data: any, index: int)`: Insert data at the specified index.
-        `append(data: any)`: Append data to the end of the list.
-        `appendleft(data: any)`: Append data to the beginning of the list.
+        `insert(data: Any, index: int)`: Insert data at the specified index.
+        `append(data: Any)`: Append data to the end of the list.
+        `appendleft(data: Any)`: Append data to the beginning of the list.
         `remove(index: int)`: Remove data at the specified index.
         `pop()`: Remove data from the end of the list.
         `popleft()`: Remove data from the beginning of the list.
         `get(index: int)`: Get data at the specified index.
-        `index(data: any)`: Get the index of the specified data.
+        `index(data: Any)`: Get the index of the specified data.
         `clear()`: Clear the list.
     '''
 
@@ -72,7 +72,7 @@ def __iter__(self):
             out (Iterator): The iterator for the list.
 
         Yields:
-            out (any): The data in the list.
+            out (Any): The data in the list.
         '''
 
         current_node = self.__head
@@ -125,12 +125,12 @@ def _preprocess_index(self, index: int, insert: bool = False):
 
         return index
 
-    def insert(self, data: any, index: int):
+    def insert(self, data: Any, index: int):
         '''
         Insert data at the specified index.
 
         Args:
-            data (any): The data to be inserted.
+            data (Any): The data to be inserted.
             index (int): The index to insert the data.
         
         Raises:
@@ -158,12 +158,12 @@ def insert(self, data: any, index: int):
 
         self.__length += 1
 
-    def append(self, data: any):
+    def append(self, data: Any):
         '''
         Append data to the end of the list.
 
         Args:
-            data (any): The data to be appended.
+            data (Any): The data to be appended.
         '''
 
         new_node = self.__cls(data)
@@ -181,12 +181,12 @@ def append(self, data: any):
 
         self.__length += 1
 
-    def appendleft(self, data: any):
+    def appendleft(self, data: Any):
         '''
         Append data to the beginning of the list.
 
         Args:
-            data (any): The data to be appended.
+            data (Any): The data to be appended.
         '''
 
         new_node = self.__cls(data)
@@ -212,7 +212,7 @@ def remove(self, index: int):
             index (int): The index to remove the data.
 
         Returns:
-            out (any): The removed data.
+            out (Any): The removed data.
 
         Raises:
             IndexError: If the index is out of bounds.
@@ -243,7 +243,7 @@ def pop(self):
         Extract data from the end of the list.
 
         Returns:
-            out (any): The extracted data.
+            out (Any): The extracted data.
 
         Raises:
             IndexError: If the list is empty.
@@ -275,7 +275,7 @@ def popleft(self):
         Extract data from the beginning of the list.
 
         Returns:
-            out (any): The extracted data.
+            out (Any): The extracted data.
 
         Raises:
             IndexError: If the list is empty.
@@ -308,7 +308,7 @@ def get(self, index: int):
             index (int): The index to get the data.
 
         Returns:
-            out (any): The data at the specified index.
+            out (Any): The data at the specified index.
 
         Raises:
             IndexError: If the index is out of bounds.
@@ -322,12 +322,12 @@ def get(self, index: int):
 
         return current_node.data
 
-    def index(self, data: any):
+    def index(self, data: Any):
         '''
         Get the index of the first occurrence of the specified data.
 
         Args:
-            data (any): The data to search for.
+            data (Any): The data to search for.
 
         Returns:
             out (int): The index of the specified data.

pystrukts/list/singly_linked_list.py

@@ -5,6 +5,7 @@
 '''
 
 from dataclasses import dataclass
+from typing import Any
 from .linked_list import LinkedList
 
 @dataclass
@@ -13,20 +14,19 @@ class SinglyLinkedNode:
     SinglyLinkedNode Class.
 
     Attributes:
-        data (any): The data stored in the node.
+        data (Any): The data stored in the node.
         next (SinglyLinkedNode): The next node in the list.
 
     Methods:
         `__str__()`: Return the string representation of the node.
     '''
 
-    data: any = None
+    data: Any = None
     next: 'SinglyLinkedNode' = None
 
     def __str__(self):
         return f"SinglyLinkedNode({self.data}){' -> ' + str(self.next) if self.next else ''}"
 
-
 class SinglyLinkedList(LinkedList[SinglyLinkedNode]):
     '''
     SinglyLinkedList Class.
@@ -44,14 +44,14 @@ class SinglyLinkedList(LinkedList[SinglyLinkedNode]):
         `iscircular()`: Check if the list is circular.
         `_link(node1: Type[T], node2: Type[T])`: Link two nodes.
         `_preprocess_index(index: int)`: Preprocess the index.
-        `insert(data: any, index: int)`: Insert data at the specified index.
-        `append(data: any)`: Append data to the end of the list.
-        `appendleft(data: any)`: Append data to the beginning of the list.
+        `insert(data: Any, index: int)`: Insert data at the specified index.
+        `append(data: Any)`: Append data to the end of the list.
+        `appendleft(data: Any)`: Append data to the beginning of the list.
         `remove(index: int)`: Remove data at the specified index.
         `pop()`: Remove data from the end of the list.
         `popleft()`: Remove data from the beginning of the list.
         `get(index: int)`: Get data at the specified index.
-        `index(data: any)`: Get the index of the specified data.
+        `index(data: Any)`: Get the index of the specified data.
         `clear()`: Clear the list.
     '''
 
@@ -61,6 +61,7 @@ def __init__(self, circular: bool = False):
     def _link(self, node1: SinglyLinkedNode, node2: SinglyLinkedNode):
         '''
         Link two nodes.
+        Link two nodes.
 
         Args:
             node1 (SinglyLinkedNode): The first node.

pystrukts/max_heap.py

@@ -6,6 +6,7 @@
 '''
 
 from dataclasses import field, dataclass
+from typing import Any
 import heapq
 
 @dataclass
@@ -19,7 +20,7 @@ class MaxHeap:
     Methods:
         `__post_init__()`: Creates the heap from the data.
         `__str__()`: Return the string representation of the heap.
-        `push(value: any)`: Insert a value in the heap.
+        `push(value: Any)`: Insert a value in the heap.
         `pop()`: Extract the maximum value from the heap.
         `peek()`: Peek the maximum value in the heap.
     '''
@@ -36,12 +37,12 @@ def __post_init__(self):
     def __str__(self):
         return f"MaxHeap({[-val for val in self.data]})"
 
-    def push(self, value: any):
+    def push(self, value: Any):
         '''
         Insert a value in the heap.
 
         Args:
-            value (any): The value to be inserted.
+            value (Any): The value to be inserted.
         
         Raises:
             TypeError: If the value is not comparable.
@@ -54,7 +55,7 @@ def pop(self):
         Extract the maximum value from the heap.
 
         Returns:
-            out (any): The maximum value in the heap.
+            out (Any): The maximum value in the heap.
 
         Raises:
             IndexError: If the heap is empty.
@@ -66,6 +67,6 @@ def peek(self):
         Peek the maximum value in the heap.
 
         Returns:
-            out (any): The maximum value in the heap or `None` if the heap is empty.
+            out (Any): The maximum value in the heap or `None` if the heap is empty.
         '''
         return -self.data[0]

pystrukts/tree/__init__.py

@@ -1,3 +1,6 @@
 # pylint: skip-file
 
-from .trie import Trie, TrieNode
+from .trie import Trie, TrieNode
+from .generic_tree import GenericTree
+from .binary_tree import BinaryTree
+from .binary_search_tree import BinarySearchTree