add optional type hints

Author: Dan Hertz

nightfall/api.py

@@ -10,7 +10,7 @@
 import json
 import logging
 import os
-from typing import List, Tuple
+from typing import List, Tuple, Optional
 
 import requests
 
@@ -27,7 +27,7 @@ class Nightfall:
     FILE_SCAN_COMPLETE_ENDPOINT = PLATFORM_URL + "/v3/upload/{0}/finish"
     FILE_SCAN_SCAN_ENDPOINT = PLATFORM_URL + "/v3/upload/{0}/scan"
 
-    def __init__(self, key: str = None, signing_secret: str = None):
+    def __init__(self, key: Optional[str] = None, signing_secret: Optional[str] = None):
         """Instantiate a new Nightfall object.
         :param key: Your Nightfall API key. If None it will be read from the environment variable NIGHTFALL_API_KEY.
         :type key: str or None
@@ -51,8 +51,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_rules: List[DetectionRule] = None,
-                  detection_rule_uuids: List[str] = None) -> Tuple[List[List[Finding]], List[str]]:
+    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]]:
         """Scan text with Nightfall.
 
         This method takes the specified config and then makes
@@ -111,9 +111,9 @@ def _scan_text_v3(self, data: dict):
 
     # File Scan
 
-    def scan_file(self, location: str, webhook_url: str = None, policy_uuid: str = None,
-                  detection_rules: List[DetectionRule] = None, detection_rule_uuids: List[str] = None,
-                  ) -> Tuple[str, str]:
+    def scan_file(self, location: str, webhook_url: Optional[str] = None, policy_uuid: Optional[str] = None,
+                  detection_rules: Optional[List[DetectionRule]] = None,
+                  detection_rule_uuids: Optional[List[str]] = None) -> Tuple[str, str]:
         """Scan file with Nightfall.
         At least one of policy_uuid, detection_rule_uuids or detection_rules is required.
 
@@ -200,8 +200,9 @@ def _file_scan_finalize(self, session_id: str):
         )
         return response
 
-    def _file_scan_scan(self, session_id: str, detection_rules: List[DetectionRule] = None,
-                        detection_rule_uuids: List[str] = None, webhook_url: str = None, policy_uuid: str = None):
+    def _file_scan_scan(self, session_id: str, detection_rules: Optional[List[DetectionRule]] = None,
+                        detection_rule_uuids: Optional[List[str]] = None, webhook_url: Optional[str] = None,
+                        policy_uuid: Optional[str] = None) -> requests.Response:
         if policy_uuid:
             data = {"policyUUID": policy_uuid}
         else:

nightfall/detection_rules.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 from enum import Enum
-from typing import List
+from typing import List, Optional
 
 from nightfall.exceptions import NightfallUserError
 
@@ -81,8 +81,8 @@ class ExclusionRule:
         word_list (WordList or None): The list of words to compare to a candidate finding.
     """
     match_type: MatchType
-    regex: Regex = None
-    word_list: WordList = None
+    regex: Optional[Regex] = None
+    word_list: Optional[WordList] = None
 
     def __post_init__(self):
         if (not self.regex and not self.word_list) or (self.regex and self.word_list):
@@ -137,15 +137,15 @@ class RedactionConfig:
     Attributes:
         remove_finding (bool): Whether the original finding should be omitted in responses from the API.
         mask_config (MaskConfig): Build a redaction config with masking.
-        substitution_phrase (str or None): Build a redaction config with info type substitution.
+        substitution_phrase (str or None): Build a redaction config with a substitution phrase.
         infotype_substitution (bool or None): Build a redaction config with info type substitution.
         public_key (str or None): Build a redaction config with RSA encryption.
     """
     remove_finding: bool
-    mask_config: MaskConfig = None
-    substitution_phrase: str = None
+    mask_config: Optional[MaskConfig] = None
+    substitution_phrase: Optional[str] = None
     infotype_substitution: bool = False
-    public_key: str = None
+    public_key: Optional[str] = None
 
     def __post_init__(self):
         config_counts = [self.mask_config, self.substitution_phrase, self.public_key].count(None)
@@ -187,14 +187,14 @@ class Detector:
     """
     min_confidence: Confidence
     min_num_findings: int = 1
-    nightfall_detector: str = None
-    regex: Regex = None
-    word_list: WordList = None
-    uuid: str = None
-    display_name: str = None
-    context_rules: List[ContextRule] = None
-    exclusion_rules: List[ExclusionRule] = None
-    redaction_config: RedactionConfig = None
+    nightfall_detector: Optional[str] = None
+    regex: Optional[Regex] = None
+    word_list: Optional[WordList] = None
+    uuid: Optional[str] = None
+    display_name: Optional[str] = None
+    context_rules: Optional[List[ContextRule]] = None
+    exclusion_rules: Optional[List[ExclusionRule]] = None
+    redaction_config: Optional[RedactionConfig] = None
 
     def __post_init__(self):
         if [self.nightfall_detector, self.regex, self.word_list, self.uuid].count(None) != 3: