Fix type annotations for older python

Author: Dan Hertz

.github/workflows/build-test.yml

@@ -31,4 +31,4 @@ jobs:
           NIGHTFALL_API_KEY: ${{ secrets.NIGHTFALL_API_KEY }}
           WEBHOOK_ENDPOINT: ${{ secrets.WEBHOOK_ENDPOINT }}
         run: |
-          pytest --cov=nightfall --cov-report term-missing tests
+          pytest -m "not filetest" --cov=nightfall --cov-report term-missing tests

nightfall/api.py

@@ -10,6 +10,8 @@
 import json
 import logging
 import os
+from typing import List
+
 import requests
 
 from nightfall.detection_rules import DetectionRule
@@ -48,8 +50,8 @@ def __init__(self, key: str = None, signing_secret: str = None):
         self.signing_secret = signing_secret
         self.logger = logging.getLogger(__name__)
 
-    def scan_text(self, texts: list[str], detection_rule_uuids: list[str] = None,
-                  detection_rules: list[DetectionRule] = None) -> [list[list[Finding]], list[str]]:
+    def scan_text(self, texts: List[str], detection_rule_uuids: List[str] = None,
+                  detection_rules: List[DetectionRule] = None) -> [List[List[Finding]], List[str]]:
         """Scan text with Nightfall.
 
         This method takes the specified config and then makes
@@ -58,12 +60,12 @@ def scan_text(self, texts: list[str], detection_rule_uuids: list[str] = None,
 
 
         :param texts: List of strings to scan.
-        :type texts: list[str]
+        :type texts: List[str]
         :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
+        :type detection_rule_uuids: List[str] or None
         :param detection_rules: List of detection rules to scan each text with.
-        :type detection_rules: list[DetectionRule] or None
+        :type detection_rules: List[DetectionRule] or None
         :returns: list of findings, list of redacted input texts
         """
 
@@ -109,7 +111,7 @@ def _scan_text_v3(self, data):
     # File Scan
 
     def scan_file(self, location: str, webhook_url: str, policy_uuid: str = None,
-                  detection_rule_uuids: list[str] = None, detection_rules: list[DetectionRule] = None,
+                  detection_rule_uuids: List[str] = None, detection_rules: List[DetectionRule] = None,
                   ) -> [str, str]:
         """Scan file with Nightfall.
         At least one of policy_uuid, detection_rule_uuids or detection_rules is required.
@@ -119,9 +121,9 @@ def scan_file(self, location: str, webhook_url: str, policy_uuid: str = None,
         :param policy_uuid: policy UUID.
         :type policy_uuid: str or None
         :param detection_rule_uuids: list of detection rule UUIDs.
-        :type detection_rule_uuids: list[str] or None
+        :type detection_rule_uuids: List[str] or None
         :param detection_rules: list of detection rules.
-        :type detection_rules: list[DetectionRule] or None
+        :type detection_rules: List[DetectionRule] or None
         :returns: (scan_id, message)
         """
 
@@ -198,7 +200,7 @@ def _file_scan_finalize(self, session_id):
         return response
 
     def _file_scan_scan(self, session_id: str, webhook_url: str, policy_uuid: str,
-                        detection_rule_uuids: str, detection_rules: list[DetectionRule]):
+                        detection_rule_uuids: str, detection_rules: List[DetectionRule]):
         if policy_uuid:
             data = {"policyUUID": policy_uuid}
         else:

nightfall/detection_rules.py

@@ -1,4 +1,5 @@
 from enum import Enum
+from typing import List
 
 from nightfall.exceptions import NightfallUserError
 
@@ -21,10 +22,10 @@ def as_dict(self):
 
 class WordList:
     """A list of words that can be used to customize the behavior of a detector while Nightfall performs a scan."""
-    def __init__(self, word_list: list[str], is_case_sensitive: bool):
+    def __init__(self, word_list: List[str], is_case_sensitive: bool):
         """Instantiate a WordList object
         :param word_list: The list of words to use.
-        :type word_list: list[str]
+        :type word_list: List[str]
         :param is_case_sensitive: Whether to make matches have the same case as each word given
         :type is_case_sensitive: bool
         """
@@ -106,7 +107,7 @@ def as_dict(self):
 class MaskConfig:
     """An object that specifies how findings should be masked when returned by the API."""
     def __init__(self, masking_char: chr, num_chars_to_leave_unmasked: int = 0,
-                 mask_right_to_left: bool = False, chars_to_ignore: list[chr] = []):
+                 mask_right_to_left: bool = False, chars_to_ignore: List[chr] = []):
         """Instantiate a MaskConfig object
         :param masking_char: character that will be repeated to replace the finding.
             This character may be a multi-byte character, but it must be exactly one codepoint.
@@ -118,7 +119,7 @@ def __init__(self, masking_char: chr, num_chars_to_leave_unmasked: int = 0,
         :type mask_right_to_left: bool
         :param chars_to_ignore: the set of characters to leave unmasked when the finding is returned. These characters
             may be multi-byte characters, but each entry in the array must be exactly one codepoint.
-        :type chars_to_ignore: list[chr]
+        :type chars_to_ignore: List[chr]
         """
         self.masking_char = masking_char
         self.num_chars_to_leave_unmasked = num_chars_to_leave_unmasked
@@ -204,8 +205,8 @@ def __init__(
             word_list: WordList = None,
             uuid: str = None,
             display_name: str = None,
-            context_rules: list[ContextRule] = None,
-            exclusion_rules: list[ExclusionRule] = None,
+            context_rules: List[ContextRule] = None,
+            exclusion_rules: List[ExclusionRule] = None,
             redaction_config: RedactionConfig = None
     ):
         """Instantiate a Detector object.
@@ -226,9 +227,9 @@ def __init__(
         :param display_name: A display name for this detector.
         :type display_name: str or None
         :param context_rules: The context rules to use to customize the behavior of this detector.
-        :type context_rules: list[ContextRule] or None
+        :type context_rules: List[ContextRule] or None
         :param exclusion_rules: The exclusion rules to use to customize the behavior of this detector.
-        :type exclusion_rules: list[ExclusionRule] or None
+        :type exclusion_rules: List[ExclusionRule] or None
         :param redaction_config: Sets the redaction configuration to-be-applied to this detector. This configuration is
             currently only supported for scanning plaintext, not for file scanning.
         :type redaction_config: RedactionConfig or None
@@ -284,10 +285,10 @@ class LogicalOp(Enum):
 
 class DetectionRule:
     """An object that contains a set of detectors to be used when scanning content."""
-    def __init__(self, detectors: list[Detector], logical_op: LogicalOp = LogicalOp.ANY):
+    def __init__(self, detectors: List[Detector], logical_op: LogicalOp = LogicalOp.ANY):
         """Instantiate a DetectionRule
         :param detectors: A list of Detectors to scan content with.
-        :type detectors: list[Detector]
+        :type detectors: List[Detector]
         :param logical_op: The method for combining the detectors. One of:
           - LogicalOp.ANY (logical or, i.e. a finding is emitted only if any of the provided detectors match)
           - LogicalOp.ALL (logical and, i.e. a finding is emitted only if all provided detectors match)

nightfall/findings.py

@@ -1,3 +1,5 @@
+from typing import List
+
 from nightfall.detection_rules import Confidence
 
 
@@ -26,8 +28,8 @@ def __init__(self,
                  confidence: Confidence,
                  byte_range: Range,
                  codepoint_range: Range,
-                 matched_detection_rule_uuids: list[str],
-                 matched_detection_rules: list[str]):
+                 matched_detection_rule_uuids: List[str],
+                 matched_detection_rules: List[str]):
         """Instantiate a Finding object.
         :param finding: The data that triggered a detector match.
 
@@ -51,10 +53,10 @@ def __init__(self,
         :type codepoint_range: Range
         :param matched_detection_rule_uuids: The list of detection rule UUIDs that contained a detector that triggered a
             match.
-        :type matched_detection_rule_uuids: list[str]
+        :type matched_detection_rule_uuids: List[str]
         :param matched_detection_rules: The list of inline detection rules that contained a detector that triggered a
             match.
-        :type matched_detection_rules: list[str]
+        :type matched_detection_rules: List[str]
         """
         self.finding = finding
         self.redacted_finding = redacted_finding

tests/test_api.py

@@ -21,6 +21,7 @@ def test_scan_text_detection_rules_v3(nightfall):
     assert len(result) == 1
 
 
+@pytest.mark.filetest
 def test_scan_file_detection_rules(nightfall):
     file = "file.txt"