"""
Plays hangman using words from a file

CS 150 Spring 2020 Lab 6 

Name: Amy Briggs

"""

# imports here

def read_words(filename):
    """
    Read words from filename into a list

    Args:
        filename: name of file of words to choose from
        
    Returns:
        list of words in file
    """
    pass


def set_to_string(letters):
    """
    Converts a set to a string
    
    Args:
        letters: a set of letters
        
    Returns:
        a string of uppercase letters in the set
    """
    pass


def insert_letter(letter, underscored, solution):
    """
    Insert letter in 'underscored' wherever it appears in 'solution'
    
    Args:
        letter: a single letter
        underscored: a string of letters and underscores
        solution: the word the player is trying to guess
        
    Returns:
        updated underscored with new correct letters in place
    """
    pass


def report_status(max_guesses, guesses_left):
    """
    Reports the current game status every time the player makes a new guess
    
    Args:
        max_guesses: the total number of incorrect guesses the player is allowed
        guesses_left: the number of incorrect guesses the player can still make
    
    Returns:
        None
    """
    pass


def play_hangman(filename, max_guesses):
    """
    Plays the game of hangman using words in given file
    
    Args:
        filename: name of file to read words from
        max_guesses: the total number of incorrect guesses the player is allowed
        
    Returns:
        None
    """
    
    # read words
    # choose a random word
    # loop until run out of guesses or player guesses solution
    # report out game stats
    pass
    

# main program:
# play_hangman('cs_words.txt', 7)