🎉 add scoring block for logical regular expressions

nlpurify/__init__.py

@@ -14,6 +14,7 @@
 
 # init-time options registrations
 from nlpurify.scoring import fuzzy
+from nlpurify.scoring import regexp
 
 from nlpurify.feature import (
     selection as feature_selection

nlpurify/scoring/__init__.py

@@ -9,3 +9,5 @@
     fuzzy_score,
     LogicalFuzzy
 )
+
+from nlpurify.scoring.regexp import LogicalRegexp

nlpurify/scoring/regexp/__init__.py

@@ -7,3 +7,5 @@
 multiple expressions and bound them under a logical operator to find
 sequence and score the same.
 """
+
+from nlpurify.scoring.regexp.logical import LogicalRegexp

nlpurify/scoring/regexp/logical.py

@@ -8,10 +8,48 @@
 and/or conditional statements for the end user.
 """
 
+import re
+
 from typing import List, Iterable
 
 from nlpurify.scoring.baseclass import BaseLogicalOperator
 
 class LogicalRegexp(BaseLogicalOperator):
+    """
+    An Extension to Perform Logical Operations for Regular Expression
+
+    Regular expression are handy when searching for keywords in a
+    sequence of text. This object combines multiple regular expressions
+    and bound them under a logical operator to find sequence and score
+    the same.
+
+    :type  string: str
+    :param string: The original string against which the reference
+        values are to be checked and validated.
+
+    :type  references: list
+    :param references: A list of n-references against which fuzzy
+        score is determined. The score is also a n-length array.
+    """
+
     def __init__(self, string : str, *references : List[str]) -> None:
         super().__init__(string, *references)
+
+
+    def scores(self) -> Iterable[float]:
+        """
+        Finds if the Expression is Found in the Statement
+
+        Given n-references to search in the statement, the function,
+        and returns ``100`` or ``0`` for each reference, for boolean
+        values as scores.
+
+        Caveat:: the score is either ``100`` if ``True`` else ``0``
+        based on the regexp pattern matching.
+        """
+
+        found = [
+            re.findall(pattern, self.string) for pattern in self.references
+        ]
+
+        return [ 100 if li else 0 for li in found ]