1.7 Functions

You have already used many built-in Python functions. Let's list a few:

print()

input()

int()

str()

float()

type()

round()

range()

sqrt()

What is a function?

A function is a block of code that that is executed when the name is called. Once the block finished, the interpreter returns to where the function was called.

How do built-in functions work?

The specifications of these built-in functions are listed in the documentation at python.org. That documentation is also installed when you install Python. The API is also available as a tool-tip when you are using IDLE.

Can you give us an example that isn't one we've already seen?

import math

degrees = 45

radians = (degrees * math.pi) / 180.0

print(math.sin(radians))

What happened? We used the sin() from the math module to calculate the sine of the angle in radian measure.

Did we / you write them?

No, we are reusing the functions that were written for us to use!

Can I write my own functions?

Yes! We will cover defining functions in this lesson.

Function terms:

call - calling / writing the function into our code. Python will look for the function, and run it. When you type print(), Python executes the print function.

pass / passing - putting something into the brackets of the function. Putting a value in the brackets allows you to pass something to the function. Like passing the string 'Hello' to a print() ... print('Hello'). These are called parameters.

return - the value the function returns once it has executed. For instance, if I pass the integer 3 to the float(), 3.0 would be returned. x = float(3) ... there would be a 3.0 in x.

signature - the complete name of the function. The signature indicates the name of the function and the arguments that it will accept.

Naming a function:

Functions are action / verb based. Remember that a function does something. The clearer the name, the easier it is for you to write your documentation. Please follow the rules outlined in naming variables and apply them when you are naming a function (except the action / verb).

How many things can a function do?

One.

For re-usability and flexibility, a function should only do one thing. For example, you would not want a getGuessandCheckGuess(). It would be better to have separated your code into getGuess() and checkGuess().

Defining a function

The pseudo code for a defining a function is:

def NAME( LIST OF PARAMETERS ):

    STATEMENTS

The keyword def indicates the beginning of the function definition. You'll notice that indentation separates the functions code from the rest of your code. The list of parameters indicates what your function will expect to receive.

Problem: write a function that inserts a empty line in your output.

def blankLine():

    print('')

What does our blankLine() do? It inserts a blank line in our output whenever it is called.

Use your newly created function blankLine():

def blankLine():

    print('')

print('Hello')

blankLine()

print('Bye')

OUTPUT:

Hello

Bye

The Flow

So far in this course, Python has executed your code starting from the first line of the file, and it works its way down.

What happens now?

Python reads the functions, but does not execute them because of where they are defined, but rather where they are called. Selection statements and loops alter the flow of the program, functions don't. Think of the function call like a detour. Eventually you have to go back to wherever the function was called.

Passing a value to a function

A user defined function can accept a value(s).

Problem: Write a function that accepts a value. Use a loop to print that value twice.

def repeatItTwice(some_string):

    for i in range(0,2):

        print(some_string)

x = input('Please enter a word: ')

repeatItTwice(x)

OUTPUT:

Please enter a word: hello

hello

hello

>>>

repeatItTwice() is not in the API! I wrote it in the body of my code. When I wanted to use it, I called it.

Problem: Write a function that accepts two values. Print out those values.

def printName(fname, lname):

    print('Hello ' + fname + ' ' + lname)

x = input('Please enter your first name: ')

y = input('Please enter your last name: ')

printName(x, y)

OUTPUT:

Please enter your first name: Bobo

Please enter your last name: Jonze

Hello Bobo Jonze

>>> 

The function we defined, printName(), accepts two variables. x and y are visible to the whole program. But what about the variables fname and lname?

Scope

In the previous examples printName() and repeatItTwice() are called with variables. If we look at the signature of repeatItTwice(), you'll see that it accepts a variable. In this case a variable called some_string. This is when scope comes into play. some_string is only visible within the function repeatItTwice().

If you try to access some_string from anywhere else in the code, it will not be seen. After a function runs, all the variables within its scope are destroyed.

The scope of a variable is limited to where it was built.

Return

Ever wonder why we use a variable and an assignment operator with built in functions like input() ? It's because input() returns a value to whatever called it.

Problem: Write a function that accepts two numbers, finds their sum, and returns a value.

def sum(a, b):

    a = int(a)

    b = int(b)

    answer = a + b

    answer = str(answer)

    return answer

x = input('Please enter your first number: ')

y = input('Please enter your second number: ')

z = sum(x, y)

print('The sum of your numbers is: ' + z)

Problem: Write a function that accepts two numbers, finds their sum and displays the value (DANGER: FUNCTION ALERT!)

def sum(a, b):

    a = int(a)

    b = int(b)

    answer = a + b

    answer = str(answer) #Where does this happen in my next example?

    print('The sum of your numbers is: ' + answer)

x = input('Please enter your first number: ')

y = input('Please enter your second number: ')

sum(x, y)

Could we introduce another function? Why? Well, it looks like sum() is doing the math and the printing. This effects the flexibility of sum().

I mean, it's called sum(), not sumAndPrint(), right?

Problem: fix sum()

def sum(a, b):

    a = int(a)

    b = int(b)

    answer = a + b

    #What happened to ***answer = str(answer)*** the string casting of answer?

    return answer

def printIt(c):

    c = str(c)    #How is my printIt() better than the built-in print()? HINT: IT CASTS!

    print('The sum of your numbers is: ' + c)

x = input('Please enter your first number: ')

y = input('Please enter your second number: ')

z = sum(x, y)

printIt(z)

That looks better. Arguably, you have two flexible functions. One that will take a number and get it ready for string output, and another that will take two numbers and find their sum. Is there a way to make this even better???

Can we further divide the problem?

def getNum():

    num = input('Please enter your number: ')

    return num

def sum(a, b):

    a = int(a)

    b = int(b)

    answer = a + b

    return answer

def printIt(c):

    c = str(c)

    print('The sum of your numbers is: ' + c)

x = getNum()

y = getNum()

z = sum(x, y)

printIt(z)

Now, we've got our number input in a function, outside of the 'main' part of our code. We then reuse the function getNum().

One last word on return statements. Once return occurs, control goes back to whatever called that function. That idea sets you up for another interesting possibility:

Multiple returns

Some solutions will have multiple return statements. I try to avoid multiple return in my solutions.

def evenOrOdd(a):

    if a % 2 == 0:

        return 'Even'

    else:

        return 'Odd'

userinput = input('Please enter a positive number to see if it is even or odd: ')

userinput = int(userinput)

result = evenOrOdd(userinput)

print(result)

It works, but I'd rather not.

Think about functions only doing one thing, and returning one thing (or nothing).

Fix evenOrOdd() so that is only returns one value:

def evenOrOdd(a):

    if a % 2 == 0:

        foo = 'Even'

    else:

        foo = 'Odd'

    return foo

userinput = input('Please enter a positive number to see if it is even or odd: ')

userinput = int(userinput)

result = evenOrOdd(userinput)

print(result)

You have freedom. Choose.

Python Program Template for a Menu Driven Program using Functions

# Author: Mr. Liconti based on Jack M.'s original code'

# Date: 2/9/2018

# File Name: rect_area_Functions.py

# Description: making a program to calculate the area of a rectangle. Added a Menu and functions

#import statments here

#global variables here

flag = True #loop control

userChoice = ''  #var that holds the RETURNED choice from getChoice()

area = 0 #holds the RETURNED value from calcArea()

def showMenu():         #Display menu options 

    print('   MENU')

    print('==========')

    print('S to start')

    print('H for help')

    print('Q to quit')

    print('==========')

    print(' ')

def getChoice():              #get user's choice 

  choice = input('Option?: ')     

  return choice

def showHelp():

  print('This program will give you the area of a rectangle.')

  print('Please provide the height and width when asked.')

  print('You can quit this program from the main menu by pressing Q')

def calcArea():

  height = input('height: ')        #this is where you input the height of the rectangle

  width = input('width: ')          #this is where you input the width of the rectangle

  height = int(height)            #changing height into a int because it will be a number

  width = int(width)              #changing the width to a int because it will be a number

  area = height * width           #area is equal to height times width

  area = str(area)                #area is changing to a string because it was a int

  return area

def showAnswer(x):

  print('The answer is: ' + x + ' meters') #print answer, including unit

print('This program will give you the area of a rectangle.')

while flag == True:

  showMenu()

  userChoice = getChoice()

  if userChoice == 'H':

    showHelp()

  elif userChoice == 'Q':         #control the loop with the variable flag

    flag = False

  elif userChoice == 'S':

    area = calcArea()

    showAnswer(area)

  else:

        print('Not a valid choice. Only S, Q and H are valid choices') #error message

print('Program ending.')