Skip to content

Contact sales

By filling out this form and clicking submit, you acknowledge our privacy policy.
  • Labs icon Lab
  • A Cloud Guru
Google Cloud Platform icon

Adding Exception Handling to a Python Script

Our code won't always be able to run without issue. So many things can go wrong when running code — network connectivity can fail, file system permissions can be wrong, bad inputs can be passed to our scripts. Thankfully, we can normally tell when these types of issues *might* happen in our code and we can handle them. In this hands-on lab, we'll add exception handling to an existing script that can run into many of these issues. To feel comfortable completing this lab, you'll want to know how to perform exception handling in Python (watch the "Handling Exceptions with `try`, `except`, `else`, and `finally`" video from the Certified Associate in Python Programming Certification course).

Google Cloud Platform icon

Path Info

Clock icon Beginner
Clock icon 45m
Clock icon Mar 20, 2020

Contact sales

By filling out this form and clicking submit, you acknowledge our privacy policy.

Table of Contents

  1. Challenge

    Add Exception Handling Around Setting the `name` Variable

    The first expression in the script reads from sys.argv, which is a list. If the script is run without any additional positional arguments, there won't be an item at the index of 1 and we'll receive an IndexError. Let's add exception handling around this line to catch the error, print an error message about the number of required arguments, and then use sys.exit(1) to stop the script and exit with a non-zero status code.


    import sys
    # 1) Fetch name from the first argument passed to the script.
    # If there is no argument, then exist with a readable error message.
    # The potential error here is an IndexError.
        name = sys.argv[1]
    except IndexError:
        print("Error: please provide a name and a repeat count to the script.")
    # Remainder of file omitted

    Now if we run the script without any arguments, we should see this error message:

    $ python3.7
    Error: please provide a name and a repeat count to the script.
    $ python3.7 Kevin
    Traceback (most recent call last):
      File "", line 16, in <module>
        repeat_count = int(sys.argv[2])
    IndexError: list index out of range

    This next error is related to the next bit of logic in the script.

  2. Challenge

    Handle Potential `ValueError` and `IndexError` When Setting `repeat_count` Variable

    When we set the repeat_count variable, we index sys.argv at the index of 2 so we can once again run into an IndexError. In that case, we'll want to provide the same error message we did for the name variable. Additionally, we can also run into a ValueError if the value provided cannot be cast to an integer, so we'll need to have a second except statement that handles that and provides a more useful error message.


    # previous code omitted
    # 2) Convert the second argument to be an integer so that we can repeatedly print out
    # the name argument. We should either a ValueError or an IndexError if there weren't enough
    # arguments provided.
        repeat_count = int(sys.argv[2])
    except IndexError:
        print("Error: please provide a name and a repeat count to the script.")
    except ValueError:
        print("Error: the repeat count needs to be a number.")
    # remaining code omitted
  3. Challenge

    Handle Potential File IO Errors When Writing to `name_repeated.txt`

    The last section of this script deals with interacting with a file, so there are numerous potential errors we could run into. Depending on the version of Python we use to run the script, we could get either an OSError or a PermissionError if we don't have permissions to interact with a file. To make this script backward-compatible, we'll catch OSError since PermissionError inherits from OSError and would also be caught. Additionally, we're going to catch IOError since this is another common error that happens when interacting with files. These error types will both be caught by the same except statement. Our requirements state that we need to print to the screen if we can't write to a file, and we're going to keep our try block small by writing to the file in the else branch if we can read from it.


    # previous code omitted
    # 3) Open a file called `name_repeated.txt` in the `root_files` directory and write a line for each time the name was
    # repeated. If the user running the script doesn't have write permissions for the directory that
    # we're writing to then we might see a PermissionError. PermissionError is new as of 3.3, so let's instead catch
    # OSError and IOError to make the script more backward compatible. If an error is caught print to the screen instead.
        f = open("root_files/name_repeated.txt", "w")
    except (OSError, IOError) as err:
        print("Error: unable to write file (", err, ")")
        for i in range(1, repeat_count + 1):
            print(i, "-", name)
        names = [name + "\n" for i in range(1, repeat_count + 1)]

    Now we've successfully handled all the common errors we might run into when running this script.

The Cloud Content team comprises subject matter experts hyper focused on services offered by the leading cloud vendors (AWS, GCP, and Azure), as well as cloud-related technologies such as Linux and DevOps. The team is thrilled to share their knowledge to help you build modern tech solutions from the ground up, secure and optimize your environments, and so much more!

What's a lab?

Hands-on Labs are real environments created by industry experts to help you learn. These environments help you gain knowledge and experience, practice without compromising your system, test without risk, destroy without fear, and let you learn from your mistakes. Hands-on Labs: practice your skills before delivering in the real world.

Provided environment for hands-on practice

We will provide the credentials and environment necessary for you to practice right within your browser.

Guided walkthrough

Follow along with the author’s guided walkthrough and build something new in your provided environment!

Did you know?

On average, you retain 75% more of your learning if you get time for practice.

Start learning by doing today

View Plans