ps3.py

# 6.0001 Problem Set 3
#
# The 6.0001 Word Game
# Created by: Kevin Luu <luuk> and Jenna Wiens <jwiens>
#
# Name          : <your name>
# Collaborators : <your collaborators>
# Time spent    : <total time>

import math
import random
import string

VOWELS = 'aeiou'
CONSONANTS = 'bcdfghjklmnpqrstvwxyz'
HAND_SIZE = 7

SCRABBLE_LETTER_VALUES = {
    'a': 1, 'b': 3, 'c': 3, 'd': 2, 'e': 1, 'f': 4, 'g': 2, 'h': 4, 'i': 1, 'j': 8, 'k': 5, 'l': 1, 'm': 3, 'n': 1, 'o': 1, 'p': 3, 'q': 10, 'r': 1, 's': 1, 't': 1, 'u': 1, 'v': 4, 'w': 4, 'x': 8, 'y': 4, 'z': 10
}

# -----------------------------------
# Helper code
# (you don't need to understand this helper code)

WORDLIST_FILENAME = "words.txt"

def load_words():
    """
    Returns a list of valid words. Words are strings of lowercase letters.

    Depending on the size of the word list, this function may
    take a while to finish.
    """

    print("Loading word list from file...")
    # inFile: file
    inFile = open(WORDLIST_FILENAME, 'r')
    # wordlist: list of strings
    wordlist = []
    for line in inFile:
        wordlist.append(line.strip().lower())
    print("  ", len(wordlist), "words loaded.")
    return wordlist

def get_frequency_dict(sequence):
    """
    Returns a dictionary where the keys are elements of the sequence
    and the values are integer counts, for the number of times that
    an element is repeated in the sequence.

    sequence: string or list
    return: dictionary
    """

    # freqs: dictionary (element_type -> int)
    freq = {}
    for x in sequence:
        freq[x] = freq.get(x,0) + 1
    return freq


# (end of helper code)
# -----------------------------------

#
# Problem #1: Scoring a word
#
def get_word_score(word, n):
    """
    Returns the score for a word. Assumes the word is a
    valid word.

    You may assume that the input word is always either a string of letters,
    or the empty string "". You may not assume that the string will only contain
    lowercase letters, so you will have to handle uppercase and mixed case strings
    appropriately.

	The score for a word is the product of two components:

	The first component is the sum of the points for letters in the word.
	The second component is the larger of:
            1, or
            7*wordlen - 3*(n-wordlen), where wordlen is the length of the word
            and n is the hand length when the word was played

	Letters are scored as in Scrabble; A is worth 1, B is
	worth 3, C is worth 3, D is worth 2, E is worth 1, and so on.

    word: string
    n: int >= 0
    returns: int >= 0
    """
    word_score = 0
    word = word.lower()
    for letter in word:
        letter_score = SCRABBLE_LETTER_VALUES.get(letter, 0)
        word_score += letter_score
    calculation = ( 7 * len(word) ) - ( 3 * ( n - len(word) ) )
    if calculation < 0:
        calculation = 1

    total_score = word_score * calculation
    return total_score
#
# Make sure you understand how this function works and what it does!
#
def display_hand(hand):
    """
    Displays the letters currently in the hand.

    For example:
       display_hand({'a':1, 'x':2, 'l':3, 'e':1})
    Should print out something like:
       a x x l l l e
    The order of the letters is unimportant.

    hand: dictionary (string -> int)
    """

    for letter in hand.keys():
        for j in range(hand[letter]):
             print(letter, end=' ')      # print all on the same line
    print()                              # print an empty line

#
# Make sure you understand how this function works and what it does!
# You will need to modify this for Problem #4.
#
def deal_hand(n):
    """
    Returns a random hand containing n lowercase letters.
        ceil(n/3) letters in the hand should be VOWELS (note,
        ceil(n/3) means the smallest integer not less than n/3).

        Hands are represented as dictionaries. The keys are
        letters and the values are the number of times the
        particular letter is repeated in that hand.

        n: int >= 0
        returns: dictionary (string -> int)
    """
    hand={}
    num_vowels = int(math.ceil(n / 3))


    for i in range(1,num_vowels):
        x = random.choice(VOWELS)
        hand[x] = hand.get(x, 0) + 1

    hand['*'] = 1

    for i in range(num_vowels, n):
        x = random.choice(CONSONANTS)
        hand[x] = hand.get(x, 0) + 1

    return hand

#
# Problem #2: Update a hand by removing letters
#
def update_hand(hand, word):
    """
    Does NOT assume that hand contains every letter in word at least as
    many times as the letter appears in word. Letters in word that don't
    appear in hand should be ignored. Letters that appear in word more times
    than in hand should never result in a negative count; instead, set the
    count in the returned hand to 0 (or remove the letter from the
    dictionary, depending on how your code is structured).

    Updates the hand: uses up the letters in the given word
    and returns the new hand, without those letters in it.

    Has no side effects: does not modify hand.

    word: string
    hand: dictionary (string -> int)
    returns: dictionary (string -> int)
    """
    word = word.lower()
    new_hand = hand.copy()
    keys = new_hand.keys()
    for letter in word:
        if letter in keys:
            new_hand[letter] -= 1
            if new_hand[letter] < 0:
                new_hand[letter] = 0
    return new_hand

#
# Problem #3: Test word validity
#
def is_valid_word(word, hand, word_list):
    """
    Returns True if word is in the word_list and is entirely
    composed of letters in the hand. Otherwise, returns False.
    Does not mutate hand or word_list.

    word: string
    hand: dictionary (string -> int)
    word_list: list of lowercase strings
    returns: boolean
    """
    dummie_hand = hand.copy()
    i = 0
    if '*' in word:
        wild_pos = word.find('*')
        for letter in VOWELS:
            test_word = word[:wild_pos] + letter + word[wild_pos + 1:]
            if wild_pos == len(word) - 1:
                test_word = word[:wild_pos] + letter
                #print(test_word)
            dummie_hand = hand.copy()
            if letter in dummie_hand:
                dummie_hand[letter] += 1
            else:
                dummie_hand[letter] = dummie_hand.pop('*')
            if is_valid_word(test_word, dummie_hand, word_list):
                return True
        return False

    if word.lower() in word_list:
        i += 1
    if i == 0:
        #print('joke')
        return False
    for letter in word:
        letter = letter.lower()
        if letter not in dummie_hand.keys():
            #print('joker')
            return False
        else:
            if dummie_hand[letter] > 1:
                dummie_hand[letter] -= 1
            else:
                del dummie_hand[letter]
    return True


#
# Problem #5: Playing a hand
#
def calculate_handlen(hand):
    """
    Returns the length (number of letters) in the current hand.

    hand: dictionary (string-> int)
    returns: integer
    """
    numOfLetters = 0
    for key,value in hand.items():
        numOfLetters += value
    return numOfLetters

def play_hand(hand, word_list):

    """
    Allows the user to play the given hand, as follows:

        * The hand is displayed.

        * The user may input a word.

        * When any word is entered (valid or invalid), it uses up letters
          from the hand.

        * An invalid word is rejected, and a message is displayed asking
          the user to choose another word.

        * After every valid word: the score for that word is displayed,
          the remaining letters in the hand are displayed, and the user
          is asked to input another word.

        * The sum of the word scores is displayed when the hand finishes.

        * The hand finishes when there are no more unused letters.
          The user can also finish playing the hand by inputing two
          exclamation points (the string '!!') instead of a word.

          hand: dictionary (string -> int)
          word_list: list of lowercase strings
          returns: the total score for the hand

    """

    # BEGIN PSEUDOCODE <-- Remove this comment when you implement this function
    # Keep track of the total score
    total_score = 0
    # As long as there are still letters left in the hand:
    total_of_hand = calculate_handlen(hand)
    while total_of_hand > 0:
        # Display the hand
        print()
        print("Current Hand: ", end = '' )
        display_hand(hand)
        # Ask user for input
        user_word = input('Enter word, or \"! !\" to indicate that you are finished: ')
        # If the input is two exclamation points:
        if user_word == '! !':
            # End the game (break out of the loop)
            break
        # Otherwise (the input is not two exclamation points):
        else:
            # If the word is valid:
            if is_valid_word(user_word, hand, word_list):
                # Tell the user how many points the word earned,
                # and the updated total score
                total_score += get_word_score(user_word, len(hand))
                print("{word} earned {word_score} points.Total: {total_score} points".format(word = user_word, word_score = get_word_score(user_word, len(hand)), total_score = total_score))

            # Otherwise (the word is not valid):
            else:
                # Reject invalid word (print a message)
                print('That is not a valid word. Please choose another word.')
            # update the user's hand by removing the letters of their inputted word
            hand = update_hand(hand, user_word)
            total_of_hand = calculate_handlen(hand)

    # Game is over (user entered '!!' or ran out of letters),
    # so tell user the total score
    if user_word == '! !':
        print('Total score for this hand: {total_score} points'.format(total_score = total_score))
    else:
        print('Ran out of letters. Total score for this hand: {total_score} points'.format(total_score = total_score))

    # Return the total score as result of function
    return total_score



#
# Problem #6: Playing a game
#


#
# procedure you will use to substitute a letter in a hand
#

def substitute_hand(hand, letter):
    """
    Allow the user to replace all copies of one letter in the hand (chosen by user)
        with a new letter chosen from the VOWELS and CONSONANTS at random. The new letter
        should be different from user's choice, and should not be any of the letters
        already in the hand.

        If user provide a letter not in the hand, the hand should be the same.

        Has no side effects: does not mutate hand.

        For example:
            substitute_hand({'h':1, 'e':1, 'l':2, 'o':1}, 'l')
        might return:
            {'h':1, 'e':1, 'o':1, 'x':2} -> if the new letter is 'x'
        The new letter should not be 'h', 'e', 'l', or 'o' since those letters were
        already in the hand.

        hand: dictionary (string -> int)
        letter: string
        returns: dictionary (string -> int)
    """
    #create a variable that will represent where we will get our random character
    #from, depending on whether or not the letter is a vowel or consonant
    #generate a random character and check if that character is already in
    #hand
    hands_list = list(hand.keys())
    random_character = random.choice(hands_list)

    if letter.lower() in VOWELS:
        while random_character in hand:
            random_character = random.choice(list(VOWELS))

    elif letter.lower() in CONSONANTS:
        while random_character in hand:
            random_character = random.choice(list(CONSONANTS))

    #pop the letter and assign it the random character as the key
    hand[random_character] = hand.pop(letter)
    return hand

def play_game(word_list):
    """
    Allow the user to play a series of hands

        * Asks the user to input a total number of hands

        * Accumulates the score for each hand into a total score for the
          entire series

        * For each hand, before playing, ask the user if they want to substitute
          one letter for another. If the user inputs 'yes', prompt them for their
          desired letter. This can only be done once during the game. Once the
          substitue option is used, the user should not be asked if they want to
          substitute letters in the future.

        * For each hand, ask the user if they would like to replay the hand.
          If the user inputs 'yes', they will replay the hand and keep
          the better of the two scores for that hand.  This can only be done once
          during the game. Once the replay option is used, the user should not
          be asked if they want to replay future hands. Replaying the hand does
          not count as one of the total number of hands the user initially
          wanted to play.

                * Note: if you replay a hand, you do not get the option to substitute
                        a letter - you must play whatever hand you just had.

        * Returns the total score for the series of hands

        word_list: list of lowercase strings
    """

    #set variable for total number of hands equal to user input
    num_of_hands = int(input('Enter total number of hands: '))
    #create total_score variable
    total_score = 0
    #replay = False
    replay = False
    #main game loop:
    while int(num_of_hands) > 0:

        #if not replay:
        if not replay:
            #hand = deal new hand
            hand = deal_hand(HAND_SIZE)
            #hand dummie = hand.copy()
            hand_dummie = hand.copy()
        #display hand
        print("Current Hand: ", end = '' )
        display_hand(hand_dummie)
        #ask user if they'd like to substitute a letter
        sub_ans = input('Would you like to substitue a letter? (y/n)')
        #if yes:
        if sub_ans.lower() == 'y':
            #substitute the hand
            letter = input('Which letter would you like to replace: ')
            print()
            substitute_hand(hand_dummie, letter)

        #hand_score = play hand
        hand_score = play_hand(hand_dummie, word_list)

        #total_score += hand_score
        total_score += hand_score
        #print('----------')
        print('----------')

        #if not replay:
        if not replay:
            #ask user if they'd like to replay that hand
            replay_ans = input('Would you like to replay the hand? (y/n)')

            #if yes:
            if replay_ans.lower() == 'y':
                #keep hand the same
                hand_dummie = hand.copy()

                #remove the score we got in this hand from total score
                total_score -= hand_score
                #set_replay to true
                replay = True
            else:
                num_of_hands -= 1
        #else:
        else:
            #set replay to false
            replay = False
            num_of_hands -= 1

    print('Total score over all hands: {total_score}'.format(total_score = total_score))








#
# Build data structures used for entire session and play game
# Do not remove the "if __name__ == '__main__':" line - this code is executed
# when the program is run directly, instead of through an import statement
#
if __name__ == '__main__':
    word_list = load_words()
    play_game(word_list)