blitztext 0.2.1__cp315-cp315-win_amd64.whl

blitztext/__init__.py

@@ -0,0 +1,5 @@
+from .blitztext import *
+
+__doc__ = blitztext.__doc__
+if hasattr(blitztext, "__all__"):
+    __all__ = blitztext.__all__

blitztext/__init__.pyi

@@ -0,0 +1,159 @@
+from typing import Dict, List, Optional, Tuple
+
+class KeywordMatch:
+    """
+    Represents a matched keyword in the text.
+
+    Attributes:
+        keyword (str): The matched keyword or its clean name.
+        similarity (float): The similarity score of the match (1.0 for exact matches).
+        start (int): UTF-8 byte offset where the match starts in the text.
+        end (int): UTF-8 byte offset where the match ends in the text.
+    """
+    keyword: str
+    similarity: float
+    start: int
+    end: int
+
+    def __repr__(self) -> str:
+        """
+        Returns a string representation of the KeywordMatch object.
+        """
+        ...
+
+class KeywordProcessor:
+    """
+    A processor for efficient keyword matching and replacement in text.
+
+    Based on AhoCorasick for fast keyword operations,
+    including fuzzy matching capabilities.
+    """
+
+    def __init__(self, case_sensitive: Optional[bool] = None, allow_overlaps: Optional[bool] = None) -> None:
+        """
+        Initialize a new KeywordProcessor.
+
+        Args:
+            case_sensitive: If True, matching will be case-sensitive. Default is False.
+            allow_overlaps: If True, allows overlapping matches. Default is True.
+        """
+        ...
+
+    def add_keyword(self, keyword: str, clean_name: Optional[str] = None) -> None:
+        """
+        Add a keyword to the processor.
+
+        Args:
+            keyword: The keyword to add.
+            clean_name: An optional 'clean' version of the keyword to return when found.
+        """
+        ...
+
+    def remove_keyword(self, keyword: str) -> bool:
+        """
+        Remove a keyword from the processor.
+
+        Args:
+            keyword: The keyword to remove.
+
+        Returns:
+            True if the keyword was found and removed, False otherwise.
+        """
+        ...
+
+    def extract_keywords(self, text: str, threshold: Optional[float] = None) -> List[KeywordMatch]:
+        """
+        Extract keywords from the given text.
+
+        Args:
+            text: The text to search for keywords.
+            threshold: Threshold for fuzzy matching (0.0 to 1.0). Default is 1.0 (exact matches only).
+
+        Returns:
+            A list of KeywordMatch objects representing the found keywords.
+        """
+        ...
+
+    def parallel_extract_keywords_from_texts(self, texts: List[str], threshold: Optional[float] = None) -> List[List[KeywordMatch]]:
+        """
+        Extract keywords from multiple texts in parallel.
+
+        Args:
+            texts: A list of texts to search for keywords.
+            threshold: Threshold for fuzzy matching (0.0 to 1.0). Default is 1.0 (exact matches only).
+
+        Returns:
+            A list of lists of KeywordMatch objects, one list per input text.
+        """
+        ...
+
+    def replace_keywords(self, text: str, threshold: Optional[float] = None) -> str:
+        """
+        Replace keywords in the given text with their clean names.
+
+        Args:
+            text: The text in which to replace keywords.
+            threshold: Threshold for fuzzy matching (0.0 to 1.0). Default is 1.0 (exact matches only).
+
+        Returns:
+            The text with keywords replaced by their clean names.
+        """
+        ...
+
+    def parallel_replace_keywords_from_texts(self, texts: List[str], threshold: Optional[float] = None) -> List[str]:
+        """
+        Replace keywords in multiple texts in parallel.
+
+        Args:
+            texts: A list of texts in which to replace keywords.
+            threshold: Threshold for fuzzy matching (0.0 to 1.0). Default is 1.0 (exact matches only).
+
+        Returns:
+            A list of strings with keywords replaced by their clean names.
+        """
+        ...
+
+    def get_all_keywords(self) -> Dict[str, str]:
+        """
+        Get all keywords and their clean names.
+
+        Returns:
+            A dictionary where keys are keywords and values are their clean names.
+        """
+        ...
+
+    def set_non_word_boundaries(self, boundaries: List[str]) -> None:
+        """
+        Set the characters that are considered part of a word.
+
+        Args:
+            boundaries: A list of characters to be set as non-word boundaries.
+        """
+        ...
+
+    def add_non_word_boundary(self, boundary: str) -> None:
+        """
+        Add a single character as a non-word boundary.
+
+        Args:
+            boundary: The character to be added as a non-word boundary.
+        """
+        ...
+
+    def __len__(self) -> int:
+        """
+        Get the number of keywords in the processor.
+
+        Returns:
+            The number of keywords.
+        """
+        ...
+
+    def __repr__(self) -> str:
+        """
+        Get a string representation of the KeywordProcessor.
+
+        Returns:
+            A string representation including the number of keywords.
+        """
+        ...

blitztext-0.2.1.dist-info/METADATA

@@ -0,0 +1,8 @@
+Metadata-Version: 2.4
+Name: blitztext
+Version: 0.2.1
+Classifier: Programming Language :: Rust
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+License-File: LICENSE
+Requires-Python: >=3.8

blitztext-0.2.1.dist-info/RECORD

@@ -0,0 +1,9 @@
+blitztext/__init__.py,sha256=pOLO1hwZxoTihScRSVIFZYggcF89bbSUaeAETVbzv5E,119
+blitztext/__init__.pyi,sha256=YLI13c7VeU94xebRbGJC17xXJV5_UEXjUUlBnf2OKm8,4988
+blitztext/blitztext.cp315-win_amd64.pyd,sha256=-jhmzcaO3glTHG3alNMziGVgelRFgAP9rTvIKNV70ww,490496
+blitztext/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+blitztext-0.2.1.dist-info/METADATA,sha256=Muoj2NSE6KEwN6JNkwLyVQ0Phofe_SiF5g_MYqNFZHY,280
+blitztext-0.2.1.dist-info/WHEEL,sha256=1_h6kx0k2_JFDbRzyfVOsGEcPlSNf1uBTnmW3MNufiU,97
+blitztext-0.2.1.dist-info/licenses/LICENSE,sha256=M96WJMlfMKb2MSk9-Wnb432DqTdlu9qQiuLS0vutwEY,1119
+blitztext-0.2.1.dist-info/sboms/blitztext.cyclonedx.json,sha256=bJ3LdsMBDx4-NBpcndemf8m0lpmKd01ff_8qw-geGsk,44467
+blitztext-0.2.1.dist-info/RECORD,,

blitztext-0.2.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.15.0)
+Root-Is-Purelib: false
+Tag: cp315-cp315-win_amd64

blitztext-0.2.1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Praise Oketola (oketola.praise@gmail.com)
+
+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.