tinytrie 0.1.0__py3-none-any.whl

tinytrie-0.1.0.dist-info/METADATA

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: tinytrie
+Version: 0.1.0
+Summary: A minimal type-safe trie (prefix tree) implementation in Python.
+Author-email: Jifeng Wu <jifengwu2k@gmail.com>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/jifengwu2k/tinytrie
+Project-URL: Bug Tracker, https://github.com/jifengwu2k/tinytrie/issues
+Keywords: trie,prefix tree,data structure,python
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# TinyTrie
+
+A minimal and type-safe trie (prefix tree) implementation for Python 3.6+.
+
+TinyTrie provides basic operations on Tries:
+- Insertion of sequences (`search_or_create`)
+- Search for sequences (`search`)
+- Find the longest common prefix (`longest_common_prefix`)
+- Collect all stored sequences (`collect_sequences`)
+
+It supports any type of keys and values using Python's type hints.
+
+## Features
+
+- **Typed**: Works with arbitrary key and value types (`Generic[K, V]`)
+- **Minimal**: Only essential functionalities
+- **Efficient**: Memory-efficient with `__slots__`
+- **Iterable**: Easily traverse and list all stored sequences
+- **No external dependencies**
+
+## Example Usage
+
+```python
+from tinytrie import TrieNode, search, search_or_create, longest_common_prefix, collect_sequences
+
+# Create the root node
+root = TrieNode[str, int]()
+
+# Insert sequences
+search_or_create(root, ['a', 'b', 'c'], value=1)
+search_or_create(root, ['a', 'b', 'd'], value=2)
+
+# Search for a sequence
+node = search(root, ['a', 'b', 'c'])
+if node is not None:
+    print(f"Found with value: {node.value}")
+
+# Find the longest common prefix
+prefix, node = longest_common_prefix(root)
+print(f"Longest common prefix: {prefix}")
+
+# Collect all sequences
+for seq, node in collect_sequences(root):
+    print(f"Sequence: {seq}, Value: {node.value}")
+```
+
+Output:
+
+```
+Found with value: 1
+Longest common prefix: ['a', 'b']
+Sequence: ['a', 'b', 'c'], Value: 1
+Sequence: ['a', 'b', 'd'], Value: 2
+```
+
+## Installation
+
+
+```bash
+pip install tinytrie
+```
+
+## License
+
+MIT License

tinytrie-0.1.0.dist-info/RECORD

@@ -0,0 +1,6 @@
+tinytrie.py,sha256=LLAtTVhOPH8d5qvoUHt7hIuucb9uHsAl7gC-5vBLH70,2289
+tinytrie-0.1.0.dist-info/licenses/LICENSE,sha256=FZ9XWedK_wQ4wfqVanrQVQpArRHDkxwxic2rgii1pZg,1066
+tinytrie-0.1.0.dist-info/METADATA,sha256=_Jr-3DZvHXuyyKEKl8O6kPUEjNsyqyoie8g2_6m2La0,2139
+tinytrie-0.1.0.dist-info/WHEEL,sha256=SmOxYU7pzNKBqASvQJ7DjX3XGUF92lrGhMb3R6_iiqI,91
+tinytrie-0.1.0.dist-info/top_level.txt,sha256=LmhFpKkudLkEcL3grI6tGPlXow6ouTLGawd4KyatyVw,9
+tinytrie-0.1.0.dist-info/RECORD,,

tinytrie-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (79.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

tinytrie-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jifeng Wu
+
+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.

tinytrie-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+tinytrie

tinytrie.py

@@ -0,0 +1,84 @@
+# tinytrie: A minimal and type-safe trie (prefix tree) implementation in Python.
+# Copyright (c) 2025 Jifeng Wu
+# Licensed under the MIT License. See LICENSE file in the project root for full license information.
+from typing import TypeVar, Generic, Dict, Optional, Sequence, List, Tuple, Iterator
+
+
+__all__ = [
+    "TrieNode",
+    "search",
+    "search_or_create",
+    "longest_common_prefix",
+    "collect_sequences",
+]
+
+
+K = TypeVar("K")
+V = TypeVar("V")
+
+
+class TrieNode(Generic[K, V]):
+    __slots__ = ("children", "is_end", "value")
+
+    children: Dict[K, "TrieNode[K, V]"]
+    is_end: bool
+    value: Optional[V]
+
+    def __init__(self):
+        self.children = {}
+        self.is_end = False
+        self.value = None
+
+
+def search(root: TrieNode[K, V], sequence: Sequence[K]) -> Optional[TrieNode[K, V]]:
+    if not sequence:
+        return root if root.is_end else None
+    first, remaining = sequence[0], sequence[1:]
+    if first not in root.children:
+        return None
+    return search(root.children[first], remaining)
+
+
+def search_or_create(
+    root: TrieNode[K, V], sequence: Sequence[K], value: Optional[V] = None
+) -> TrieNode[K, V]:
+    if not sequence:
+        if not root.is_end:
+            root.is_end = True
+            root.value = value
+        return root
+    first, remaining = sequence[0], sequence[1:]
+    if first not in root.children:
+        root.children[first] = TrieNode()
+    return search_or_create(root.children[first], remaining, value)
+
+
+def longest_common_prefix(root: TrieNode[K, V]) -> Tuple[Sequence[K], TrieNode[K, V]]:
+    prefix = []
+    node = root
+
+    while True:
+        # Stop if node is end of word or has multiple children
+        if node.is_end or len(node.children) != 1:
+            break
+        # Get the only child
+        key, next_node = next(iter(node.children.items()))
+        prefix.append(key)
+        node = next_node
+
+    return prefix, node
+
+
+def collect_sequences(
+    root: TrieNode[K, V], prefix: Optional[List[K]] = None
+) -> Iterator[Tuple[List[K], TrieNode[K, V]]]:
+    if prefix is None:
+        prefix = []
+
+    if root.is_end:
+        yield prefix.copy(), root
+
+    for key, child in root.children.items():
+        prefix.append(key)
+        yield from collect_sequences(child, prefix)
+        prefix.pop()