How to Debug Pytest With pdb Breakpoints?

Better Stack Team
Updated on May 15, 2024

To debug a pytest test using pdb, you can manually insert a breakpoint by adding import pdb; pdb.set_trace() in your test:
import pytest

def divide(x, y):
    return x / y

def test_zero_division():
    import pdb
    with pytest.raises(ZeroDivisionError):
        divide(9, 0)

When running your tests, include the --pdb flag with the pytest command to enable interactive debugging:

pytest --pdb

This will initiate the pdb prompt at the point where the breakpoint is set:


>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>> PDB set_trace (IO-capturing turned off) >>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
> /Users/stanley/
-> with pytest.raises(ZeroDivisionError):

Another way to set breakpoints is using the built-in breakpoint() function, which simplifies the process of setting breakpoints:
def test_zero_division():
    with pytest.raises(ZeroDivisionError):
        divide(9, 0)

This method is often preferred for its simplicity compared to import pdb; pdb.set_trace().

Make your mark

Join the writer's program

Are you a developer and love writing and sharing your knowledge with the world? Join our guest writing program and get paid for writing amazing technical guides. We'll get them to the right readers that will appreciate them.

Write for us
Writer of the month
Marin Bezhanov
Marin is a software engineer and architect with a broad range of experience working...
Build on top of Better Stack

Write a script, app or project on top of Better Stack and share it with the world. Make a public repository and share it with us at our email.

or submit a pull request and help us build better products for everyone.

See the full list of amazing projects on github