WRITING YOUR OWN FUNCTIONS IN PYTHON


Defining a Function

A function is a reusable block of code which performs operations specified in the function. They let you break down tasks and allow you to reuse your code in different programs.

There are two types of functions :

  • Pre-defined functions
  • User defined functions

What is a Function?

You can define functions to provide the required functionality. Here are simple rules to define a function in Python:

  • Functions blocks begin def followed by the function name and parentheses ().
  • There are input parameters or arguments that should be placed within these parentheses.
  • You can also define parameters inside these parentheses.
  • There is a body within every function that starts with a colon (:) and is indented.
  • You can also place documentation before the body
  • The statement return exits a function, optionally passing back a value

An example of a function that adds on to the parameter a prints and returns the output as b:


In [1]:
def add(a):
    """
    add 1 to a
    """
    b=a+1; 
    print(a, "if you add one" ,b)
    
    return(b)

The figure below illustrates the terminology:

A labeled function

We can obtain help about a function :


In [2]:
help(add)


Help on function add in module __main__:

add(a)
    add 1 to a

We can call the function:


In [3]:
add(1)


1 if you add one 2
Out[3]:
2

If we call the function with a new input we get a new result:


In [4]:
add(2)


2 if you add one 3
Out[4]:
3

We can create different functions. For example, we can create a function that multiplies two numbers. The numbers will be represented by the variables a and b:


In [5]:
def Mult(a,b):
    c=a*b
    return(c)

The same function can be used for different data types. For example, we can multiply two integers:


In [6]:
Mult(2,3)


Out[6]:
6

Two Floats:


In [7]:
Mult(10,3.14)


Out[7]:
31.400000000000002

We can even replicate a string by multiplying with an integer:


In [8]:
Mult(2,"Michael Jackson ")


Out[8]:
'Michael Jackson Michael Jackson '

Come up with a function that divides the first input by the second input:


In [9]:
def divide_values(a, b):
    return a / b
``` def div(a,b): return(a/b) ```

Variables

The input to a function is called a formal parameter.

A variable that is declared inside a function is called a local variable. The parameter only exists within the function (i.e. the point where the function starts and stops).

A variable that is declared outside a function definition is a global variable, and its value is accessible and modifiable throughout the program. We will discuss more about global variables at the end of the lab.


In [10]:
#Function Definition   
def square(a):
    """Square the input and add one  
    """
    #Local variable 
    b=1
    c=a*a+b;
    print(a, "if you square +1 ",c) 
    return(c)

The labels are displayed in the figure:

Figure 2: A function with labeled variables

We can call the function with an input of 3:


In [11]:
#Initializes Global variable  

x=3
#Makes function call and return function a y
z=square(x)
z


3 if you square +1  10
Out[11]:
10

We can call the function with an input of 2 in a different manner:


In [12]:
square(2)


2 if you square +1  5
Out[12]:
5

If there is no return statement, the function returns None. The following two functions are equivalent:


In [13]:
def MJ():
    print('Michael Jackson')
    
def MJ1():
    print('Michael Jackson')
    return(None)

In [14]:
MJ()


Michael Jackson

In [15]:
MJ1()


Michael Jackson

Printing the function after a call reveals a None is the default return statement:


In [16]:
print(MJ())
print(MJ1())


Michael Jackson
None
Michael Jackson
None

Create a function con that concatenates two strings using the addition operation:

:


In [17]:
def con(a,b):
    return(a+b)
``` def div(a,b): return(a+b) ```

Can the same function be used to add to integers or strings?


In [18]:
print(con(1, 2))
print(con('1', '2'))


3
12
``` yes,for example: con(2,2) ```

Can the same function be used to concentrate a list or tuple?


In [20]:
print(con([1], [2]))


[1, 2]
``` yes,for example: con(['a',1],['b',1]) ```

Pre-defined functions

There are many pre-defined functions in Python, so let's start with the simple ones.

The print() function:


In [21]:
album_ratings = [10.0,8.5,9.5,7.0,7.0,9.5,9.0,9.5] 
print(album_ratings)


[10.0, 8.5, 9.5, 7.0, 7.0, 9.5, 9.0, 9.5]

The sum() function adds all the elements in a list or tuple:


In [22]:
sum(album_ratings)


Out[22]:
70.0

The length function returns the length of a list or tuple:


In [23]:
len(album_ratings)


Out[23]:
8

[Tip] How do I learn more about the pre-defined functions in Python?

We will be introducing a variety of **pre-defined functions** to you as you learn more about Python. There are just too many functions, so there's no way we can teach them all in one sitting. But if you'd like to take a quick peek, here's a short reference card for some of the commonly-used pre-defined functions: http://www.astro.up.pt/~sousasag/Python_For_Astronomers/Python_qr.pdf

Functions Makes Things Simple

Consider the two lines of code in Block 1 and Block 2: the procedure for each block is identical. The only thing that is different is the variable names and values.

Block 1:


In [24]:
a1=4;
b1=5;
c1=a1+b1+2*a1*b1-1
if(c1<0):
    c1=0; 
else:
    c1=5;
c1


Out[24]:
5

Block 2:


In [25]:
a2=0;
b2=0;
c2=a2+b2+2*a2*b2-1
if(c2<0):
    c2=0; 
else:
    c2=5;
c2


Out[25]:
0

We can replace the lines of code with a function. A function combines many instructions into a single line of code. Once a function is defined, it can be used repeatedly. You can invoke the same function many times in your program. You can save your function and use it in another program or use someone else’s function. The lines of code in code block 1 and code block 2 can be replaced by the following function:


In [26]:
def Equation(a,b):
    c=a+b+2*a*b-1
    if(c<0):
        c=0
        
    else:
        c=5
    return(c)

This function takes two inputs, a and b, then applies several operations to return c. We simply define the function, replace the instructions with the function, and input the new values of a1,b1 and a2,b2 as inputs. The entire process is demonstrated in the figure:

Example of a function used to replace redundant lines of code

Code Blocks 1 and Block 2 can now be replaced with code Block 3 and code Block 4.

Block 3:


In [27]:
a1=4;
b1=5;
c1=Equation(a1,b1)
c1


Out[27]:
5

Block 4:


In [28]:
a2=0;
b2=0;
c2=Equation(a2,b2)
c2


Out[28]:
0

Using if/else statements and loops in functions

The return() function is particularly useful if you have any IF statements in the function, when you want your output to be dependent on some condition:


In [29]:
def type_of_album(artist,album,year_released):
    if year_released > 1980:
        print(artist,album,year_released)
        return "Modern"
    else:
        print(artist,album,year_released)
        return "Oldie"
    
x = type_of_album("Michael Jackson","Thriller",1980)
print(x)


Michael Jackson Thriller 1980
Oldie

We can use a loop in a function. For example, we can print out each element in a list:


In [30]:
def PrintList(the_list):
    for element in the_list:
        print(element)

In [31]:
PrintList(['1',1,'the man',"abc"])


1
1
the man
abc

Setting default argument values in your custom functions

You can set a default value for arguments in your function. For example, in the isGoodRating() function, what if we wanted to create a threshold for what we consider to be a good rating? Perhaps by default, we should have a default rating of 4:


In [32]:
def isGoodRating(rating=4): 
    if(rating < 7):
        print("this album sucks it's rating is",rating)
        
    else:
        print("this album is good its rating is",rating)


In [33]:
isGoodRating()
isGoodRating(10)


this album sucks it's rating is 4
this album is good its rating is 10

Global variables


So far, we've been creating variables within functions, but we have not discussed variables outside the function. These are called global variables.
Let's try to see what printer1 returns:


In [34]:
artist = "Michael Jackson"
def printer1(artist):
    internal_var = artist
    print(artist,"is an artist")
    
printer1(artist)


Michael Jackson is an artist

If we print internal_var we get an error.

We got a Name Error: name 'internal_var' is not defined. Why?

It's because all the variables we create in the function is a local variable, meaning that the variable assignment does not persist outside the function.

But there is a way to create global variables from within a function as follows:


In [35]:
artist = "Michael Jackson"

def printer(artist):
    global internal_var 
    internal_var= "Whitney Houston"
    print(artist,"is an artist")

printer(artist) 
printer(internal_var)


Michael Jackson is an artist
Whitney Houston is an artist

Scope of a Variable


The scope of a variable is the part of that program where that variable is accessible. Variables that are declared outside of all function definitions, such as the myFavouriteBand variable in the code shown here, are accessible from anywhere within the program. As a result, such variables are said to have global scope, and are known as global variables. myFavouriteBand is a global variable, so it is accessible from within the getBandRating function, and we can use it to determine a band's rating. We can also use it outside of the function, such as when we pass it to the print function to display it:


In [36]:
myFavouriteBand = "AC/DC"

def getBandRating(bandname):
    if bandname == myFavouriteBand:
        return 10.0
    else:
        return 0.0

print("AC/DC's rating is:", getBandRating("AC/DC"))
print("Deep Purple's rating is:",getBandRating("Deep Purple"))
print("My favourite band is:", myFavouriteBand)


AC/DC's rating is: 10.0
Deep Purple's rating is: 0.0
My favourite band is: AC/DC

Take a look at this modified version of our code. Now the myFavouriteBand variable is defined within the getBandRating function. A variable that is defined within a function is said to be a local variable of that function. That means that it is only accessible from within the function in which it is defined. Our getBandRating function will still work, because myFavouriteBand is still defined within the function. However, we can no longer print myFavouriteBand outside our function, because it is a local variable of our getBandRating function; it is only defined within the getBandRating function:


In [37]:
def getBandRating(bandname):
    myFavouriteBand = "AC/DC"
    if bandname == myFavouriteBand:
        return 10.0
    else:
        return 0.0

print("AC/DC's rating is: ", getBandRating("AC/DC"))
print("Deep Purple's rating is: ", getBandRating("Deep Purple"))
print("My favourite band is", myFavouriteBand)


AC/DC's rating is:  10.0
Deep Purple's rating is:  0.0
My favourite band is AC/DC

Finally, take a look at this example. We now have two myFavouriteBand variable definitions. The first one of these has a global scope, and the second of them is a local variable within the getBandRating function. Within the getBandRating function, the local variable takes precedence. Deep Purple will receive a rating of 10.0 when passed to the getBandRating function. However, outside of the getBandRating function, the getBandRating s local variable is not defined, so the myFavouriteBand variable we print is the global variable, which has a value of AC/DC:


In [38]:
myFavouriteBand = "AC/DC"

def getBandRating(bandname):
    myFavouriteBand = "Deep Purple"
    if bandname == myFavouriteBand:
        return 10.0
    else:
        return 0.0

print("AC/DC's rating is:",getBandRating("AC/DC"))
print("Deep Purple's rating is: ",getBandRating("Deep Purple"))
print("My favourite band is:",myFavouriteBand)


AC/DC's rating is: 0.0
Deep Purple's rating is:  10.0
My favourite band is: AC/DC

About the Authors:

Joseph Santarcangelo has a PhD in Electrical Engineering, his research focused on using machine learning, signal processing, and computer vision to determine how videos impact human cognition. Joseph has been working for IBM since he completed his PhD.

James Reeve James Reeves is a Software Engineering intern at IBM.


Copyright © 2017 cognitiveclass.ai. This notebook and its source code are released under the terms of the MIT License.