Asserting exceptions (pytest.raises)

Introduction

We use pytest.raises to check if a piece of code correctly causes an error. This helps us make sure our program handles bad situations safely.

When you want to confirm that a function stops and shows an error for wrong input.

When testing that your code raises the right error type in a problem case.

When you want to catch and check error messages during testing.

When you want to avoid your program crashing silently and instead handle errors properly.

Syntax

PyTest

with pytest.raises(ExpectedException):
    code_that_should_raise()

Use with to start a block where you expect an error.

Replace ExpectedException with the specific error type you expect, like ValueError.

Examples

This checks that dividing by zero raises a ZeroDivisionError.

PyTest

with pytest.raises(ZeroDivisionError):
    x = 1 / 0

This confirms that converting a bad string to int raises a ValueError.

PyTest

with pytest.raises(ValueError):
    int('abc')

This captures the KeyError so you can check its message if needed.

PyTest

with pytest.raises(KeyError) as exc_info:
    d = {}
    d['missing']

Sample Program

This test script has two tests. One checks that dividing by zero raises the right error with the correct message. The other checks normal division works fine.

PyTest

import pytest

def divide(a, b):
    if b == 0:
        raise ZeroDivisionError('Cannot divide by zero')
    return a / b

def test_divide_by_zero():
    with pytest.raises(ZeroDivisionError) as exc_info:
        divide(10, 0)
    assert str(exc_info.value) == 'Cannot divide by zero'

def test_divide_normal():
    assert divide(10, 2) == 5

Important Notes

Always specify the exact exception type to avoid catching unexpected errors.

You can capture the exception info with as exc_info to check error messages.

Use pytest.raises inside test functions only.

Summary

pytest.raises helps check if code raises expected errors.

Use it with a with block around code that should fail.

You can also check the error message by capturing the exception info.

Practice

1. What is the main purpose of using pytest.raises in a test?

easy

A. To ignore exceptions and continue the test

B. To skip a test when an exception occurs

C. To print the exception message during test execution

D. To check if a specific exception is raised by the code inside the with block

Solution

1. Step 1: Understand the role of pytest.raises

   pytest.raises is used to verify that a certain exception is raised by the code inside its with block.

2. Step 2: Compare options with the purpose

   Only To check if a specific exception is raised by the code inside the with block correctly states that it checks for a specific exception. Other options describe unrelated behaviors.

3. Final Answer:

   To check if a specific exception is raised by the code inside the with block -> Option D

4. Quick Check:

   pytest.raises checks exceptions = A [OK]

Hint: Remember: pytest.raises confirms expected errors happen [OK]

Common Mistakes:

• Thinking pytest.raises skips tests
• Assuming it prints exceptions automatically
• Believing it ignores exceptions

2. Which of the following is the correct syntax to assert that a ValueError is raised when calling func() using pytest.raises?

easy

A. pytest.raises(ValueError, func())

B. with pytest.raises(ValueError): func()

C. with pytest.raises('ValueError'): func()

D. pytest.raises(ValueError): func()

Solution

1. Step 1: Recall correct pytest.raises syntax

   The correct way is to use a with statement with pytest.raises(ExceptionType): followed by the code that should raise the exception.

2. Step 2: Evaluate each option

   with pytest.raises(ValueError): func() uses the correct with block and exception type. pytest.raises(ValueError, func()) calls the function inside the argument, which runs before checking. with pytest.raises('ValueError'): func() uses a string instead of the exception class. pytest.raises(ValueError): func() misses the with keyword.

3. Final Answer:

   with pytest.raises(ValueError): func() -> Option B

4. Quick Check:

   Use with + pytest.raises(Exception): code [OK]

Hint: Always use 'with pytest.raises(Exception):' before the code [OK]

Common Mistakes:

• Calling the function inside pytest.raises() arguments
• Using exception name as string instead of class
• Omitting the 'with' keyword

3. What will be the output of the following test code?

import pytest

def test_zero_division():
    with pytest.raises(ZeroDivisionError) as exc_info:
        1 / 0
    assert 'division by zero' in str(exc_info.value)

medium

A. Test passes because ZeroDivisionError is raised and message matches

B. Test fails because exception message is not checked correctly

C. Test fails because ZeroDivisionError is not raised

D. SyntaxError due to incorrect use of pytest.raises

Solution

1. Step 1: Analyze the code behavior

   The code inside the with pytest.raises(ZeroDivisionError) as exc_info: block raises a ZeroDivisionError by dividing 1 by 0.

2. Step 2: Check the assertion

   The assertion verifies that the exception message contains 'division by zero', which is true for this error.

3. Final Answer:

   Test passes because ZeroDivisionError is raised and message matches -> Option A

4. Quick Check:

   Exception raised and message checked = D [OK]

Hint: Use exc_info.value to check exception message text [OK]

Common Mistakes:

• Not using 'as exc_info' to capture exception details
• Checking wrong exception message text
• Expecting no exception raised

4. Identify the error in this test code snippet:

def test_key_error():
    with pytest.raises(KeyError):
        d = {'a': 1}
        value = d['b']
    assert value == 1

medium

A. The variable 'value' is used outside the with block where it may not be assigned

B. The exception type should be ValueError, not KeyError

C. The dictionary key 'b' exists, so no exception is raised

D. pytest.raises cannot be used with dictionary lookups

Solution

1. Step 1: Understand variable scope and exception flow

   The line value = d['b'] raises a KeyError, so value is never assigned inside the with block.

2. Step 2: Identify the error in assertion

   After the with block, the code tries to assert value == 1, but value is undefined because the assignment never happened due to the exception.

3. Final Answer:

   The variable 'value' is used outside the with block where it may not be assigned -> Option A

4. Quick Check:

   Exception stops assignment, so variable undefined after [OK]

Hint: Don't use variables assigned inside exception blocks outside [OK]

Common Mistakes:

• Assuming variable is assigned despite exception
• Confusing exception types
• Thinking pytest.raises can't handle dict key errors

5. You want to test a function parse_int(s) that should raise ValueError with message containing 'invalid literal' when given a non-integer string. Which pytest code correctly asserts this behavior and checks the error message?

hard

A. with pytest.raises(ValueError):
parse_int('abc')
assert 'invalid literal' in e.value

B. pytest.raises(ValueError, parse_int('abc'))
assert 'invalid literal' in e.value

C. with pytest.raises(ValueError) as e:
parse_int('abc')
assert 'invalid literal' in str(e.value)

D. with pytest.raises('ValueError') as e:
parse_int('abc')
assert 'invalid literal' in str(e.value)

Solution

1. Step 1: Use correct syntax to capture exception info

   Use with pytest.raises(ValueError) as e: to catch the exception and store info in e.

2. Step 2: Check error message properly

   After the block, check if the string 'invalid literal' is in str(e.value). This converts the exception to string for message checking.

3. Step 3: Eliminate incorrect options

   with pytest.raises(ValueError): parse_int('abc') assert 'invalid literal' in e.value tries to use e outside the block without capturing it. pytest.raises(ValueError, parse_int('abc')) assert 'invalid literal' in e.value calls the function inside pytest.raises incorrectly and uses e undefined. with pytest.raises('ValueError') as e: parse_int('abc') assert 'invalid literal' in str(e.value) uses exception name as string instead of class.

4. Final Answer:

   with pytest.raises(ValueError) as e: parse_int('abc') assert 'invalid literal' in str(e.value) -> Option C

5. Quick Check:

   Capture exception with 'as' and check message string [OK]

Hint: Use 'as' to capture exception and check message with str(e.value) [OK]

Common Mistakes:

• Using exception name as string instead of class
• Calling function inside pytest.raises arguments
• Accessing exception info outside 'with' without 'as'