Merge pull request #19 from nightfallai/dan/plat-1320-add-context-bytes-to-python

add context byte setting

Author: Dan Hertz

nightfall/api.py

@@ -52,7 +52,8 @@ def __init__(self, key: Optional[str] = None, signing_secret: Optional[str] = No
         self.logger = logging.getLogger(__name__)
 
     def scan_text(self, texts: List[str], detection_rules: Optional[List[DetectionRule]] = None,
-                  detection_rule_uuids: Optional[List[str]] = None) -> Tuple[List[List[Finding]], List[str]]:
+                  detection_rule_uuids: Optional[List[str]] = None, context_bytes: Optional[int] = None) ->\
+            Tuple[List[List[Finding]], List[str]]:
         """Scan text with Nightfall.
 
         This method takes the specified config and then makes
@@ -67,6 +68,8 @@ def scan_text(self, texts: List[str], detection_rules: Optional[List[DetectionRu
         :param detection_rule_uuids: List of detection rule UUIDs to scan each text with.
             These can be created in the Nightfall UI.
         :type detection_rule_uuids: List[str] or None
+        :param context_bytes: The number of bytes of context (leading and trailing) to return with any matched findings.
+        :type context_bytes: int or None
         :returns: list of findings, list of redacted input texts
         """
 
@@ -78,6 +81,8 @@ def scan_text(self, texts: List[str], detection_rules: Optional[List[DetectionRu
             config["detectionRuleUUIDs"] = detection_rule_uuids
         if detection_rules:
             config["detectionRules"] = [d.as_dict() for d in detection_rules]
+        if context_bytes:
+            config["contextBytes"] = context_bytes
         request_body = {
             "payload": texts,
             "config": config

nightfall/detection_rules.py

@@ -182,7 +182,7 @@ class Detector:
         context_rules (List[ContextRule] or None): The context rules to use to customize the behavior of this detector.
         exclusion_rules (List[ExclusionRule] or None): The exclusion rules to use to customize the behavior of this
             detector.
-        redaction_config (RedactionConfig or None): Sets the redaction configuration to-be-applied to this detector.
+        redaction_config (RedactionConfig or None): The redaction configuration to-be-applied to this detector.
             This configuration is currently only supported for scanning plaintext, not for file scanning.
     """
     min_confidence: Confidence

tests/test_api.py

@@ -29,15 +29,16 @@ def test_scan_text_detection_rules_v3(nightfall):
                      redaction_config=RedactionConfig(remove_finding=False,
                                                       mask_config=MaskConfig(masking_char='👀',
                                                                              num_chars_to_leave_unmasked=3,
-                                                                             chars_to_ignore=["-"]))
-                     )])]
+                                                                             chars_to_ignore=["-"])),
+                     )])],
+        context_bytes=10,
     )
 
     assert len(result) == 1
     assert result[0][0] == Finding(
         "4916-6734-7572-5015",
         '491👀-👀👀👀👀-👀👀👀👀-👀👀👀👀',
-        None, None,
+        None, " is my cre",
         "Credit Card Number",
         result[0][0].detector_uuid,
         Confidence.VERY_LIKELY,