Merge branch 'feature/code-cleanup' into develop

src/pydle.py

@@ -3,7 +3,8 @@ import random
 import sys
 
 
-def getGuess(number):
+# Gets the input from a user - number param is used to display the guess number the user is on
+def get_guess(number):
     validGuess = False
     guess = ""
     while not validGuess:
@@ -21,23 +22,21 @@ def resource_path(relative_path):
     return os.path.join(base_path, relative_path)
 
 
-def getWord():
+# Gets a random word from a words.txt file present in the same directory as this script
+def get_random_word():
     lines = open(resource_path('words.txt')).read().splitlines()
     return random.choice(lines)
 
 
-def checkRight(wordToGuess, guessSoFar):
+# Compares the users input with the word to be guessed. Returns true if the guess is correct, false otherwise
-    if str(wordToGuess).upper() == str(guessSoFar).upper():
+def check_word_is_right(word_guessed, word_to_guess):
+    if str(word_guessed).upper() == str(word_to_guess).upper():
         return True
     else:
         return False
 
-    
-def quit():
-    input("Thanks for playing! Press ENTER to exit :)")
-    sys.exit(0)
 
-    
+# Makes a cool header.
 def header():
     return r" ______   ______  _     _____" + "\n" + \
            r"|  _ \ \ / /  _ \| |   | ____|" + "\n" + \
@@ -46,35 +45,61 @@ def header():
            r"|_|    |_| |____/|_____|_____|"
 
 
-print("Welcome to...")
+# Prints welcome messages
-print(header())
+def intro():
-print("A totally original guessing game!")
+    print("Welcome to...")
-emptyWordGuess = ["_"] * 5
+    print(header())
-wrongLetters, rightLettersWrongPlace = set()
+    print("A totally original guessing game!")
-wordToGuess = list(getWord().upper())
+
-# print(wordToGuess)
+
-
+# Prints the results, a thank-you message and gracefully exits
-counter = 1
+def game_over(user_was_right, correct_word):
-while counter < 6:
+    if user_was_right:
-    userGuess = getGuess(counter)
+        print("Congratulations! The word was", ''.join(correct_word).capitalize())
-    emptyWordGuess = ["_"] * 5
+    else:
-    for i in range(len(userGuess)):
+        print("Ran out of guesses! The word was: ", "".join(correct_word))
-        if wordToGuess[i] == userGuess[i]:
+    input("Thanks for playing! Press ENTER to exit :)")
-            emptyWordGuess[i] = userGuess[i]
+    sys.exit(0)
-        elif userGuess[i] in wordToGuess:
+
-            if userGuess[i] in emptyWordGuess and userGuess[i] not in wordToGuess[i:]:
+
+# Takes in the users guess and the myriad lists involved in the game logic, and compares the letters in the guess
+# with the word to be guessed.
+# Inserts the letter into the appropriate list, based on its presence & position (or lack thereof)
+def check_letter_in_word(users_guess_input, word_to_be_guessed, users_guess_results, present_in_word, not_in_word):
+    for i in range(len(users_guess_input)):
+        if word_to_be_guessed[i] == users_guess_input[i]:
+            users_guess_results[i] = users_guess_input[i]
+        elif users_guess_input[i] in word_to_be_guessed:
+            if users_guess_input[i] in users_guess_results and users_guess_input[i] not in word_to_be_guessed[i:]:
                 break
             else:
-                rightLettersWrongPlace.add(userGuess[i])
+                present_in_word.add(users_guess_input[i])
         else:
-            wrongLetters.add(userGuess[i])
+            not_in_word.add(users_guess_input[i])
-    if checkRight(wordToGuess, emptyWordGuess):
+
-        print("Congratulations! The word was", ''.join(wordToGuess).capitalize())
+
-        quit()
+# Main game flow.
-    print("Incorrect letters: " + ', '.join(wrongLetters))
+def game_logic():
-    print("Correct letters in the wrong place: " + ', '.join(rightLettersWrongPlace))
+    not_in_word, present_in_word = set(), set()
-    print("Result: " + " ".join(emptyWordGuess))
+    word_to_be_guessed = list(get_random_word().upper())
-    counter += 1
+    counter = 1
-
+    while counter < 7:
-print("Ran out of guesses! The word was: ", "".join(wordToGuess))
+        users_guess_input = get_guess(counter)
-quit()
+        users_guess_results = ["_"] * 5
+        check_letter_in_word(users_guess_input, word_to_be_guessed, users_guess_results, present_in_word, not_in_word)
+        if check_word_is_right(word_to_be_guessed, users_guess_results):
+            game_over(True, word_to_be_guessed)
+        print("Incorrect letters: " + ', '.join(not_in_word))
+        print("Correct letters in the wrong place: " + ', '.join(present_in_word))
+        print("Result: " + " ".join(users_guess_results))
+        counter += 1
+    game_over(False, word_to_be_guessed)
+
+
+def main():
+    intro()
+    game_logic()
+
+
+if __name__ == '__main__':
+    main()