Exercise 25: Even More Practice

We’re going to do some more practice involving functions and variables to make sure you know them well. This exercise should be straightforward for you to type in, break down, and understand.

However, this exercise is a little different. You won’t be running it. Instead you will import it into Python and run the functions yourself.

def break_words(stuff):
    """This function will break up words for us."""
    words = stuff.split(' ')
    return words

def sort_words(words):
    """Sorts the words."""
    return sorted(words)

def print_first_word(words):
    """Prints the first word after popping it off."""
    word = words.pop(0)
    print word

def print_last_word(words):
    """Prints the last word after popping it off."""
    word = words.pop(-1)
    print word

def sort_sentence(sentence):
    """Takes in a full sentence and returns the sorted words."""
    words = break_words(sentence)
    return sort_words(words)

def print_first_and_last(sentence):
    """Prints the first and last words of the sentence."""
    words = break_words(sentence)

def print_first_and_last_sorted(sentence):
    """Sorts the words then prints the first and last one."""
    words = sort_sentence(sentence)

First, run this with python ex25.py to find any errors you have made. Once you have found all of the errors you can and fixed them, you will then want to follow the What You Should See section to complete the exercise.

What You Should See

In this exercise we’re going to interact with your ex25.py file inside the python interpreter you used periodically to do calculations. You run python from the terminal like this:

$ python
Python 2.7.1 (r271:86832, Jun 16 2011, 16:59:05)
[GCC 4.2.1 (Based on Apple Inc. build 5658) (LLVM build 2335.15.00)] on darwin
Type "help", "copyright", "credits" or "license" for more information.

Your output should look like mine, and after the > character (called the prompt) you can type Python code in and it will run immediately. Using this I want you to type each of these lines of Python code into python and see what it does:

import ex25
sentence = "All good things come to those who wait."
words = ex25.break_words(sentence)
sorted_words = ex25.sort_words(words)
sorted_words = ex25.sort_sentence(sentence)

Here’s what it looks like when I work with the ex25.py module in python:

Python 2.7.11 (default, May 25 2016, 05:27:56) 
[GCC 4.2.1 Compatible Apple LLVM 7.3.0 (clang-703.0.29)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> import ex25
>>> sentence = "All good things come to those who wait."
>>> words = ex25.break_words(sentence)
>>> words
['All', 'good', 'things', 'come', 'to', 'those', 'who', 'wait.']
>>> sorted_words = ex25.sort_words(words)
>>> sorted_words
['All', 'come', 'good', 'things', 'those', 'to', 'wait.', 'who']
>>> ex25.print_first_word(words)
>>> ex25.print_last_word(words)
>>> words
['good', 'things', 'come', 'to', 'those', 'who']
>>> ex25.print_first_word(sorted_words)
>>> ex25.print_last_word(sorted_words)
>>> sorted_words
['come', 'good', 'things', 'those', 'to', 'wait.']
>>> sorted_words = ex25.sort_sentence(sentence)
>>> sorted_words
['All', 'come', 'good', 'things', 'those', 'to', 'wait.', 'who']
>>> ex25.print_first_and_last(sentence)
>>> ex25.print_first_and_last_sorted(sentence)

As you go through each of these lines, make sure you can find the function that’s being run in ex25.py and you understand how each one works. If you get different results or error, you’ll have to go fix your code, exit python and start over.

Study Drills

  1. Take the remaining lines of the What You Should See output and figure out what they are doing. Make sure you understand how you are running your functions in the ex25 module.
  2. Try doing this: help(ex25) and also help(ex25.break_words). Notice how you get help for your module, and how the help is those odd """ strings you put after each function in ex25? Those special strings are called documentation comments and we’ll be seeing more of them.
  3. Typing ex25. is annoying. A shortcut is to do your import like this: from ex25 import * which is like saying, “Import everything from ex25.” Programmers like saying things backward. Start a new session and see how all your functions are right there.
  4. Try breaking your file and see what it looks like in python when you use it. You will have to quit python with quit() to be able to reload it.

Common Student Questions

I get None printed out for some of the functions.
You probably have a function that is missing the return at the end. Go backward through the file and confirm that every line is right.
I get -bash: import: command not found when I type import ex25.
Pay attention to what I’m doing in the What You Should See section. I’m doing this in Python not in the Terminal. That means you first run Python.
I get ImportError: No module named ex25.py when I type import ex25.py.
Don’t add the .py to the end. Python knows the file ends in .py so you just type import ex25.
I get SyntaxError: invalid syntax when I run this.
That means you have something like a missing ( or " or similar syntax error on that line or above it. Any time you get that error, start at the line it mentions and check that it’s right, then go backward checking each line above that.
How can the words.pop function change the words variable?
That’s a complicated question, but in this case words is a list, and because of that you can give it commands and it’ll retain the results of those commands. This is similar to how files and many other things worked when you were working with them.
When should I print instead of return in a function?
The return from a function gives the line of code that called the function a result. You can think of a function as taking input through its arguments, and returning output through return. The print is completely unrelated to this, and only deals with printing output to the terminal.