named func args properly

Author: rootware

pyredactkit/core_redactor.py

@@ -35,7 +35,7 @@ def __init__(self) -> None:
         """
         return None
 
-    def redact_all(self, line=str) -> tuple:
+    def redact_all(self, line: str) -> tuple:
         """Function to redact specific option
         Args:
             line (str) : line to be supplied to redact
@@ -55,7 +55,7 @@ def redact_all(self, line=str) -> tuple:
                 line = re.sub(redact_pattern, masked_data, line)
         return line, hash_map
 
-    def process_text(self, text=str, savedir="./"):
+    def process_text(self, text: str, savedir="./"):
         """Function to process supplied text from cli.
         Args:
             text (str): string to redact
@@ -83,7 +83,7 @@ def process_text(self, text=str, savedir="./"):
             print(
                 f"[+] Redacted and results saved to {os.path.basename(generated_file)}")
 
-    def process_core_file(self, filename, savedir="./"):
+    def process_core_file(self, filename: str, savedir="./"):
         """Function to process supplied file from cli.
         Args:
             filename (str): File to redact

pyredactkit/custom_redactor.py

@@ -29,7 +29,7 @@ def __init__(self) -> None:
         """
         return None
 
-    def read_custom_patterns(self, custom_file) -> list:
+    def read_custom_patterns(self, custom_file: str) -> list:
         '''Load Rules
         Loads either a default ruleset or a self defined ruleset.
         Rules are loaded to patterns variable
@@ -46,12 +46,11 @@ def read_custom_patterns(self, custom_file) -> list:
         except json.JSONDecodeError:
             sys.exit("[-] Issue decoding json file. This might be an error with your regex pattern.")
 
-    def redact_custom(self, line=str, customfile=str) -> tuple:
+    def redact_custom(self, line: str, customfile: str) -> tuple:
         """Function to redact custom option
         Args:
             line (str) : line to be supplied to redact
-            option (str): (optional) choice for redaction
-            filename (str): name of supplied file
+            customfile (str): (optional) choice for redaction
 
         Returns:
             line (str): redacted line
@@ -69,7 +68,7 @@ def redact_custom(self, line=str, customfile=str) -> tuple:
                 line = re.sub(redact_pattern, masked_data, line)
         return line, kv_pairs
 
-    def process_custom_file(self, file_name, customfile=str, make_dir="./"):
+    def process_custom_file(self, file_name: str, customfile: str, make_dir="./"):
         """Function to process supplied file with custom regex file from cli.
         Args:
             file_name (str): File to redact

pyredactkit/identifiers.py

@@ -45,7 +45,7 @@ class Identifier:
     def __init__(self) -> None:
         return None
 
-    def names(self, data) -> list:
+    def names(self, data: str) -> list:
         """ Identify names and return them from the supplied data
         Args:
             data (str): data in alpha-numeric format

pyredactkit/unredact.py

@@ -20,7 +20,7 @@ def __init__(self) -> None:
             None
         """
 
-    def replace_all(self, text, dictionary) -> str:
+    def replace_all(self, text: str, dictionary: dict) -> str:
         """Function to replace all the text from string
         Args:
             text (str): A line of text in string format
@@ -33,7 +33,7 @@ def replace_all(self, text, dictionary) -> str:
             text = text.replace(k, v)
         return text
 
-    def unredact(self, redacted_file=str, lookup_file=str) -> None:
+    def unredact(self, redacted_file: str, lookup_file: str) -> None:
         """Function to unredact masked data and produces original unredacted data.
         Args:
             redacted_file (str): Name of the redacted file