Merge pull request #32 from IceTheDev2/change-automatically-change-an-invalid-number-to-the-closest-valid-number

Change automatically change an invalid number to the closest valid number

Author: IceTheCoder

code/generate_password_gui.py

@@ -1,6 +1,6 @@
 import tkinter as tk
 
-import generate_password_logic
+import generate_password_logic as logic
 
 title_font = 'Helvetica 24'
 section_title_font = 'Helvetica 16'
@@ -15,11 +15,11 @@
 no_character_set_error = 'An error occurred. Try again with at least 1 character set.'
 double_error = 'An error occurred. Try again with at least 1 character set and a whole number between 4 and 100.'
 
-def show_generate_password_frame(frame, done_btn_image) -> None:
+def create_generate_password_frame(frame, done_btn_image) -> None:
     '''
     Called upon starting the program,
     this function uses the Tkinter module to create a GUI frame to generate passwords with various options for customisation
-    (length and character sets)
+    (length and character sets),
     and serves as a hub for all other password generation functions.
 
     Parameters
@@ -38,8 +38,6 @@ def show_generate_password_frame(frame, done_btn_image) -> None:
     password_label_4 = tk.Text(frame, width = password_width, height = password_height,
                                borderwidth = password_border_width, font = password_font)
     password_labels = [password_label_1, password_label_2, password_label_3, password_label_4]
-
-    global copy_button
 
     frame_title = tk.Label(frame, text = 'Generate password', font = title_font)
     frame_title.grid(column = 0, row = 1, columnspan = 2)
@@ -67,38 +65,47 @@ def show_generate_password_frame(frame, done_btn_image) -> None:
     punctuation_text = tk.Label(frame, text = 'Punctuation', font = description_font)
 
     checkboxes = [lowercase_letters_checkbox, uppercase_letters_checkbox, digits_checkbox, punctuation_checkbox]
-    checkboxes_text = [lowercase_letters_text, uppercase_letters_text, digits_text, punctuation_text]
+    checkboxes_text_labels = [lowercase_letters_text, uppercase_letters_text, digits_text, punctuation_text]
 
     for checkbox in checkboxes:
         checkbox.grid(column = 1, row = 5 + checkboxes.index(checkbox), pady = 8)
         checkbox.select()
 
-    for text in checkboxes_text:
-        text.grid(column = 2, row = 5 + checkboxes_text.index(text), sticky = 'w')
+    for text in checkboxes_text_labels:
+        text.grid(column = 2, row = 5 + checkboxes_text_labels.index(text), sticky = 'w')
 
     def create_password_labels(event) -> None:
         '''
         Called upon clicking the done button or pressing the ENTER key,
-        this function validates the user input.
-        If it is valid, this function uses the show_text function to display a password,
-        else it uses the same function to display an adequate error given through the validate_input function of generate_password_logic.py
+        this function calls determine_error and validate_character_sets of generate_password_logic,
+        and then settles whether an error has occurred or not.
+        If an error has occurred, the function displays said error 
+        (obtained through determine_error),
+        and displays it on the screen through show_text.
+        If an error has not occurred, the function calls generate_password of generate_password_logic.py to get 4 passwords,
+        and calls the show_text function to display them to the user.
 
         Parameters
         ----------
         event:
             Necessary for initiating the function when pressing the ENTER key.
         '''
-        text = generate_password_logic.validate_input(input_box.get(), lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var, no_character_set_error, input_box, double_error, invalid_input_error)
-        
-        # Check if an error is NOT returned.
-        if text == None:
+        text = logic.determine_error(logic.validate_character_sets(lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var), 
+                                                input_box.get(), no_character_set_error, double_error, invalid_input_error)
+
+        if text == '':
             for password_label in password_labels:
-                password_label.bind('<ButtonRelease>', lambda event: generate_password_logic.show_copy_button(event, copy_button))
+                password_label.bind('<ButtonRelease>', lambda event: logic.show_copy_button(event, copy_button))
+
+                adapted_input = logic.adapt_input(input_box.get())
+                input_box.delete(0, 'end')
+                input_box.insert(1, adapted_input)
 
-                text = generate_password_logic.generate_password(input_box.get(), lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var)
+                text = logic.generate_password(adapted_input, lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var)
                 show_text(password_label, text)
                 password_label.grid(column = 0, row = 5 + password_labels.index(password_label), pady = 10, padx = 10)
         else:
+            input_box.delete(0, 'end')
             password_label_1.grid(column = 0, row = 5, padx = 10, pady = 10)
             show_text(password_label_1, text)
 
@@ -111,13 +118,14 @@ def create_password_labels(event) -> None:
     done_btn.grid(column = 0, row = 4, columnspan = 2)
 
     copy_button = tk.Menu(frame, tearoff = False)
-    copy_button.add_command(label = 'Copy', command = lambda: generate_password_logic.copy_text(input_box, password_labels))
+    copy_button.add_command(label = 'Copy', command = lambda: logic.copy_text(input_box, password_labels))
 
     def show_text(label, text) -> None:
         '''
         Called by the create_password_labels function,
         this function updates the contents of the password_labels,
-        by enabling the label, deleting its current contents, inserting the new text, and then disabling the label again.
+        by enabling the label, deleting its current contents, 
+        inserting the new text, and then disabling the label again.
 
         Parameters
         ----------
@@ -135,7 +143,7 @@ def show_text(label, text) -> None:
 def select_input_box(event) -> None:
     '''
     Called whenever the tab is changed,
-    this function focuses to the input box,
+    this function focuses the keyboard to the input box,
     which allows the user to start typing immediately without having to click on the input box first.
     '''
     input_box.focus()

code/generate_password_logic.py

@@ -1,58 +1,93 @@
 import string
 import secrets
-from pynput.keyboard import Key, Controller
 import clipboard
+from pynput.keyboard import Key, Controller
 
 keyboard = Controller()
 
-def validate_input(requested_password_length, lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var, no_character_set_error, input_box, double_error, invalid_input_error) -> str:
+def adapt_input(requested_password_length) -> int:
     '''
-    Called by the create_password_labels function,
-    this function checks if a password can be generated.
-    It first checks if the user has chosen any characters sets,
-    then it checks if the user's chosen length is valid,
-    and displays an adequate error.
+    Called by the create_password_labels function
+    (upon pressing the done button),
+    this function first checks if any input has been given.
+    It raises a ValueError if no input has been given,
+    and if input has been given,
+    it attempts to adapt the input to an integer between 4 and 100.
+    If it succeeds, it returns the adapted input,
+    if it fails, it raises a ValueError.
 
     Parameters
     ----------
-    requested_password_length: int
-        The length requested by the user.
-    lowercase_letters_var: tkinter.IntVar()
-        The variable used to check if the lowercase letters checkbox has been selected or not.
-    uppercase_letters_var: tkinter.IntVar()
-        The variable used to check if the upprcase letters checkbox has been selected or not.
-    digits_var: tkinter.IntVar()
-        The variable used to check if the digits checkbox has been selected or not.
-    punctuation_var: tkinter.IntVar()
-        The variable used to check if the punctuation checkbox has been selected or not.
+    requested_password_length: str
+        The input of the user.
+    '''
+    if requested_password_length == '':
+        raise ValueError
+    else:
+        try:
+            return max(min(abs(int(round(float(requested_password_length), 0))), 100), 4)
+        except:
+            raise ValueError
+
+def determine_error(valid_character_set_bool, requested_password_length, no_character_set_error, double_error, invalid_input_error) -> str:
+    '''
+    Called by create_password_labels,
+    (upon pressing the done button)
+    this function retruns what error should be shown to the user:
+    an invalid_input_error if a character set has been chosen, but the input is unadaptable.
+    a no_character_set_error if no character set has been chosen, but the input is adaptable,
+    or a double_error if no character set has been chosen, and the input is unadaptable.
+
+    Parameters
+    ----------
+    valid_character_set_bool: boolean
+        Whether or not at least one character set has been chosen, as determined by validate_character_sets.
+    requested_password_length: str
+        The input_box content.
     no_character_set_error: str
-        The error used when no character set has been picked.
-    input_box: tkinter.Entry()
-        The input box used for the length of the password.
+        'An error occurred. Try again with at least 1 character set.'
     double_error: str
-        The error used when no character set has been picked and when the input is invalid.
+        'An error occurred. Try again with at least 1 character set and a whole number between 4 and 100.'
     invalid_input_error: str
-        The error used when the input is invalid.
+        'An error occurred. Try again with a whole number between 4 and 100.'
     '''
-    if lowercase_letters_var.get() == 0 and uppercase_letters_var.get() == 0 and digits_var.get() == 0 and punctuation_var.get() == 0:
+    
+    if valid_character_set_bool:
+        try:
+            adapt_input(requested_password_length)
+            return ''
+        except:
+            return invalid_input_error
+    else:
         try:
-            if 4 <= int(requested_password_length) <= 100:
-                return no_character_set_error
-            else:
-                input_box.delete(0, 'end')
-                return double_error
+            adapt_input(requested_password_length)
+            return no_character_set_error
         except:
-            input_box.delete(0, 'end')
             return double_error
 
-    try:
-        if not 4 <= int(requested_password_length) <= 100:
-            input_box.delete(0, 'end')
-            return invalid_input_error
-    except:
-        input_box.delete(0, 'end')
-        return invalid_input_error
-    
+def validate_character_sets(lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var) -> str:
+    '''
+    Called by the create_password_labels function
+    (upon pressing the done button),
+    this function checks if at least one character set has been chosen by the user,
+    and returns a boolean.
+
+    Parameters
+    ----------
+    lowercase_letters_var: tkinter.IntVar()
+        The variable of the lowercase letters checkbox.
+    uppercase_letters_var: tkinter.IntVar()
+        The variable of the uppercase letters checkbox.
+    digits_var: tkinter.IntVar()
+        The variable of the digits checkbox.
+    punctuation_var: tkinter.IntVar()
+        The variable of the punctuation checkbox.        
+    '''
+    if lowercase_letters_var.get() == 0 and uppercase_letters_var.get() == 0 and digits_var.get() == 0 and punctuation_var.get() == 0:
+        return False
+    else:
+        return True
+
 def generate_password(requested_password_length, lowercase_letters_var, uppercase_letters_var, digits_var, punctuation_var) -> str:
     '''
     Called by the validate_input function,
@@ -96,9 +131,9 @@ def show_copy_button(event, copy) -> None:
 
     Parameters
     ----------
-    event:
+    event: tkinter.event
         Gets the coordinates of the mouse cursor when the user releases a mouse button on a password_label.
-    copy:
+    copy: tkinter.Menu()
         The copy button itself.
     '''
     copy.tk_popup(event.x_root, event.y_root - 30)

code/main.py

@@ -5,7 +5,6 @@
 import generate_password_gui
 import password_strength_gui
 
-
 def main():
     '''
     Called upon starting the program,
@@ -33,7 +32,7 @@ def main():
 
     class GeneratePasswordFrame:
         '''
-        A class that creates the "generate password" frame,
+        A class that creates the 'generate password' frame,
         and adds it to the notebook previously created.
 
         ...
@@ -46,7 +45,7 @@ class GeneratePasswordFrame:
         generate_password_frame = tk.Frame(window)
         generate_password_frame.grid(column = 0, row = 0)
 
-        # Expand widgets to take up the entire window
+        # Expand some widgets' rows and columns to take up the entire window
         generate_password_frame.grid_columnconfigure(0, weight = 1)
         generate_password_frame.grid_rowconfigure(0, weight = 1)
         generate_password_frame.grid_rowconfigure(1, weight = 1)
@@ -56,7 +55,7 @@ class GeneratePasswordFrame:
 
         notebook.add(generate_password_frame, text = 'Generate password')
 
-        generate_password_gui.show_generate_password_frame(generate_password_frame, done_btn_image)
+        generate_password_gui.create_generate_password_frame(generate_password_frame, done_btn_image)
 
     class PasswordStrengthFrame:
         '''

code/password_strength_gui.py

@@ -8,9 +8,10 @@
 title_font = 'Helvetica 24'
 warning_font = 'Helvetica 16'
 
+input_password_msg = 'Please input a password.'
+
 copy_button_y_offest = 30
 
-input_password_msg = 'Please input a password.'
 
 def display_paste_button(event) -> None:
     '''
@@ -20,7 +21,7 @@ def display_paste_button(event) -> None:
 
     Parameters
     ----------
-    event:
+    event: tkinter.event
         Gets the coordinates of the mouse cursor when the user releases a mouse button on a password_label.
     '''
     paste.tk_popup(event.x_root, event.y_root - copy_button_y_offest)
@@ -72,7 +73,7 @@ def create_password_strength_frame(frame) -> None:
     Parameters
     ----------
     frame: ttk.Frame
-        The "password strength" frame
+        The 'password strength' frame
     '''
     global paste
     paste = tk.Menu(frame, tearoff = False)

code/password_strength_logic.py

@@ -10,7 +10,7 @@
 def check_password_strength(event, inputted_password, input_password_msg) -> list:
     '''
     Called upon pressing the done button,
-    this function hosts defines several functions that check the prevalance, length, complexity and repetitiveness of an inputted password, 
+    this function defines several functions that check the prevalance, length, complexity and repetitiveness of an inputted password, 
     and returns appropriate messages. 
     It then calls these functions and returns a list of messages indicating the results of each check.
 
@@ -29,7 +29,7 @@ def check_password_strength(event, inputted_password, input_password_msg) -> lis
     def check_if_password_is_common() -> None:
         '''
         Called by the check_password_strength function
-        (upon pressing the done button),
+        (as the user types),
         this function checks if the inputted password is in the 100,000 most used passwords (modified_common_password),
         and returns an appropiate message.
         It does this by counting the number of times an inputted_password is found in the SecLists list.
@@ -43,7 +43,7 @@ def check_if_password_is_common() -> None:
     def check_password_length() -> None:
         '''
         Called by the check_password_strength function
-        (upon pressing the done button),
+        (as the user types),
         this function categorises the inputted password as very weak, weak, good, or strong depending on its length,
         and returns a suitable message.
         '''
@@ -65,10 +65,10 @@ def check_password_length() -> None:
     def check_password_complexity() -> None:
         '''
         Called by the check_password_strength function
-        (upon pressing the done button),
+        (as the user types),
         this function checks how many of the following the inputted password is missing: 
         lowercase letters, uppercase letters, digits, and punctuation,
-        and return an adequate warning about them.
+        and returns an adequate warning about them.
         '''
         missing_security_features_list = []
 
@@ -128,7 +128,7 @@ def check_password_complexity() -> None:
     def check_for_patterns_in_password() -> None:
         '''
         Called by the check_password_strength function
-        (upon pressing the done button),
+        (as the user types),
         this function checks if there are any repeating characters in the inputted password,
         and returns an adequate message.
         '''