Correct usage of assertRaises in Python unit tests

Question

I'm trying to figure out how to correctly use assertRaises() of the Python unittest module. I have a ValueError in my function that gets raised. However, when testing in my unit tests, I'm getting mixed results with two different ways of using assertRaises().

When I write the test like this, it works:

import unittest

class MyTest(unittest.TestCase):

    @classmethod
    def setUpClass(cls):
        pass

    def test_error(self):
        with self.assertRaises(ValueError):
            func(a)

However, if I write my test like below, it does not work even though the ValueError gets raised:

    def test_error(self):
        self.assertRaises(ValueError, func(a))

Why would one way work and not the other?

MrBean Bremen · Accepted Answer · 2025-02-25 19:42:00Z

5

The assertRaises method takes a variable argument list, where the first argument is the function object, and the optional other arguments are the function arguments. You have to call it either this way (the usual way):

def test_error(self):
    self.assertRaises(ValueError, func, a)

Or using a lambda:

def test_error(self):
    self.assertRaises(ValueError, lambda: func(a))

The problem with your call is that it would execute your function before calling assertRaises, as the result of the function call instead of the function itself is passed as an argument - so the exception would occur before assertRaises could handle it.

Having said that, I would always prefer the context manager variant, as it is better readable.

edited Feb 25 at 19:42

answered Apr 14, 2020 at 14:35

MrBean Bremen

17.1k3 gold badges35 silver badges58 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Correct usage of assertRaises in Python unit tests

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related