pytest assert message customization with variable introspection

Question

In the pytest documentation it says that you can customize the output message when an assert fails. I want to customize the assert message when testing a REST API method it returns an invalid status code:

def test_api_call(self, client):
    response = client.get(reverse('api:my_api_call'))
    assert response.status_code == 200

So I tried to put a piece of code like this in conftest.py

def pytest_assertrepr_compare(op, left, right):
    if isinstance(left, rest_framework.response.Response):
        return left.json()

But the problem is left is the actual value of response.status_code so it's an int instead of a Response. However the default output messages throws something like:

E assert 400 == 201 E + where 400 = .status_code

Saying that the error 400 comes from an attribute status_code of a object Response.

My point is that there is a kind of introspection of the variable being evaluated. So, how can I customize the assert error message in a comfortable way to get a similar output to example posted above?

Dmitry Tokarev · Accepted Answer · 2020-08-06 21:54:08Z

56

you could use Python built-in capability to show custom exception message:

assert response.status_code == 200, f"My custom msg: actual status code {response.status_code}"

Or you can built a helper assert functions:

def assert_status(response, status=200):  # you can assert other status codes too
    assert response.status_code == status, \
        f"Expected {status}. Actual status {response.status_code}. Response text {response.text}"

# here is how you'd use it
def test_api_call(self, client):
    response = client.get(reverse('api:my_api_call'))
    assert_status(response)

also checkout: https://wiki.python.org/moin/UsingAssertionsEffectively

edited Aug 6, 2020 at 21:54

answered Jun 14, 2017 at 4:47

Dmitry Tokarev

2,09917 silver badges33 bronze badges

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

3 Comments

Marc Tudurí Over a year ago

Thanks Dmitry. I know the both solutions that you propose and sure that both will work. However I was looking for a fancy solution where you can still use assert and you won't need to write more code.

Dmitry Tokarev Over a year ago

ahh, sorry, didn't get your question intent

tahoe Over a year ago

The first example in the above response is exactly what I was looking for!

Muhammad Yasirroni · Accepted Answer · 2024-06-24 07:38:25Z

1

Improving @Dmitry answer, you also can return tuple of variables using something like this:

assert response.status_code == 200, (response.status_code, response.json())

answered Jun 24, 2024 at 7:38

Muhammad Yasirroni

2,28620 silver badges24 bronze badges

Collectives™ on Stack Overflow

pytest assert message customization with variable introspection

2 Answers 2

3 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related