DEV Community

≀Paulo Portela
≀Paulo Portela

Posted on • Updated on

Python: A Guide to Functions

Introduction

In this chapter, we'll explore the use of functions in Python. We'll start by showing how to create a simple function without any arguments or return value. For example, let's create a function that prints a welcome message:

def welcome():
    print("Welcome to the universe of Python!")
Enter fullscreen mode Exit fullscreen mode

We can call this function by using its name followed by parentheses:

welcome()
Enter fullscreen mode Exit fullscreen mode
Output:
Welcome to the universe of Python!
Enter fullscreen mode Exit fullscreen mode

Creating a Function with Arguments and Return Value

Next, let's create a function that takes one argument and returns a value. For example, let's create a function that calculates the square of a number:

def square(x: int) -> int:
    return x**2
Enter fullscreen mode Exit fullscreen mode

In this example, the function square takes one argument x of type int and returns a type int value. We can call this function by passing an argument inside the parentheses:

result = square(x=5)
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
25
Enter fullscreen mode Exit fullscreen mode

Using Multiple Arguments

We can also create a function that takes multiple arguments. For example, let's create a function that calculates the average of three numbers:

def average(x: float, y: float, z: float) -> float:
    return (x + y + z) / 3
Enter fullscreen mode Exit fullscreen mode

In this example, the function average takes three arguments representing three numbers, and returns their average. We can call this function by passing three arguments inside the parentheses:

result = average(x=3, y=4, z=5)
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
4.0
Enter fullscreen mode Exit fullscreen mode

*args is used to pass a variable number of arguments to a function. The arguments are passed in as a tuple. Here's an example of a function that takes any number of arguments and returns their sum:

def sum_all(*args) -> float:
    result = 0
    for arg in args:
        result += arg
    return result
Enter fullscreen mode Exit fullscreen mode

In this example, the function sum_all takes any number of arguments and returns their sum. We can call this function by passing any number of arguments inside the parentheses:

result = sum_all(1, 2, 3, 4, 5)
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
15
Enter fullscreen mode Exit fullscreen mode

This is just one example of how *args can be used in a function. You can use it in many different ways depending on your needs.

Using Default Values for Function Arguments

We can also specify default values for function arguments. For example, let's create a function that calculates the volume of a cylinder, with a default value for the height:

import math

def cylinder_volume(radius: float, height: float = 1) -> float:
    return math.pi * radius ** 2 * height
Enter fullscreen mode Exit fullscreen mode

In this example, the function cylinder_volume takes two arguments, radius and height, with a default value of 1 for the height argument. If we call this function with only one argument, the default value for height will be used:

result = cylinder_volume(radius=2)
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
12.566370614359172
Enter fullscreen mode Exit fullscreen mode

Documenting Functions with Docstrings

We can also include a docstring in our function to describe its purpose and usage. For example, let's add a docstring to our cylinder_volume function:

import math

def cylinder_volume(radius: float, height: float = 1) -> float:
    """Calculate the volume of a cylinder with a given radius and height.

    Args:
        radius (float): The radius of the cylinder.
        height (float): The height of the cylinder (default is 1).

    Returns:
        float: The volume of the cylinder.
    """
    return math.pi * radius ** 2 * height
Enter fullscreen mode Exit fullscreen mode

In this example, the docstring provides a brief description of the function, as well as information about its arguments and return value. Docstrings are a useful way to document our code and make it easier for others to understand and use.

Using Nested Functions

We can also define a function inside another function. For example, let's create a function that calculates the factorial of a number, using a nested function to calculate the product of a list of numbers:

def factorial(n: int) -> int:
    def product(numbers: list) -> int:
        result = 1
        for number in numbers:
            result *= number
        return result

    return product(range(1, n + 1))
Enter fullscreen mode Exit fullscreen mode

In this example, the function factorial takes one argument n representing a number, and uses a nested function product to calculate the product of the numbers from 1 to n. We can call this function by passing one argument inside the parentheses:

result = factorial(n=5)
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
120
Enter fullscreen mode Exit fullscreen mode

Using the Map Function

The map function is a built-in Python function that applies a function to each element of an iterable and returns a new iterable with the results. Here's an example of using the map function to square each element of a list of numbers:

numbers = [1, 2, 3, 4, 5]
squared_numbers = map(lambda x: x**2, numbers)
print(list(squared_numbers))
Enter fullscreen mode Exit fullscreen mode
Output:
[1, 4, 9, 16, 25]
Enter fullscreen mode Exit fullscreen mode

In this example, we use the map function to apply the lambda function lambda x: x**2 to each element of the numbers list. The result is a new iterable containing the squared values of the original list.

Using Recursive Functions

A recursive function is a function that calls itself in its definition. Recursive functions can be used to solve problems that can be broken down into smaller, self-similar subproblems. Here's an example of a recursive function that calculates the factorial of a number:

def factorial(n: int) -> int:
    if n == 0:
        return 1
    else:
        return n * factorial(n-1)

result = factorial(n=5)
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
120
Enter fullscreen mode Exit fullscreen mode

In this example, the function factorial takes one argument n representing a number, and uses a recursive call to calculate the factorial of n. The base case of the recursion is when n is 0, in which case the function returns 1. Otherwise, the function returns n multiplied by the factorial of n-1, calculated using a recursive call to the factorial function.

A palindrome is a word, phrase, number, or another sequence of characters that reads the same forward and backwards, ignoring spaces, punctuation, and capitalization. Here's an example of a function that checks if a given string is a palindrome:

def is_palindrome(s: str) -> bool:
    s = "".join(filter(str.isalnum, s)).lower()
    return s == s[::-1]

result = is_palindrome(s="A man, a plan, a canal, Panama!")
print(result)
Enter fullscreen mode Exit fullscreen mode
Output:
True
Enter fullscreen mode Exit fullscreen mode

In this example, the function is_palindrome takes one argument s representing a string, and returns a boolean value indicating whether the string is a palindrome or not. The function first removes all non-alphanumeric characters from the string and converts it to lowercase. Then, it checks if the resulting string is equal to its reverse.

Conclusion

Functions are a fundamental building block of any Python program. They allow us to encapsulate and reuse code, making our programs more modular, readable, and maintainable. With their ability to take arguments, return values, and be nested inside other functions, Python functions offer a powerful and flexible way to organize and structure our code. Additionally, the use of the map function and recursive functions provides even more tools for solving complex problems elegantly and efficiently.

Top comments (0)